1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 18 package org.apache.commons.net; 19 import java.util.EventListener; 20 21 /*** 22 * There exists a large class of IETF protocols that work by sending an 23 * ASCII text command and arguments to a server, and then receiving an 24 * ASCII text reply. For debugging and other purposes, it is extremely 25 * useful to log or keep track of the contents of the protocol messages. 26 * The ProtocolCommandListener interface coupled with the 27 * {@link ProtocolCommandEvent} class facilitate this process. 28 * <p> 29 * To receive ProtocolCommandEvents, you merely implement the 30 * ProtocolCommandListener interface and register the class as a listener 31 * with a ProtocolCommandEvent source such as 32 * {@link org.apache.commons.net.ftp.FTPClient}. 33 * <p> 34 * <p> 35 * @see ProtocolCommandEvent 36 * @see ProtocolCommandSupport 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 }