Package com.oroinc.net
Class ProtocolCommandSupport
java.lang.Object
com.oroinc.net.ProtocolCommandSupport
- All Implemented Interfaces:
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.
- Author:
- Daniel F. Savarese
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionProtocolCommandSupport
(Object source) Creates a ProtocolCommandSupport instant using the indicated source as the source of fired ProtocolCommandEvents. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a ProtocolCommandListener.void
fireCommandSent
(String command, String message) Fires a ProtocolCommandEvent signalling the sending of a command to all registered listeners, invoking their protocolCommandSent() methods.void
fireReplyReceived
(int replyCode, String message) Fires a ProtocolCommandEvent signalling the reception of a command reply to all registered listeners, invoking their protocolReplyReceived() methods.int
Returns the number of ProtocolCommandListeners currently registered.void
Removes a ProtocolCommandListener.
-
Constructor Details
-
ProtocolCommandSupport
Creates a ProtocolCommandSupport instant using the indicated source as the source of fired ProtocolCommandEvents.- Parameters:
source
- The source to use for all generated ProtocolCommandEvents.
-
-
Method Details
-
fireCommandSent
Fires a ProtocolCommandEvent signalling the sending of a command to all registered listeners, invoking their protocolCommandSent() 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
Fires a ProtocolCommandEvent signalling the reception of a command reply to all registered listeners, invoking their protocolReplyReceived() 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.
-
addProtocolCommandListener
Adds a ProtocolCommandListener.- Parameters:
listener
- The ProtocolCommandListener to add.
-
removeProtocolCommandListener
Removes a ProtocolCommandListener.- Parameters:
listener
- The ProtocolCommandListener to remove.
-
getListenerCount
public int getListenerCount()Returns the number of ProtocolCommandListeners currently registered.- Returns:
- The number of ProtocolCommandListeners currently registered.
-