Package org.apache.commons.net
Class ProtocolCommandSupport
- java.lang.Object
-
- org.apache.commons.net.ProtocolCommandSupport
-
- All Implemented Interfaces:
java.io.Serializable
public class ProtocolCommandSupport extends java.lang.Object implements java.io.Serializable
ProtocolCommandSupport is a convenience class for managing a list of ProtocolCommandListeners and firing ProtocolCommandEvents. You can simply delegate ProtocolCommandEvent firing and listener registering/unregistering tasks to this class.
-
-
Field Summary
Fields Modifier and Type Field Description private ListenerList
listeners
private static long
serialVersionUID
private java.lang.Object
source
-
Constructor Summary
Constructors Constructor Description ProtocolCommandSupport(java.lang.Object source)
Creates a ProtocolCommandSupport instance using the indicated source as the source of ProtocolCommandEvents.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addProtocolCommandListener(ProtocolCommandListener listener)
Adds a ProtocolCommandListener.void
fireCommandSent(java.lang.String command, java.lang.String message)
Fires a ProtocolCommandEvent signalling the sending of a command to all registered listeners, invoking theirprotocolCommandSent()
methods.void
fireReplyReceived(int replyCode, java.lang.String message)
Fires a ProtocolCommandEvent signalling the reception of a command reply to all registered listeners, invoking theirprotocolReplyReceived()
methods.int
getListenerCount()
Returns the number of ProtocolCommandListeners currently registered.private void
readObject(java.io.ObjectInputStream in)
void
removeProtocolCommandListener(ProtocolCommandListener listener)
Removes a ProtocolCommandListener.private void
writeObject(java.io.ObjectOutputStream out)
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
source
private final java.lang.Object source
-
listeners
private final ListenerList listeners
-
-
Method Detail
-
addProtocolCommandListener
public void addProtocolCommandListener(ProtocolCommandListener listener)
Adds a ProtocolCommandListener.- Parameters:
listener
- The ProtocolCommandListener to add.
-
fireCommandSent
public void fireCommandSent(java.lang.String command, java.lang.String message)
Fires a ProtocolCommandEvent signalling the sending of a command to all registered listeners, invoking theirprotocolCommandSent()
methods.- Parameters:
command
- The string representation of the command type sent, not including the arguments (e.g., "STAT" or "GET").message
- The entire command string verbatim as sent to the server, including all arguments.
-
fireReplyReceived
public void fireReplyReceived(int replyCode, java.lang.String message)
Fires a ProtocolCommandEvent signalling the reception of a command reply to all registered listeners, invoking theirprotocolReplyReceived()
methods.- Parameters:
replyCode
- The integer code indicating the natureof the reply. This will be the protocol integer value for protocols that use integer reply codes, or the reply class constant corresponding to the reply for protocols like POP3 that use strings like OK rather than integer codes (i.e., POP3Repy.OK).message
- The entire reply as received from the server.
-
getListenerCount
public int getListenerCount()
Returns the number of ProtocolCommandListeners currently registered.- Returns:
- The number of ProtocolCommandListeners currently registered.
-
readObject
private void readObject(java.io.ObjectInputStream in)
-
removeProtocolCommandListener
public void removeProtocolCommandListener(ProtocolCommandListener listener)
Removes a ProtocolCommandListener.- Parameters:
listener
- The ProtocolCommandListener to remove.
-
writeObject
private void writeObject(java.io.ObjectOutputStream out)
-
-