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
20 import java.util.EventListener;
21
22 /**
23 * There exists a large class of IETF protocols that work by sending an ASCII text command and arguments to a server, and then receiving an ASCII text reply.
24 * For debugging and other purposes, it is extremely useful to log or keep track of the contents of the protocol messages. The ProtocolCommandListener interface
25 * coupled with the {@link ProtocolCommandEvent} class facilitate this process.
26 * <p>
27 * To receive ProtocolCommandEvents, you merely implement the ProtocolCommandListener interface and register the class as a listener with a ProtocolCommandEvent
28 * source such as {@link org.apache.commons.net.ftp.FTPClient}.
29 *
30 *
31 * @see ProtocolCommandEvent
32 * @see ProtocolCommandSupport
33 */
34
35 public interface ProtocolCommandListener extends EventListener {
36
37 /**
38 * This method is invoked by a ProtocolCommandEvent source after sending a protocol command to a server.
39 *
40 * @param event The ProtocolCommandEvent fired.
41 */
42 void protocolCommandSent(ProtocolCommandEvent event);
43
44 /**
45 * This method is invoked by a ProtocolCommandEvent source after receiving a reply from a server.
46 *
47 * @param event The ProtocolCommandEvent fired.
48 */
49 void protocolReplyReceived(ProtocolCommandEvent event);
50
51 }