Package org.glassfish.grizzly.portunif

Class PUFilter

java.lang.Object

org.glassfish.grizzly.filterchain.BaseFilter

org.glassfish.grizzly.portunif.PUFilter

All Implemented Interfaces:

Filter

public class PUFilter
extends BaseFilter

Port unification filter.

Author:

Alexey Stashok

Constructor Summary

Constructors

Constructor	Description
PUFilter()
PUFilter(boolean isCloseUnrecognizedConnection)	Constructs PUFilter.

Method Summary

Modifier and Type	Method	Description
void	deregister(PUProtocol puProtocol)	Deregisters the PUProtocol.
protected void	findProtocol(PUContext puContext, FilterChainContext ctx)
Filter	getBackChannelFilter()	Get the back channel Filter implementation, which should connect the custom protocol FilterChain with the main FilterChain.
Set<PUProtocol>	getProtocols()	Get registered port unification protocols - PUProtocols.
FilterChainBuilder	getPUFilterChainBuilder()	Returns the FilterChainBuilder, developers may use to build there custom protocol filter chain.
NextAction	handleClose(FilterChainContext ctx)	Execute a unit of processing work to be performed, when connection has been closed.
NextAction	handleEvent(FilterChainContext ctx, FilterChainEvent event)	Handle custom event associated with the Connection.
NextAction	handleRead(FilterChainContext ctx)	Execute a unit of processing work to be performed, when channel will become available for reading.
boolean	isCloseUnrecognizedConnection()	Returns true if a Connection whose protocol is not recognized will be automatically closed, or false if normal FilterChain processing will be continued for such Connection, so a Filter next to PUFilter may implement custom logic to process unrecognized connection.
PUProtocol	register(ProtocolFinder protocolFinder, FilterChain filterChain)	Registers new ProtocolFinder - FilterChain pair, which defines the protocol.
void	register(PUProtocol puProtocol)	Registers new PUProtocol.

Methods inherited from class org.glassfish.grizzly.filterchain.BaseFilter

createContext, exceptionOccurred, handleAccept, handleConnect, handleWrite, onAdded, onFilterChainChanged, onRemoved, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PUFilter

public PUFilter()

PUFilter

public PUFilter(boolean isCloseUnrecognizedConnection)

Constructs PUFilter.

Parameters:

isCloseUnrecognizedConnection - true if a Connection whose protocol is not recognized will be automatically closed, or false if normal FilterChain processing will be continued for such Connection, so a Filter next to PUFilter may implement custom logic to process unrecognized connection.

Method Details

register

public PUProtocol register(ProtocolFinder protocolFinder,
 FilterChain filterChain)

Registers new ProtocolFinder - FilterChain pair, which defines the protocol.

Parameters:

protocolFinder - ProtocolFinder

filterChain - FilterChain

Returns:

PUProtocol, which wraps passed ProtocolFinder and FilterChain.

register

public void register(PUProtocol puProtocol)

Registers new PUProtocol.

Parameters:

puProtocol - PUProtocol

deregister

public void deregister(PUProtocol puProtocol)

Deregisters the PUProtocol.

Parameters:

puProtocol - PUProtocol

getProtocols

public Set<PUProtocol> getProtocols()

Get registered port unification protocols - PUProtocols.

Returns:

PUProtocol Set.

getBackChannelFilter

public Filter getBackChannelFilter()

Get the back channel Filter implementation, which should connect the custom protocol FilterChain with the main FilterChain. Usually developers shouldn't use this method, if they build custom protocol chains using getPUFilterChainBuilder(), otherwise they have to make sure there custom protocol FilterChain contains back channel Filter (usually first Filter in the custom protocol filter chain).

Returns:

back channel Filter.

getPUFilterChainBuilder

public FilterChainBuilder getPUFilterChainBuilder()

Returns the FilterChainBuilder, developers may use to build there custom protocol filter chain. The returned FilterChainBuilder may have some Filters pre-added.

Returns:

FilterChainBuilder.

isCloseUnrecognizedConnection

public boolean isCloseUnrecognizedConnection()

Returns true if a Connection whose protocol is not recognized will be automatically closed, or false if normal FilterChain processing will be continued for such Connection, so a Filter next to PUFilter may implement custom logic to process unrecognized connection.

handleRead

public NextAction handleRead(FilterChainContext ctx)
                      throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when channel will become available for reading. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleRead in interface Filter

Overrides:

handleRead in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleEvent

public NextAction handleEvent(FilterChainContext ctx,
 FilterChainEvent event)
                       throws IOException

Description copied from class: BaseFilter

Handle custom event associated with the Connection. This Filter may either complete the required processing and return StopAction, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning InvokeAction.

Specified by:

handleEvent in interface Filter

Overrides:

handleEvent in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleClose

public NextAction handleClose(FilterChainContext ctx)
                       throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when connection has been closed. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleClose in interface Filter

Overrides:

handleClose in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

findProtocol

protected void findProtocol(PUContext puContext,
 FilterChainContext ctx)