org.apache.james.imap.decode.base

Class AbstractImapCommandParser

java.lang.Object

org.apache.james.imap.decode.base.AbstractImapCommandParser

All Implemented Interfaces:

ImapCommandParser, MessagingImapCommandParser

Direct Known Subclasses:

AbstractSelectionCommandParser, AppendCommandParser, AuthenticateCommandParser, CapabilityCommandParser, CheckCommandParser, CompressCommandParser, CopyCommandParser, CreateCommandParser, DeleteCommandParser, EnableCommandParser, ExpungeCommandParser, FetchCommandParser, GetACLCommandParser, IdleCommandParser, ListCommandParser, LoginCommandParser, LogoutCommandParser, NamespaceCommandParser, NoopCommandParser, RenameCommandParser, SearchCommandParser, StartTLSCommandParser, StatusCommandParser, StoreCommandParser, SubscribeCommandParser, UidCommandParser, UnselectCommandParser, UnsubscribeCommandParser

public abstract class AbstractImapCommandParser
extends Object
implements MessagingImapCommandParser

Note:

Constructor Summary

Constructors

Constructor and Description
AbstractImapCommandParser(ImapCommand command)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ImapMessage	decode(ImapCommand command, ImapRequestLineReader request, String tag, ImapSession session) Parses a request into a command message for later processing.
ImapCommand	getCommand()
StatusResponseFactory	getStatusResponseFactory()
ImapMessage	parse(ImapRequestLineReader request, String tag, ImapSession session) Parses a request into a command message for later processing.
void	setStatusResponseFactory(StatusResponseFactory statusResponseFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractImapCommandParser

public AbstractImapCommandParser(ImapCommand command)

Method Detail

getCommand

public ImapCommand getCommand()

getStatusResponseFactory

public final StatusResponseFactory getStatusResponseFactory()

Specified by:

getStatusResponseFactory in interface MessagingImapCommandParser

See Also:

MessagingImapCommandParser.getStatusResponseFactory()

setStatusResponseFactory

public final void setStatusResponseFactory(StatusResponseFactory statusResponseFactory)

Specified by:

setStatusResponseFactory in interface MessagingImapCommandParser

See Also:

(org.apache.james.imap.api.message.response.StatusResponseFactory)

parse

public final ImapMessage parse(ImapRequestLineReader request,
                String tag,
                ImapSession session)

Parses a request into a command message for later processing.

Specified by:

parse in interface ImapCommandParser

Parameters:

request - ImapRequestLineReader, not null

tag - not null

session - the ImapSession

Returns:

ImapCommandMessage, not null

decode

protected abstract ImapMessage decode(ImapCommand command,
                 ImapRequestLineReader request,
                 String tag,
                 ImapSession session)
                               throws DecodingException

Parses a request into a command message for later processing.

Parameters:

command - ImapCommand to be parsed, not null

request - ImapRequestLineReader, not null

tag - command tag, not null

session - imap session

Returns:

ImapCommandMessage, not null

Throws:

DecodingException - if the request cannot be parsed