org.apache.james.protocols.api.handler

Class CommandDispatcher<Session extends ProtocolSession>

java.lang.Object

org.apache.james.protocols.api.handler.CommandDispatcher<Session>

All Implemented Interfaces:

ExtensibleHandler, LineHandler<Session>, ProtocolHandler

Direct Known Subclasses:

IMAPCommandDispatcher

public class CommandDispatcher<Session extends ProtocolSession>
extends Object
implements ExtensibleHandler, LineHandler<Session>

A CommandDispatcher is responsible to call the right CommandHandler for a given Command

Constructor Summary

Constructors

Constructor and Description
CommandDispatcher()
CommandDispatcher(Collection<String> mandatoryCommands)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToMap(String commandName, CommandHandler<Session> cmdHandler) Add it to map (key as command name, value is an array list of CommandHandlers)
protected Response	dispatchCommandHandlers(Session session, Request request) Dispatch the CommandHandler's for the given Request and return a Response or null if non should get written back to the client
protected List<CommandHandler<Session>>	getCommandHandlers(String command, ProtocolSession session) Returns all the configured CommandHandlers for the specified command
List<Class<?>>	getMarkerInterfaces() Return a List of interfaces of plugins that will extend this.
protected String	getUnknownCommandHandlerIdentifier() Return the identifier to lookup the UnknownCmdHandler in the handler map
Response	onLine(Session session, ByteBuffer line) Processing the give line.
protected Request	parseRequest(Session session, ByteBuffer buffer) Parse the line into a Request
void	wireExtensions(Class interfaceName, List extension) Method called during initialization after all the handlers have been declared in the ProtocolHandlerChain.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandDispatcher

public CommandDispatcher(Collection<String> mandatoryCommands)

CommandDispatcher

public CommandDispatcher()

Method Detail

addToMap

protected void addToMap(String commandName,
            CommandHandler<Session> cmdHandler)

Add it to map (key as command name, value is an array list of CommandHandlers)

Parameters:

commandName - the command name which will be key

cmdHandler - The CommandHandler object

getCommandHandlers

protected List<CommandHandler<Session>> getCommandHandlers(String command,
                                               ProtocolSession session)

Returns all the configured CommandHandlers for the specified command

Parameters:

command - the command name which will be key

session - not null

Returns:

List of CommandHandlers

wireExtensions

public void wireExtensions(Class interfaceName,
                  List extension)
                    throws WiringException

Description copied from interface: ExtensibleHandler

Method called during initialization after all the handlers have been declared in the ProtocolHandlerChain.

Specified by:

wireExtensions in interface ExtensibleHandler

extension - a list of objects implementing the marker interface

Throws:

WiringException

See Also:

ExtensibleHandler.wireExtensions(java.lang.Class, java.util.List)

onLine

public Response onLine(Session session,
              ByteBuffer line)

Description copied from interface: LineHandler

Processing the give line. The line includes the ProtocolSession.getLineDelimiter() delimiter.

Specified by:

onLine in interface LineHandler<Session extends ProtocolSession>

Parameters:

session - not null

Returns:

response or null

dispatchCommandHandlers

protected Response dispatchCommandHandlers(Session session,
                               Request request)

Dispatch the CommandHandler's for the given Request and return a Response or null if non should get written back to the client

Parameters:

session -

request -

Returns:

response

parseRequest

protected Request parseRequest(Session session,
                   ByteBuffer buffer)
                        throws Exception

Parse the line into a Request

Parameters:

session -

line -

Returns:

request

Throws:

Exception

getMarkerInterfaces

public List<Class<?>> getMarkerInterfaces()

Description copied from interface: ExtensibleHandler

Return a List of interfaces of plugins that will extend this.

Specified by:

getMarkerInterfaces in interface ExtensibleHandler

See Also:

ExtensibleHandler.getMarkerInterfaces()

getUnknownCommandHandlerIdentifier

protected String getUnknownCommandHandlerIdentifier()

Return the identifier to lookup the UnknownCmdHandler in the handler map

Returns:

identifier