com.sun.mail.iap

Class Protocol

java.lang.Object

com.sun.mail.iap.Protocol

Direct Known Subclasses:

IMAPProtocol

public class Protocol
extends java.lang.Object

General protocol handling code for IMAP-like protocols.

The Protocol object is multithread safe.

Constructor Summary

Constructors

Constructor and Description
Protocol(java.io.InputStream in, java.io.PrintStream out, boolean debug) Constructor for debugging.
Protocol(java.lang.String host, int port, java.util.Properties props, java.lang.String prefix, boolean isSSL, MailLogger logger) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addResponseHandler(ResponseHandler h) Adds a response handler.
Response[]	command(java.lang.String command, Argument args) Send a command to the server.
long	getTimestamp() Returns the timestamp.
void	handleResult(Response response) Convenience routine to handle OK, NO, BAD and BYE responses.
boolean	isSSL() Is this connection using an SSL socket?
void	notifyResponseHandlers(Response[] responses) Notify response handlers
Response	readResponse()
void	removeResponseHandler(ResponseHandler h) Removed the specified response handler.
void	simpleCommand(java.lang.String cmd, Argument args) Convenience routine to handle simple IAP commands that do not have responses specific to that command.
void	startTLS(java.lang.String cmd) Start TLS on the current connection.
java.lang.String	writeCommand(java.lang.String command, Argument args)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Protocol

public Protocol(java.lang.String host,
                int port,
                java.util.Properties props,
                java.lang.String prefix,
                boolean isSSL,
                MailLogger logger)
         throws java.io.IOException,
                ProtocolException

Constructor.

Opens a connection to the given host at given port.

Parameters:

host - host to connect to

port - portnumber to connect to

props - Properties object used by this protocol

prefix - Prefix to prepend to property keys

isSSL - use SSL?

logger - log messages here

Throws:

java.io.IOException

ProtocolException

Protocol

public Protocol(java.io.InputStream in,
                java.io.PrintStream out,
                boolean debug)
         throws java.io.IOException

Constructor for debugging.

Throws:

java.io.IOException

Method Detail

getTimestamp

public long getTimestamp()

Returns the timestamp.

addResponseHandler

public void addResponseHandler(ResponseHandler h)

Adds a response handler.

removeResponseHandler

public void removeResponseHandler(ResponseHandler h)

Removed the specified response handler.

notifyResponseHandlers

public void notifyResponseHandlers(Response[] responses)

Notify response handlers

readResponse

public Response readResponse()
                      throws java.io.IOException,
                             ProtocolException

Throws:

java.io.IOException

ProtocolException

writeCommand

public java.lang.String writeCommand(java.lang.String command,
                                     Argument args)
                              throws java.io.IOException,
                                     ProtocolException

Throws:

java.io.IOException

ProtocolException

command

public Response[] command(java.lang.String command,
                          Argument args)

Send a command to the server. Collect all responses until either the corresponding command completion response or a BYE response (indicating server failure). Return all the collected responses.

Parameters:

command - the command

args - the arguments

Returns:

array of Response objects returned by the server

handleResult

public void handleResult(Response response)
                  throws ProtocolException

Convenience routine to handle OK, NO, BAD and BYE responses.

Throws:

ProtocolException

simpleCommand

public void simpleCommand(java.lang.String cmd,
                          Argument args)
                   throws ProtocolException

Convenience routine to handle simple IAP commands that do not have responses specific to that command.

Throws:

ProtocolException

startTLS

public void startTLS(java.lang.String cmd)
              throws java.io.IOException,
                     ProtocolException

Start TLS on the current connection. cmd is the command to issue to start TLS negotiation. If the command succeeds, we begin TLS negotiation. If the socket is already an SSLSocket this is a nop and the command is not issued.

Throws:

java.io.IOException

ProtocolException

isSSL

public boolean isSSL()

Is this connection using an SSL socket?

Returns:

true if using SSL

Since:

JavaMail 1.4.6