org.apache.james.imap.processor.base

Class AbstractChainedProcessor<M extends ImapMessage>

java.lang.Object

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

All Implemented Interfaces:

ImapProcessor

Direct Known Subclasses:

AbstractMailboxProcessor, CompressProcessor, ImapResponseMessageProcessor, StartTLSProcessor, SystemMessageProcessor

public abstract class AbstractChainedProcessor<M extends ImapMessage>
extends Object
implements ImapProcessor

Nested Class Summary

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

ImapProcessor.Responder

Constructor Summary

Constructors

Constructor and Description
AbstractChainedProcessor(Class<M> acceptableClass, ImapProcessor next) Constructs a chainable ImapProcessor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doProcess(M acceptableMessage, ImapProcessor.Responder responder, ImapSession session) Processes an acceptable message.
protected boolean	isAcceptable(ImapMessage message) Is the given message acceptable?
void	process(ImapMessage message, ImapProcessor.Responder responder, ImapSession session) Performs processing of the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractChainedProcessor

public AbstractChainedProcessor(Class<M> acceptableClass,
                        ImapProcessor next)

Constructs a chainable ImapProcessor.

Parameters:

next - next ImapProcessor in the chain, not null

Method Detail

process

public void process(ImapMessage message,
           ImapProcessor.Responder responder,
           ImapSession session)

Description copied from interface: ImapProcessor

Performs processing of the command. If this processor does not understand the given message then it must return an appropriate message as per the specification. RuntimeException should not be thrown in this circumstance.

Specified by:

process in interface ImapProcessor

Parameters:

message - not null

responder - not null, the responder use write response for message

session - the imap session

See Also:

ImapProcessor.process(org.apache.james.imap.api.ImapMessage, org.apache.james.imap.api.process.ImapProcessor.Responder, org.apache.james.imap.api.process.ImapSession)

isAcceptable

protected boolean isAcceptable(ImapMessage message)

Is the given message acceptable?

Parameters:

message - ImapMessage, not null

Returns:

true if the given message is processable by this processable

doProcess

protected abstract void doProcess(M acceptableMessage,
             ImapProcessor.Responder responder,
             ImapSession session)

Processes an acceptable message. Only messages passing isAcceptable(ImapMessage) should be passed to this method.

Parameters:

acceptableMessage - M, not null

responder - Responder, not null

session - ImapSession, not null