1. /*

  2.  * Copyright 2001-2004 The Apache Software Foundation

  3.  *

  4.  * Licensed under the Apache License, Version 2.0 (the "License");

  5.  * you may not use this file except in compliance with the License.

  6.  * You may obtain a copy of the License at

  7.  *

  8.  *     http://www.apache.org/licenses/LICENSE-2.0

  9.  *

  10.  * Unless required by applicable law or agreed to in writing, software

  11.  * distributed under the License is distributed on an "AS IS" BASIS,

  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  13.  * See the License for the specific language governing permissions and

  14.  * limitations under the License.

  15.  */

  16. package org.apache.commons.net;

  17. import java.util.EventListener;

  18. 

  19. /***

  20.  * There exists a large class of IETF protocols that work by sending an

  21.  * ASCII text command and arguments to a server, and then receiving an

  22.  * ASCII text reply.  For debugging and other purposes, it is extremely

  23.  * useful to log or keep track of the contents of the protocol messages.

  24.  * The ProtocolCommandListener interface coupled with the

  25.  * <a href="org.apache.commons.net.ProtocolCommandEvent.html"> ProtocolCommandEvent

  26.  * </a> class facilitate this process.

  27.  * <p>

  28.  * To receive ProtocolCommandEvents, you merely implement the

  29.  * ProtocolCommandListener interface and register the class as a listener

  30.  * with a ProtocolCommandEvent source such as

  31.  * <a href="org.apache.commons.net.ftp.FTPClient.html"> FTPClient </a>.

  32.  * <p>

  33.  * <p>

  34.  * @see ProtocolCommandEvent

  35.  * @see ProtocolCommandSupport

  36.  * @author Daniel F. Savarese

  37.  ***/

  38. 

  39. public interface ProtocolCommandListener extends EventListener

  40. {

  41. 

  42.     /***

  43.      * This method is invoked by a ProtocolCommandEvent source after

  44.      * sending a protocol command to a server.

  45.      * <p>

  46.      * @param event The ProtocolCommandEvent fired.

  47.      ***/

  48.     public void protocolCommandSent(ProtocolCommandEvent event);

  49. 

  50.     /***

  51.      * This method is invoked by a ProtocolCommandEvent source after

  52.      * receiving a reply from a server.

  53.      * <p>

  54.      * @param event The ProtocolCommandEvent fired.

  55.      ***/

  56.     public void protocolReplyReceived(ProtocolCommandEvent event);

  57. 

  58. }