|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject org.apache.commons.net.ProtocolCommandEvent
public class ProtocolCommandEvent
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
ProtocolCommandListener
interface facilitate this process.
ProtocolCommandListener
,
ProtocolCommandSupport
,
Serialized FormField Summary |
---|
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
ProtocolCommandEvent(Object source,
int replyCode,
String message)
Creates a ProtocolCommandEvent signalling a reply to a command was received. |
|
ProtocolCommandEvent(Object source,
String command,
String message)
Creates a ProtocolCommandEvent signalling a command was sent to the server. |
Method Summary | |
---|---|
String |
getCommand()
Returns the string representation of the command type sent (e.g., "STAT" or "GET"). |
String |
getMessage()
Returns the entire message sent to or received from the server. |
int |
getReplyCode()
Returns the reply code of the received server reply. |
boolean |
isCommand()
Returns true if the ProtocolCommandEvent was generated as a result of sending a command. |
boolean |
isReply()
Returns true if the ProtocolCommandEvent was generated as a result of receiving a reply. |
Methods inherited from class java.util.EventObject |
---|
getSource, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ProtocolCommandEvent(Object source, String command, String message)
source
- The source of the event.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.public ProtocolCommandEvent(Object source, int replyCode, String message)
source
- The source of the event.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.Method Detail |
---|
public String getCommand()
public int getReplyCode()
public boolean isCommand()
public boolean isReply()
public String getMessage()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |