org.apache.james.imap.encode.base

Class ImapResponseComposerImpl

java.lang.Object

org.apache.james.imap.encode.base.ImapResponseComposerImpl

All Implemented Interfaces:

ImapConstants, ImapResponseComposer

public class ImapResponseComposerImpl
extends Object
implements ImapConstants, ImapResponseComposer

Class providing methods to send response messages from the server to the client.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE
static String	FAILED
static String	FLAGS

Fields inherited from interface org.apache.james.imap.api.ImapConstants

ACL_RESPONSE_NAME, APPEND_COMMAND_NAME, AUTHENTICATE_COMMAND_NAME, BACK_SLASH, BAD, BYE, BYTE_BACK_SLASH, BYTE_CLOSE_BRACE, BYTE_CLOSE_SQUARE_BRACKET, BYTE_CLOSING_PARENTHESIS, BYTE_DQUOTE, BYTE_OPEN_BRACE, BYTE_OPEN_SQUARE_BRACKET, BYTE_OPENING_PARENTHESIS, BYTE_QUESTION, BYTE_SP, CAPABILITY_COMMAND_NAME, CHECK_COMMAND_NAME, CLOSE_COMMAND_NAME, CLOSING_PARENTHESIS, CLOSING_SQUARE_BRACKET, COMPRESS_COMMAND_NAME, CONTINUATION, COPY_COMMAND_NAME, CREATE_COMMAND_NAME, DEFAULT_BATCH_SIZE, DELETE_COMMAND_NAME, DELETEACL_COMMAND_NAME, DQUOTE, EMPTY_STRING_ARRAY, ENABLE_COMMAND_NAME, EXAMINE_COMMAND_NAME, EXPUNGE_COMMAND_NAME, FETCH_BODY, FETCH_BODY_STRUCTURE, FETCH_COMMAND_NAME, FETCH_MODSEQ, FETCH_RFC822, FETCH_RFC822_HEADER, FETCH_RFC822_TEXT, GETACL_COMMAND_NAME, IDLE_COMMAND_NAME, INBOX_NAME, LINE_END, LIST_COMMAND_NAME, LIST_RESPONSE_NAME, LISTRIGHTS_COMMAND_NAME, LOGIN_COMMAND_NAME, LOGOUT_COMMAND_NAME, LSUB_COMMAND_NAME, LSUB_RESPONSE_NAME, MAX_NZ_NUMBER, MIME_HEADER_CONTENT_LANGUAGE, MIME_HEADER_CONTENT_LOCATION, MIME_HEADER_CONTENT_MD5, MIME_SUBTYPE_PLAIN, MIME_SUBTYPE_RFC822, MIME_TYPE_MESSAGE, MIME_TYPE_MULTIPART, MIME_TYPE_TEXT, MIN_NZ_NUMBER, MYRIGHTS_COMMAND_NAME, NAME_ATTRIBUTE_HAS_CHILDREN, NAME_ATTRIBUTE_HAS_NO_CHILDREN, NAME_ATTRIBUTE_MARKED, NAME_ATTRIBUTE_NOINFERIORS, NAME_ATTRIBUTE_NOSELECT, NAME_ATTRIBUTE_UNMARKED, NAMESPACE_COMMAND_NAME, NIL, NO, NOOP_COMMAND_NAME, OK, OPENING_PARENTHESIS, OPENING_SQUARE_BRACKET, PS_HEADER, PS_MIME, PS_TEXT, RENAME_COMMAND_NAME, RFC822_BCC, RFC822_CC, RFC822_DATE, RFC822_FROM, RFC822_IN_REPLY_TO, RFC822_MESSAGE_ID, RFC822_REPLY_TO, RFC822_SENDER, RFC822_SUBJECT, RFC822_TO, SEARCH_COMMAND_NAME, SEARCH_RESPONSE_NAME, SELECT_COMMAND_NAME, SETACL_COMMAND_NAME, SP, SP_CHAR, STARTTLS, STATUS_COMMAND_NAME, STATUS_HIGHESTMODSEQ, STATUS_MESSAGES, STATUS_RECENT, STATUS_UIDNEXT, STATUS_UIDVALIDITY, STATUS_UNSEEN, STORE_COMMAND_NAME, SUBSCRIBE_COMMAND_NAME, SUPPORTS_ACL, SUPPORTS_CONDSTORE, SUPPORTS_ENABLE, SUPPORTS_I18NLEVEL_1, SUPPORTS_IDLE, SUPPORTS_LITERAL_PLUS, SUPPORTS_NAMESPACES, SUPPORTS_QRESYNC, SUPPORTS_RFC3348, SUPPORTS_STARTTLS, SUPPORTS_XLIST, UID, UID_COMMAND_NAME, UNSELECT_COMMAND_NAME, UNSUBSCRIBE_COMMAND_NAME, UNTAGGED, UTF8, VERSION, XLIST_COMMAND_NAME, XLIST_RESPONSE_NAME

