ProtocolCommandEventpublic class ProtocolCommandEvent extends EventObject | 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
{@link org.apache.commons.net.ProtocolCommandListener}
interface facilitate this process.
|
| Fields Summary |
|---|
| private int | __replyCode | | private boolean | __isCommand | | private String | __message | | private String | __command |
| Constructors Summary |
|---|
public ProtocolCommandEvent(Object source, String command, String message)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.
super(source);
__replyCode = 0;
__message = message;
__isCommand = true;
__command = command;
| public ProtocolCommandEvent(Object source, int replyCode, String message)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.
super(source);
__replyCode = replyCode;
__message = message;
__isCommand = false;
__command = null;
|
| Methods Summary |
|---|
| public java.lang.String | getCommand()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.
return __command;
| | public java.lang.String | getMessage()Returns the entire message sent to or received from the server.
return __message;
| | public int | getReplyCode()Returns the reply code of the received server reply. Undefined if
this is not a reply event.
return __replyCode;
| | public boolean | isCommand()Returns true if the ProtocolCommandEvent was generated as a result
of sending a command.
return __isCommand;
| | public boolean | isReply()Returns true if the ProtocolCommandEvent was generated as a result
of receiving a reply.
return !isCommand();
|
|
