Package 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	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	Description
private IoHandlerChain.Entry	head	The head of the IoHandlerCommand chain
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	THe tail of the IoHandlerCommand chain

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addAfter(java.lang.String baseName, java.lang.String name, IoHandlerCommand command)	Adds a name-command after a given name-command in the chain
void	addBefore(java.lang.String baseName, java.lang.String name, IoHandlerCommand command)	Adds a name-command before a given name-command in the chain
void	addFirst(java.lang.String name, IoHandlerCommand command)	Adds a name-command pair into the chain
void	addLast(java.lang.String name, IoHandlerCommand command)	Adds a name-command at the end of the chain
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()	Remove all the IoHandlerCommand from the chain
boolean	contains(java.lang.Class<? extends IoHandlerCommand> commandType)	Checks if the chain of IoHandlerCommand contains a specific IoHandlerCommand
boolean	contains(java.lang.String name)	Checks if the chain of IoHandlerCommand contains a IoHandlerCommand by its name
boolean	contains(IoHandlerCommand command)	Checks if the chain of IoHandlerCommand contains a specific IoHandlerCommand
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)	Retrieve a IoHandlerCommand by its name
java.util.List<IoHandlerChain.Entry>	getAll()
java.util.List<IoHandlerChain.Entry>	getAllReversed()
IoHandlerChain.Entry	getEntry(java.lang.String name)	Retrieve a name-command pair by its name
IoHandlerCommand.NextCommand	getNextCommand(java.lang.String name)	Retrieve the IoHandlerCommand following the IoHandlerCommand we fetched by its name
private void	register(IoHandlerChain.Entry prevEntry, java.lang.String name, IoHandlerCommand command)
IoHandlerCommand	remove(java.lang.String name)	Removes a IoHandlerCommand by its 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

The head of the IoHandlerCommand chain

tail

private final IoHandlerChain.Entry tail

THe tail of the IoHandlerCommand chain

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)

Retrieve a name-command pair by its name

Parameters:

name - The name of the IoHandlerCommand we are looking for

Returns:

The associated name-command pair, if any, null otherwise

get

public IoHandlerCommand get(java.lang.String name)

Retrieve a IoHandlerCommand by its name

Parameters:

name - The name of the IoHandlerCommand we are looking for

Returns:

The associated IoHandlerCommand, if any, null otherwise

getNextCommand

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

Retrieve the IoHandlerCommand following the IoHandlerCommand we fetched by its name

Parameters:

name - The name of the IoHandlerCommand

Returns:

The IoHandlerCommand which is next to teh ngiven name, if any, null otherwise

addFirst

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

Adds a name-command pair into the chain

Parameters:

name - The name

command - The command

addLast

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

Adds a name-command at the end of the chain

Parameters:

name - The name

command - The command

addBefore

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

Adds a name-command before a given name-command in the chain

Parameters:

baseName - The IoHandlerCommand name before which we will inject a new name-command

name - The name The name

command - The command The command

addAfter

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

Adds a name-command after a given name-command in the chain

Parameters:

baseName - The IoHandlerCommand name after which we will inject a new name-command

name - The name The name

command - The command The command

remove

public IoHandlerCommand remove(java.lang.String name)

Removes a IoHandlerCommand by its name

Parameters:

name - The name

Returns:

The removed IoHandlerCommand

clear

public void clear()
           throws java.lang.Exception

Remove all the IoHandlerCommand from the chain

Throws:

java.lang.Exception - If we faced some exception during the cleanup

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

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()

Returns:

The list of name-commands registered into the chain

getAllReversed

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

Returns:

A reverted list of the registered name-commands

contains

public boolean contains(java.lang.String name)

Checks if the chain of IoHandlerCommand contains a IoHandlerCommand by its name

Parameters:

name - The IoHandlerCommand name

Returns:

TRUE if the IoHandlerCommand is found in the chain

contains

public boolean contains(IoHandlerCommand command)

Checks if the chain of IoHandlerCommand contains a specific IoHandlerCommand

Parameters:

command - The IoHandlerCommand we are looking for

Returns:

TRUE if the IoHandlerCommand is found in the chain

contains

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

Checks if the chain of IoHandlerCommand contains a specific IoHandlerCommand

Parameters:

commandType - The type of IoHandlerCommand we are looking for

Returns:

TRUE if the IoHandlerCommand is found in the chain

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object