org.apache.james.imap.processor

Class ListProcessor

java.lang.Object

org.apache.james.imap.processor.base.AbstractChainedProcessor<M>

org.apache.james.imap.processor.AbstractMailboxProcessor<ListRequest>

org.apache.james.imap.processor.ListProcessor

All Implemented Interfaces:

ImapProcessor

Direct Known Subclasses:

XListProcessor

public class ListProcessor
extends AbstractMailboxProcessor<ListRequest>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.imap.api.process.ImapProcessor

ImapProcessor.Responder

Constructor Summary

Constructors

Constructor and Description
ListProcessor(ImapProcessor next, org.apache.james.mailbox.MailboxManager mailboxManager, StatusResponseFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
protected ImapResponseMessage	createResponse(boolean noInferior, boolean noSelect, boolean marked, boolean unmarked, boolean hasChildren, boolean hasNoChildren, String mailboxName, char delimiter, MailboxType type)
protected void	doProcess(ListRequest request, ImapSession session, String tag, ImapCommand command, ImapProcessor.Responder responder)
protected void	doProcess(String referenceName, String mailboxName, ImapSession session, String tag, ImapCommand command, ImapProcessor.Responder responder, MailboxTyper mailboxTyper) (from rfc3501) The LIST command returns a subset of names from the complete set of all names available to the client.
protected boolean	isAcceptable(ImapMessage message) Is the given message acceptable?

Methods inherited from class org.apache.james.imap.processor.AbstractMailboxProcessor

addFlagsResponses, buildFullPath, bye, bye, condstoreEnablingCommand, doProcess, flags, getMailboxManager, getSelectedMailbox, getStatusResponseFactory, idRanges, mailboxName, messageRange, no, no, normalizeMessageRange, okComplete, okComplete, permanentFlags, process, respondVanished, taggedBad, unsolicitedResponses, unsolicitedResponses

Methods inherited from class org.apache.james.imap.processor.base.AbstractChainedProcessor

process

Methods inherited from class java.lang.Object

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

Constructor Detail

ListProcessor

public ListProcessor(ImapProcessor next,
             org.apache.james.mailbox.MailboxManager mailboxManager,
             StatusResponseFactory factory)

Method Detail

doProcess

protected void doProcess(ListRequest request,
             ImapSession session,
             String tag,
             ImapCommand command,
             ImapProcessor.Responder responder)

Specified by:

doProcess in class AbstractMailboxProcessor<ListRequest>

See Also:

#doProcess(org.apache.james.imap.api.message.request.ImapRequest, org.apache.james.imap.api.process.ImapSession, java.lang.String, org.apache.james.imap.api.ImapCommand, org.apache.james.imap.api.process.ImapProcessor.Responder)

createResponse

protected ImapResponseMessage createResponse(boolean noInferior,
                                 boolean noSelect,
                                 boolean marked,
                                 boolean unmarked,
                                 boolean hasChildren,
                                 boolean hasNoChildren,
                                 String mailboxName,
                                 char delimiter,
                                 MailboxType type)

doProcess

protected final void doProcess(String referenceName,
             String mailboxName,
             ImapSession session,
             String tag,
             ImapCommand command,
             ImapProcessor.Responder responder,
             MailboxTyper mailboxTyper)

(from rfc3501)
The LIST command returns a subset of names from the complete set of all names available to the client. Zero or more untagged LIST replies are returned, containing the name attributes, hierarchy delimiter, and name; see the description of the LIST reply for more detail.
...
An empty ("" string) mailbox name argument is a special request to return the hierarchy delimiter and the root name of the name given in the reference. The value returned as the root MAY be the empty string if the reference is non-rooted or is an empty string.

Parameters:

referenceName -

mailboxName -

session -

tag -

command -

responder -

isAcceptable

protected boolean isAcceptable(ImapMessage message)

Description copied from class: AbstractChainedProcessor

Is the given message acceptable?

Overrides:

isAcceptable in class AbstractChainedProcessor<ListRequest>

Parameters:

message - ImapMessage, not null

Returns:

true if the given message is processable by this processable