Constructor Summary

Constructors

Constructor and Description
ImapResponseComposerImpl(ImapResponseWriter writer)
ImapResponseComposerImpl(ImapResponseWriter writer, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
ImapResponseComposer	closeParen() Write a ')'
ImapResponseComposer	closeSquareBracket() Write a '}'
ImapResponseComposer	commandName(String commandName)
ImapResponseComposer	commandResponse(ImapCommand command, String message) Compose a response which contains the ImapCommand to which the response belongs
ImapResponseComposer	continuationResponse(String message) Writes a continuation response.
ImapResponseComposer	end() Write a CRLF and flush the composer which will write the content of it to the socket
ImapResponseComposer	flags(javax.mail.Flags flags) Compose flags to output using standard format.
ImapResponseComposer	literal(Literal literal) Compose a Literal and write it to the socket.
ImapResponseComposer	message(long number) Write the message of type Long
ImapResponseComposer	message(String message) Write the message of type String
ImapResponseComposer	nil() Composes a NIL.
ImapResponseComposer	openParen() Write a '('
ImapResponseComposer	openSquareBracket() Write a '{'
ImapResponseComposer	quote(String message) Write a quoted message
ImapResponseComposer	quoteUpperCaseAscii(String message) Appends the given message after conversion to upper case.
ImapResponseComposer	sequenceSet(IdRange[] ranges) Write the given sequence-set
ImapResponseComposer	skipNextSpace() Tell the ImapResponseComposer to skip the next written space
ImapResponseComposer	tag(String tag) Write a tag
ImapResponseComposer	taggedResponse(String message, String tag) Writes the message provided to the client, prepended with the request tag.
ImapResponseComposer	untagged() Write a '*'
ImapResponseComposer	untaggedNoResponse(String displayMessage, String responseCode) Writes an untagged NO response.
ImapResponseComposer	untaggedResponse(String message) Writes the message provided to the client, prepended with the untagged marker "*".
ImapResponseComposer	upperCaseAscii(String message) Appends the given message after conversion to upper case.

Methods inherited from class java.lang.Object

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

Field Detail

FLAGS

public static final String FLAGS

See Also:

Constant Field Values

FAILED

public static final String FAILED

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

ImapResponseComposerImpl

public ImapResponseComposerImpl(ImapResponseWriter writer,
                        int bufferSize)

ImapResponseComposerImpl

public ImapResponseComposerImpl(ImapResponseWriter writer)

Method Detail

untaggedNoResponse

public ImapResponseComposer untaggedNoResponse(String displayMessage,
                                      String responseCode)
                                        throws IOException

Description copied from interface: ImapResponseComposer

Writes an untagged NO response. Indicates that a warning. The command may still complete sucessfully.

Specified by:

untaggedNoResponse in interface ImapResponseComposer

Parameters:

displayMessage - message for display, not null

responseCode - response code or null when there is no response code

Throws:

IOException

See Also:

(java.lang.String, java.lang.String)

continuationResponse

public ImapResponseComposer continuationResponse(String message)
                                          throws IOException

Description copied from interface: ImapResponseComposer

Writes a continuation response.

Specified by:

continuationResponse in interface ImapResponseComposer

Parameters:

message - message for display, not null

Throws:

IOException

See Also:

(java.lang.String)

commandResponse

public ImapResponseComposer commandResponse(ImapCommand command,
                                   String message)
                                     throws IOException

Description copied from interface: ImapResponseComposer

Compose a response which contains the ImapCommand to which the response belongs

Specified by:

commandResponse in interface ImapResponseComposer

Returns:

self

Throws:

IOException

See Also:

ImapResponseComposer.commandResponse(org.apache.james.imap.api.ImapCommand, java.lang.String)

taggedResponse

public ImapResponseComposer taggedResponse(String message,
                                  String tag)
                                    throws IOException

Description copied from interface: ImapResponseComposer

Writes the message provided to the client, prepended with the request tag.

Specified by:

taggedResponse in interface ImapResponseComposer

Parameters:

message - The message to write to the client.

Throws:

IOException

See Also:

ImapResponseComposer.taggedResponse(java.lang.String, java.lang.String)

untaggedResponse

public ImapResponseComposer untaggedResponse(String message)
                                      throws IOException

Description copied from interface: ImapResponseComposer

Writes the message provided to the client, prepended with the untagged marker "*".

Specified by:

untaggedResponse in interface ImapResponseComposer

Parameters:

message - The message to write to the client.

Throws:

IOException

See Also:

ImapResponseComposer.untaggedResponse(java.lang.String)

untagged

public ImapResponseComposer untagged()
                              throws IOException

Description copied from interface: ImapResponseComposer

Write a '*'

Specified by:

untagged in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.untagged()

message

public ImapResponseComposer message(String message)
                             throws IOException

Description copied from interface: ImapResponseComposer

Write the message of type String

Specified by:

message in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.message(java.lang.String)

end

public ImapResponseComposer end()
                         throws IOException

Description copied from interface: ImapResponseComposer

Write a CRLF and flush the composer which will write the content of it to the socket

Specified by:

end in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.end()

tag

public ImapResponseComposer tag(String tag)
                         throws IOException

Description copied from interface: ImapResponseComposer

Write a tag

Specified by:

tag in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.tag(java.lang.String)

closeParen

public ImapResponseComposer closeParen()
                                throws IOException

Description copied from interface: ImapResponseComposer

Write a ')'

Specified by:

closeParen in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.closeParen()

openParen

public ImapResponseComposer openParen()
                               throws IOException

Description copied from interface: ImapResponseComposer

Write a '('

Specified by:

openParen in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.openParen()

flags

public ImapResponseComposer flags(javax.mail.Flags flags)
                           throws IOException

Description copied from interface: ImapResponseComposer

Compose flags to output using standard format.

Specified by:

flags in interface ImapResponseComposer

Parameters:

flags - Flags, not null

Throws:

IOException

See Also:

ImapResponseComposer.flags(javax.mail.Flags)

nil

public ImapResponseComposer nil()
                         throws IOException

Description copied from interface: ImapResponseComposer

Composes a NIL.

Specified by:

nil in interface ImapResponseComposer

Throws:

IOException

See Also:

ImapResponseComposer.nil()

upperCaseAscii

public ImapResponseComposer upperCaseAscii(String message)
                                    throws IOException

Description copied from interface: ImapResponseComposer

Appends the given message after conversion to upper case. The message may be assumed to be ASCII encoded. Conversion of characters MUST NOT be performed according to the current locale but as per ASCII.

Specified by:

upperCaseAscii in interface ImapResponseComposer

Parameters:

message - ASCII encoded, not null

Returns:

self, not null

Throws:

IOException

See Also:

ImapResponseComposer.upperCaseAscii(java.lang.String)

quoteUpperCaseAscii

public ImapResponseComposer quoteUpperCaseAscii(String message)
                                         throws IOException

Description copied from interface: ImapResponseComposer

Appends the given message after conversion to upper case. The message may be assumed to be ASCII encoded. Conversion of characters MUST NOT be performed according to the current locale but as per ASCII.

Specified by:

quoteUpperCaseAscii in interface ImapResponseComposer

Parameters:

message - ASCII encoded, not null

Returns:

self, not null

Throws:

IOException

See Also:

(java.lang.String)

message

public ImapResponseComposer message(long number)
                             throws IOException

Description copied from interface: ImapResponseComposer

Write the message of type Long

Specified by:

message in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.message(long)

commandName

public ImapResponseComposer commandName(String commandName)
                                 throws IOException

Specified by:

commandName in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.commandName(java.lang.String)

quote

public ImapResponseComposer quote(String message)
                           throws IOException

Description copied from interface: ImapResponseComposer

Write a quoted message

Specified by:

quote in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.quote(java.lang.String)

skipNextSpace

public ImapResponseComposer skipNextSpace()

Description copied from interface: ImapResponseComposer

Tell the ImapResponseComposer to skip the next written space

Specified by:

skipNextSpace in interface ImapResponseComposer

Returns:

composer

See Also:

ImapResponseComposer.skipNextSpace()

literal

public ImapResponseComposer literal(Literal literal)
                             throws IOException

Description copied from interface: ImapResponseComposer

Compose a Literal and write it to the socket. Everything which was buffered before will get written too

Specified by:

literal in interface ImapResponseComposer

Returns:

self

Throws:

IOException

See Also:

ImapResponseComposer.literal(org.apache.james.imap.message.response.Literal)

closeSquareBracket

public ImapResponseComposer closeSquareBracket()
                                        throws IOException

Description copied from interface: ImapResponseComposer

Write a '}'

Specified by:

closeSquareBracket in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

openSquareBracket

public ImapResponseComposer openSquareBracket()
                                       throws IOException

Description copied from interface: ImapResponseComposer

Write a '{'

Specified by:

openSquareBracket in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

sequenceSet

public ImapResponseComposer sequenceSet(IdRange[] ranges)
                                 throws IOException

Description copied from interface: ImapResponseComposer

Write the given sequence-set

Specified by:

sequenceSet in interface ImapResponseComposer

Returns:

composer

Throws:

IOException

See Also:

ImapResponseComposer.sequenceSet(org.apache.james.imap.api.message.IdRange[])