|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface POP3Session
All the handlers access this interface to communicate with POP3Handler object
Method Summary | |
---|---|
java.lang.String |
clearResponseBuffer()
Clears the response buffer, returning the String of characters in the buffer. |
void |
endSession()
this makes the session to close |
java.util.List |
getBackupUserMailbox()
Returns the backup mailbox |
java.lang.String |
getCommandArgument()
Returns currently process command argument |
java.lang.String |
getCommandName()
Returns currently process command name |
POP3HandlerConfigurationData |
getConfigurationData()
Returns POP3Handler service wide configuration |
int |
getHandlerState()
Returns the current handler state |
java.io.OutputStream |
getOutputStream()
Returns the raw output stream |
java.lang.String |
getRemoteHost()
Returns host name of the client |
java.lang.String |
getRemoteIPAddress()
Returns host ip address of the client |
java.lang.StringBuffer |
getResponseBuffer()
Returns ResponseBuffer, this optimizes the unecessary creation of resources by each handler object |
java.util.HashMap |
getState()
Returns Map that consists of the state of the POP3Session |
java.lang.String |
getUser()
Returns the user name associated with this POP3 interaction. |
MailRepository |
getUserInbox()
Returns the current user inbox |
java.util.List |
getUserMailbox()
Returns the mail list contained in the mailbox |
Watchdog |
getWatchdog()
Returns Watchdog object used for handling timeout |
boolean |
isSessionEnded()
Returns the session status |
java.lang.String |
readCommandLine()
Reads a line of characters off the command line. |
void |
resetState()
Resets message-specific, but not authenticated user, state. |
void |
setBackupUserMailbox(java.util.List backupUserMailbox)
Sets a new backup mailbox content |
void |
setHandlerState(int handlerState)
Sets the new handler state |
void |
setUser(java.lang.String user)
Sets the user name associated with this POP3 interaction. |
void |
setUserInbox(MailRepository userInbox)
Sets the user's mail repository |
void |
setUserMailbox(java.util.List userMailbox)
Sets a new mailbox content |
void |
writeResponse(java.lang.String respString)
Writes response string to the client |
Method Detail |
---|
void writeResponse(java.lang.String respString)
respString
- String that needs to send to the clientjava.lang.String readCommandLine() throws java.io.IOException
java.io.IOException
- if an exception is generated reading in the input charactersjava.lang.StringBuffer getResponseBuffer()
java.lang.String clearResponseBuffer()
java.lang.String getCommandName()
java.lang.String getCommandArgument()
java.lang.String getRemoteHost()
java.lang.String getRemoteIPAddress()
void endSession()
boolean isSessionEnded()
java.util.HashMap getState()
void resetState()
POP3HandlerConfigurationData getConfigurationData()
java.lang.String getUser()
void setUser(java.lang.String user)
user
- the user nameWatchdog getWatchdog()
int getHandlerState()
void setHandlerState(int handlerState)
handlerState
- stateMailRepository getUserInbox()
void setUserInbox(MailRepository userInbox)
userInbox
- userInboxjava.util.List getUserMailbox()
void setUserMailbox(java.util.List userMailbox)
userMailbox
- mailboxjava.util.List getBackupUserMailbox()
void setBackupUserMailbox(java.util.List backupUserMailbox)
backupUserMailbox
- the mailbox backupjava.io.OutputStream getOutputStream()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |