org.apache.mina.handler.chain

Class IoHandlerChain

java.lang.Object

org.apache.mina.handler.chain.IoHandlerChain

All Implemented Interfaces:

IoHandlerCommand

public class IoHandlerChain
extends java.lang.Object
implements IoHandlerCommand

A chain of IoHandlerCommands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IoHandlerChain.Entry Represents a name-command pair that an IoHandlerChain contains.

Nested classes/interfaces inherited from interface org.apache.mina.handler.chain.IoHandlerCommand

IoHandlerCommand.NextCommand

Field Summary

Fields

Modifier and Type	Field and Description
private IoHandlerChain.Entry	head
private int	id
private java.util.Map<java.lang.String,IoHandlerChain.Entry>	name2entry
private java.lang.String	NEXT_COMMAND
private static int	nextId
private IoHandlerChain.Entry	tail

Constructor Summary

Constructors

Constructor and Description
IoHandlerChain() Creates a new, empty chain of IoHandlerCommands.

Method Summary

Modifier and Type	Method and Description
void	addAfter(java.lang.String baseName, java.lang.String name, IoHandlerCommand command)
void	addBefore(java.lang.String baseName, java.lang.String name, IoHandlerCommand command)
void	addFirst(java.lang.String name, IoHandlerCommand command)
void	addLast(java.lang.String name, IoHandlerCommand command)
private void	callNextCommand(IoHandlerChain.Entry entry, IoSession session, java.lang.Object message)
private void	checkAddable(java.lang.String name) Checks the specified filter name is already taken and throws an exception if already taken.
private IoHandlerChain.Entry	checkOldName(java.lang.String baseName) Throws an exception when the specified filter name is not registered in this chain.
void	clear()
boolean	contains(java.lang.Class<? extends IoHandlerCommand> commandType)
boolean	contains(IoHandlerCommand command)
boolean	contains(java.lang.String name)
private IoHandlerCommand	createHeadCommand()
private IoHandlerCommand	createTailCommand()
private void	deregister(IoHandlerChain.Entry entry)
void	execute(IoHandlerCommand.NextCommand next, IoSession session, java.lang.Object message) Execute a unit of processing work to be performed.
IoHandlerCommand	get(java.lang.String name)
java.util.List<IoHandlerChain.Entry>	getAll()
java.util.List<IoHandlerChain.Entry>	getAllReversed()
IoHandlerChain.Entry	getEntry(java.lang.String name)
IoHandlerCommand.NextCommand	getNextCommand(java.lang.String name)
private void	register(IoHandlerChain.Entry prevEntry, java.lang.String name, IoHandlerCommand command)
IoHandlerCommand	remove(java.lang.String name)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

nextId

private static volatile int nextId

id

private final int id

NEXT_COMMAND

private final java.lang.String NEXT_COMMAND

name2entry

private final java.util.Map<java.lang.String,IoHandlerChain.Entry> name2entry

head

private final IoHandlerChain.Entry head

tail

private final IoHandlerChain.Entry tail

Constructor Detail

IoHandlerChain

public IoHandlerChain()

Creates a new, empty chain of IoHandlerCommands.

Method Detail

createHeadCommand

private IoHandlerCommand createHeadCommand()

createTailCommand

private IoHandlerCommand createTailCommand()

getEntry

public IoHandlerChain.Entry getEntry(java.lang.String name)

get

public IoHandlerCommand get(java.lang.String name)

getNextCommand

public IoHandlerCommand.NextCommand getNextCommand(java.lang.String name)

addFirst

public void addFirst(java.lang.String name,
                     IoHandlerCommand command)

addLast

public void addLast(java.lang.String name,
                    IoHandlerCommand command)

addBefore

public void addBefore(java.lang.String baseName,
                      java.lang.String name,
                      IoHandlerCommand command)

addAfter

public void addAfter(java.lang.String baseName,
                     java.lang.String name,
                     IoHandlerCommand command)

remove

public IoHandlerCommand remove(java.lang.String name)

clear

public void clear()
           throws java.lang.Exception

Throws:

java.lang.Exception

register

private void register(IoHandlerChain.Entry prevEntry,
                      java.lang.String name,
                      IoHandlerCommand command)

deregister

private void deregister(IoHandlerChain.Entry entry)

checkOldName

private IoHandlerChain.Entry checkOldName(java.lang.String baseName)

Throws an exception when the specified filter name is not registered in this chain.

Returns:

An filter entry with the specified name.

checkAddable

private void checkAddable(java.lang.String name)

Checks the specified filter name is already taken and throws an exception if already taken.

execute

public void execute(IoHandlerCommand.NextCommand next,
                    IoSession session,
                    java.lang.Object message)
             throws java.lang.Exception

Description copied from interface: IoHandlerCommand

Execute a unit of processing work to be performed. This IoHandlerCommand may either complete the required processing and just return to stop the processing, or delegate remaining processing to the next IoHandlerCommand in a IoHandlerChain containing this IoHandlerCommand by calling IoHandlerCommand.NextCommand.execute(IoSession,Object).

Specified by:

execute in interface IoHandlerCommand

Parameters:

next - an indirect reference to the next IoHandlerCommand that provides a way to forward the request to the next IoHandlerCommand.

session - the IoSession which is associated with this request

message - the message object of this request

Throws:

java.lang.Exception - general purpose exception return to indicate abnormal termination

callNextCommand

private void callNextCommand(IoHandlerChain.Entry entry,
                             IoSession session,
                             java.lang.Object message)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getAll

public java.util.List<IoHandlerChain.Entry> getAll()

getAllReversed

public java.util.List<IoHandlerChain.Entry> getAllReversed()

contains

public boolean contains(java.lang.String name)

contains

public boolean contains(IoHandlerCommand command)

contains

public boolean contains(java.lang.Class<? extends IoHandlerCommand> commandType)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object