/*
 * @(#)FxpListener.java
 *
 * Copyright (c) 2005 JScape
 * 1147 S. 53rd Pl., Mesa, Arizona, 85206, U.S.A.
 * All rights reserved.
 *
 * This software is the confidential and proprietary information of
 * JScape. ("Confidential Information").  You shall not disclose such
 * Confidential Information and shall use it only in accordance with
 * the terms of the license agreement you entered into with JScape.
 */
package com.jscape.inet.ftp;

import java.util.EventListener;

/**
 * Implements methods for capturing events sourced from Fxp and Fxps classes.
 * <p/>
 * Typicaly your application will implement this interface to capture the
 * following events :
 * <br>
 * <code>FxpStartEvent</code><br>
 * <code>FxpEndEvent</code><br>
 * <code>FxpFailedEvent</code>
 * <p/>
 * <p/>
 * In addition to implementing this interface your application should register
 * itself as an EventListener which may look somewhat like this:<br>
 * <pre>
 * public class Application ... implements FxpListener
 * {
 *  ...
 *  public ... initMethod(...)
 *  {
 *    Fxp fxp = new Fxp();
 *    fxp.addFxpListener(this);
 *  }
 *  ...
 * }
 * </pre>
 */
public interface FxpListener
        extends EventListener {

    /**
     * Invoked when FXP transfer starts for a file.
     *
     * @param ev a <code>FxpStartEvent</code>
     *
     * @see FxpStartEvent
     */
    void fxpStart(FxpStartEvent ev);


    /**
     * Invoked when FXP transfer ends for a file.
     *
     * @param ev a <code>FxpEndEvent</code>
     *
     * @see FxpEndEvent
     */
    void fxpEnd(FxpEndEvent ev);


    /**
     * Invoked when FXP transfer fails for a file.
     *
     * @param ev a <code>FxpFailedEvent</code>
     *
     * @see FxpFailedEvent
     */
    void fxpFailed(FxpFailedEvent ev);
}
