Grizzly NIO 5.0.2 · org.glassfish.grizzly.filterchain.FilterChain

This class implement the "Chain of Responsibility" pattern (for more info, take a look at the classic "Gang of Four" design patterns book). Towards that end, the Chain API models a computation as a series of "protocol filter" that can be combined into a "protocol chain".

The API for Filter consists of a two set of methods (handleXXX() and postXXX) which is passed a "protocol context" parameter containing the dynamic state of the computation, and whose return value is a NextAction that instructs FilterChain, how it should continue processing. The owning ProtocolChain must call the postXXX() method of each Filter in a FilterChain in reverse order of the invocation of their handleXXX() methods.

The following picture describe how it Filter(s)


-----------------------------------------------------------------------------
- Filter1.handleXXX() --> Filter2.handleXXX()                    |          -
-                                                                |          -
-                                                                |          -
-                                                                |          -
- Filter1.postXXX() <-- Filter2.postXXX()                        |          -
-----------------------------------------------------------------------------

The "context" abstraction is designed to isolate Filter implementations from the environment in which they are run (such as a Filter that can be used in either IIOP or HTTP parsing, without being tied directly to the API contracts of either of these environments). For Filter that need to allocate resources prior to delegation, and then release them upon return (even if a delegated-to Filter throws an exception), the "postXXX" method can be used for cleanup.

Modifier and Type	Method and Description
public ProcessorResult	Returns: `ProcessorResult` execute(FilterChainContext processing context context) Method processes occurred `IOEvent` on this `FilterChain`.
public void	fail(FilterChainContext context, Throwable failure)
public void	fireEventDownstream(Connection<L> connection, FilterChainEvent event, CompletionHandler<FilterChainContext> completionHandler)
public void	fireEventUpstream(Connection<L> connection, FilterChainEvent event, CompletionHandler<FilterChainContext> completionHandler)
public void	flush(Connection<L> connection, CompletionHandler<WriteResult<K, L>> completionHandler)
public int	Returns: the index of `Filter` in chain, which type is filterType, or `-1` if the `Filter` of required type was not found. indexOfType(final Class<? extends Filter> the type of `Filter` to search. filterType) Get the index of `Filter` in chain, which type is filterType, or `-1` if the `Filter` of required type was not found.
public FilterChainContext	obtainFilterChainContext(Connection<L> connection)
public FilterChainContext	obtainFilterChainContext(Connection<L> connection, Closeable closeable)
public FilterChainContext	obtainFilterChainContext(Connection<L> connection, int startIdx, int endIdx, int currentIdx)
public FilterChainContext	obtainFilterChainContext(Connection<L> connection, Closeable closeable, int startIdx, int endIdx, int currentIdx)
public ReadResult<K, L>	read(FilterChainContext context)

Method Detail

execute back to summary

execute	back to summary
public ProcessorResult execute(FilterChainContext context) Method processes occurred `IOEvent` on this `FilterChain`. Parameters context:FilterChainContext processing context Returns:ProcessorResult `ProcessorResult`

public ProcessorResult execute(FilterChainContext context)

Method processes occurred IOEvent on this FilterChain.

Parameters

context:FilterChainContext: processing context

Returns:ProcessorResult

ProcessorResult

fail	back to summary
public void fail(FilterChainContext context, Throwable failure)

fireEventDownstream	back to summary
public void fireEventDownstream(Connection<L> connection, FilterChainEvent event, CompletionHandler<FilterChainContext> completionHandler)

fireEventUpstream	back to summary
public void fireEventUpstream(Connection<L> connection, FilterChainEvent event, CompletionHandler<FilterChainContext> completionHandler)

flush	back to summary
public void flush(Connection<L> connection, CompletionHandler<WriteResult<K, L>> completionHandler)

indexOfType back to summary

indexOfType	back to summary
public int indexOfType(final Class<? extends Filter> filterType) Get the index of `Filter` in chain, which type is filterType, or `-1` if the `Filter` of required type was not found. Parameters filterType:Class<? extends Filter> the type of `Filter` to search. Returns:int the index of `Filter` in chain, which type is filterType, or `-1` if the `Filter` of required type was not found.

public int indexOfType(final Class<? extends Filter> filterType)

Get the index of Filter in chain, which type is filterType, or -1 if the Filter of required type was not found.

Parameters

filterType:Class<? extends Filter>: the type of Filter to search.

Returns:int

the index of Filter in chain, which type is filterType, or -1 if the Filter of required type was not found.

obtainFilterChainContext	back to summary
public FilterChainContext obtainFilterChainContext(Connection<L> connection)

obtainFilterChainContext	back to summary
public FilterChainContext obtainFilterChainContext(Connection<L> connection, Closeable closeable)

obtainFilterChainContext	back to summary
public FilterChainContext obtainFilterChainContext(Connection<L> connection, int startIdx, int endIdx, int currentIdx)

obtainFilterChainContext	back to summary
public FilterChainContext obtainFilterChainContext(Connection<L> connection, Closeable closeable, int startIdx, int endIdx, int currentIdx)

read	back to summary
public ReadResult<K, L> read(FilterChainContext context) throws IOException

public Interface FilterChain

Method Summary

Method Detail