    View Javadoc
    1   package org.apache.commons.net;
    2
    3   /* ====================================================================
    4    * The Apache Software License, Version 1.1
    5    *
    6    * Copyright (c) 2001 The Apache Software Foundation.  All rights
    7    * reserved.
    8    *
    9    * Redistribution and use in source and binary forms, with or without
    10   * modification, are permitted provided that the following conditions
    11   * are met:
    12   *
    13   * 1. Redistributions of source code must retain the above copyright
    14   *    notice, this list of conditions and the following disclaimer.
    15   *
    16   * 2. Redistributions in binary form must reproduce the above copyright
    17   *    notice, this list of conditions and the following disclaimer in
    18   *    the documentation and/or other materials provided with the
    19   *    distribution.
    20   *
    21   * 3. The end-user documentation included with the redistribution,
    22   *    if any, must include the following acknowledgment:
    23   *       "This product includes software developed by the
    24   *        Apache Software Foundation (http://www.apache.org/)."
    25   *    Alternately, this acknowledgment may appear in the software itself,
    26   *    if and wherever such third-party acknowledgments normally appear.
    27   *
    28   * 4. The names "Apache" and "Apache Software Foundation" and
    29   *    "Apache Commons" must not be used to endorse or promote products
    30   *    derived from this software without prior written permission. For
    31   *    written permission, please contact apache@apache.org.
    32   *
    33   * 5. Products derived from this software may not be called "Apache",
    34   *    nor may "Apache" appear in their name, without
    35   *    prior written permission of the Apache Software Foundation.
    36   *
    37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    40   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    48   * SUCH DAMAGE.
    49   * ====================================================================
    50   *
    51   * This software consists of voluntary contributions made by many
    52   * individuals on behalf of the Apache Software Foundation.  For more
    53   * information on the Apache Software Foundation, please see
    54   * <http://www.apache.org/>;.
    55   */
    56
    57  import java.util.EventListener;
    58
    59  /****
    60   * There exists a large class of IETF protocols that work by sending an
    61   * ASCII text command and arguments to a server, and then receiving an
    62   * ASCII text reply.  For debugging and other purposes, it is extremely
    63   * useful to log or keep track of the contents of the protocol messages.
    64   * The ProtocolCommandListener interface coupled with the
    65   * <a href="org.apache.commons.net.ProtocolCommandEvent.html"> ProtocolCommandEvent
    66   * </a> class facilitate this process.
    67   * <p>
    68   * To receive ProtocolCommandEvents, you merely implement the
    69   * ProtocolCommandListener interface and register the class as a listener
    70   * with a ProtocolCommandEvent source such as
    71   * <a href="org.apache.commons.net.ftp.FTPClient.html"> FTPClient </a>.
    72   * <p>
    73   * <p>
    74   * @see ProtocolCommandEvent
    75   * @see ProtocolCommandSupport
    76   * @author Daniel F. Savarese
    77   ***/
    78
    79  public interface ProtocolCommandListener extends EventListener
    80  {
    81
    82      /****
    83       * This method is invoked by a ProtocolCommandEvent source after
    84       * sending a protocol command to a server.
    85       * <p>
    86       * @param event The ProtocolCommandEvent fired.
    87       ***/
    88      public void protocolCommandSent(ProtocolCommandEvent event);
    89
    90      /****
    91       * This method is invoked by a ProtocolCommandEvent source after
    92       * receiving a reply from a server.
    93       * <p>
    94       * @param event The ProtocolCommandEvent fired.
    95       ***/
    96      public void protocolReplyReceived(ProtocolCommandEvent event);
    97
    98  }

This page was automatically generated by Maven