| java.lang.Object
 java.util.EventObject
org.apache.commons.net.ProtocolCommandEvent
| ProtocolCommandEvent | | public class ProtocolCommandEvent extends EventObject (Code) | | 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. For debugging and other purposes, it is extremely
useful to log or keep track of the contents of the protocol messages.
The ProtocolCommandEvent class coupled with the
org.apache.commons.net.ProtocolCommandListener interface facilitate this process.
See Also: ProtocolCommandListener
See Also: ProtocolCommandSupport
author:
Daniel F. Savarese |
| Method Summary | |
| public String | getCommand()
Returns the string representation of the command type sent (e.g., "STAT"
or "GET"). | | public String | getMessage()
Returns the entire message sent to or received from the server. | | public int | getReplyCode()
Returns the reply code of the received server reply. | | public boolean | isCommand()
Returns true if the ProtocolCommandEvent was generated as a result
of sending a command.
true If the ProtocolCommandEvent was generated as a resultof sending a command. | | public boolean | isReply()
Returns true if the ProtocolCommandEvent was generated as a result
of receiving a reply.
true If the ProtocolCommandEvent was generated as a resultof receiving a reply. |
| ProtocolCommandEvent | | public ProtocolCommandEvent(Object source, String command, String message)(Code) | | Creates a ProtocolCommandEvent signalling a command was sent to
the server. ProtocolCommandEvents created with this constructor
should only be sent after a command has been sent, but before the
reply has been received.
Parameters:
source - The source of the event.
Parameters:
command - The string representation of the command type sent, notincluding the arguments (e.g., "STAT" or "GET").
Parameters:
message - The entire command string verbatim as sent to the server,including all arguments. |
| ProtocolCommandEvent | | public ProtocolCommandEvent(Object source, int replyCode, String message)(Code) | | Creates a ProtocolCommandEvent signalling a reply to a command was
received. ProtocolCommandEvents created with this constructor
should only be sent after a complete command reply has been received
fromt a server.
Parameters:
source - The source of the event.
Parameters:
replyCode - The integer code indicating the natureof the reply.This will be the protocol integer value for protocolsthat use integer reply codes, or the reply class constantcorresponding to the reply for protocols like POP3 that usestrings like OK rather than integer codes (i.e., POP3Repy.OK).
Parameters:
message - The entire reply as received from the server. |
| getCommand | | public String getCommand()(Code) | | Returns the string representation of the command type sent (e.g., "STAT"
or "GET"). If the ProtocolCommandEvent is a reply event, then null
is returned.
The string representation of the command type sent, or nullif this is a reply event. |
| getMessage | | public String getMessage()(Code) | | Returns the entire message sent to or received from the server.
The entire message sent to or received from the server. |
| getReplyCode | | public int getReplyCode()(Code) | | Returns the reply code of the received server reply. Undefined if
this is not a reply event.
The reply code of the received server reply. Undefined ifnot a reply event. |
| isCommand | | public boolean isCommand()(Code) | | Returns true if the ProtocolCommandEvent was generated as a result
of sending a command.
true If the ProtocolCommandEvent was generated as a resultof sending a command. False otherwise. |
| isReply | | public boolean isReply()(Code) | | Returns true if the ProtocolCommandEvent was generated as a result
of receiving a reply.
true If the ProtocolCommandEvent was generated as a resultof receiving a reply. False otherwise. |
|
|