Module org.glassfish.grizzly

Package org.glassfish.grizzly.filterchain

Class FilterChainContext

java.lang.Object

org.glassfish.grizzly.filterchain.FilterChainContext

All Implemented Interfaces:

AttributeStorage

public class FilterChainContext
extends Object
implements AttributeStorage

FilterChain Context implementation.

Author:

Alexey Stashok

See Also:

• Context
• FilterChain

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterChainContext.CompletionListener	The interface, which represents a listener, which will be notified, once FilterChainContext processing is complete.
static interface	FilterChainContext.CopyListener	The interface, which represents a listener, which will be notified, after copy() is called.
static enum	FilterChainContext.Operation
static enum	FilterChainContext.State
static final class	FilterChainContext.TransportContext

Field Summary

Fields

Modifier and Type	Field	Description
protected FilterChainEvent	event	Context associated event, if EVENT operation
static final int	NO_FILTER_INDEX
protected CompletionHandler<FilterChainContext>	operationCompletionHandler	CompletionHandler, which will be notified, when operation will be complete.

Constructor Summary

Constructors

Constructor	Description
FilterChainContext()

Method Summary

Modifier and Type	Method	Description
final void	addCompletionListener(FilterChainContext.CompletionListener listener)	Add the FilterChainContext.CompletionListener, which will be notified, when this FilterChainContext processing will be completed.
final void	addCopyListener(FilterChainContext.CopyListener listener)	Add the FilterChainContext.CopyListener, which will be notified, right after this copy() is called.
void	completeAndRecycle()
void	completeAndRelease()
FilterChainContext	copy()
static FilterChainContext	create(Connection connection)
static FilterChainContext	create(Connection connection, Closeable closeable)
void	fail(Throwable error)
void	flush(CompletionHandler completionHandler)
void	fork()	This method invocation suggests the FilterChain to create a copy of this FilterChainContext and resume/fork its execution starting from the current Filter.
void	fork(NextAction nextAction)	This method invocation suggests the FilterChain to create a copy of this FilterChainContext and resume/fork its execution starting from the current Filter.
Object	getAddress()	Get address, associated with the current IOEvent processing.
Holder<?>	getAddressHolder()	Get a Holder, which contains address, associated with the current IOEvent processing.
AttributeHolder	getAttributes()	Get associated AttributeHolder.
Closeable	getCloseable()	Get the Closeable, associated with the current processing.
Connection	getConnection()	Get the Connection, associated with the current processing.
int	getEndIdx()
FilterChain	getFilterChain()	Get FilterChain, which runs the Filter.
int	getFilterIdx()
NextAction	getForkAction()
NextAction	getForkAction(NextAction nextAction)
final Context	getInternalContext()	Get the general Grizzly Context this filter context wraps.
NextAction	getInvokeAction()	Get NextAction implementation, which instructs FilterChain to process next Filter in chain.
<E> NextAction	getInvokeAction(E incompleteChunk, Appender<E> appender)	Get NextAction implementation, which instructs FilterChain to process next Filter in chain.
NextAction	getInvokeAction(Object unparsedChunk)	Get NextAction implementation, which instructs FilterChain to process next Filter in chain.
final MemoryManager	getMemoryManager()	A simple alias for FilterChainContext.getConnection().getMemoryManager().
<T> T	getMessage()	Get message object, associated with the current processing.
NextAction	getRerunFilterAction()	Get NextAction, which instructs FilterChain to rerun the filter.
protected final Runnable	getRunnable()
int	getStartIdx()
NextAction	getStopAction()	Get NextAction implementation, which instructs FilterChain to stop executing phase.
<E> NextAction	getStopAction(E incompleteChunk, Appender<E> appender)	Get NextAction implementation, which instructs FilterChain stop executing phase.
NextAction	getStopAction(Object incompleteChunk)	Get NextAction implementation, which instructs FilterChain stop executing phase.
NextAction	getSuspendAction()	Get NextAction, which instructs FilterChain to suspend filter chain execution.
NextAction	getSuspendingStopAction()	Deprecated. use getForkAction()
FilterChainContext.TransportContext	getTransportContext()	Get the TransportFilter related context.
int	nextFilterIdx()
void	notifyDownstream(FilterChainEvent event)
void	notifyDownstream(FilterChainEvent event, CompletionHandler<FilterChainContext> completionHandler)
void	notifyUpstream(FilterChainEvent event)
void	notifyUpstream(FilterChainEvent event, CompletionHandler<FilterChainContext> completionHandler)
int	previousFilterIdx()
ReadResult	read()	Performs a blocking read.
final boolean	removeCompletionListener(FilterChainContext.CompletionListener listener)	Remove the FilterChainContext.CompletionListener.
final boolean	removeCopyListener(FilterChainContext.CopyListener listener)	Remove the FilterChainContext.CopyListener.
void	reset()	Release the context associated resources.
void	resume()	Resume processing of the current task
void	resume(NextAction nextAction)	Resume the current FilterChain task processing by completing the current Filter (the Filter, which suspended the processing) with the passed NextAction.
void	resumeNext()	Resume processing of the current task starting from the Filter, which follows the Filter, which suspend the processing.
void	setAddress(Object address)	Set address, associated with the current IOEvent processing.
void	setAddressHolder(Holder<?> addressHolder)	Set address, associated with the current IOEvent processing.
void	setEndIdx(int endIdx)
void	setFilterIdx(int index)
void	setMessage(Object message)	Set message object, associated with the current processing.
void	setStartIdx(int startIdx)
FilterChainContext.State	state()	Get the current processing task state.
Runnable	suspend()	Suspend processing of the current task
String	toString()
void	write(Object message)
void	write(Object message, boolean blocking)
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler)
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler, boolean blocking)
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler, MessageCloner cloner)
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler, MessageCloner cloner, boolean blocking)
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler, PushBackHandler pushBackHandler)	Deprecated.
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler, PushBackHandler pushBackHandler, boolean blocking)	Deprecated.
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler, PushBackHandler pushBackHandler, MessageCloner cloner)	Deprecated.
void	write(Object address, Object message, CompletionHandler<WriteResult> completionHandler, PushBackHandler pushBackHandler, MessageCloner cloner, boolean blocking)	Deprecated.
void	write(Object message, CompletionHandler<WriteResult> completionHandler)
void	write(Object message, CompletionHandler<WriteResult> completionHandler, boolean blocking)

Methods inherited from class java.lang.Object

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

Field Details

NO_FILTER_INDEX

public static final int NO_FILTER_INDEX

See Also:

• Constant Field Values

operationCompletionHandler

protected CompletionHandler<FilterChainContext> operationCompletionHandler

CompletionHandler, which will be notified, when operation will be complete. For WRITE it means the data will be written on wire, for other operations - the last Filter has finished the processing.

event

protected FilterChainEvent event

Context associated event, if EVENT operation

Constructor Details

FilterChainContext

public FilterChainContext()

Method Details

create

public static FilterChainContext create(Connection connection)

create

public static FilterChainContext create(Connection connection,
 Closeable closeable)

suspend

public Runnable suspend()

Suspend processing of the current task

resume

public void resume()

Resume processing of the current task

resumeNext

public void resumeNext()

Resume processing of the current task starting from the Filter, which follows the Filter, which suspend the processing.

resume

public void resume(NextAction nextAction)

Resume the current FilterChain task processing by completing the current Filter (the Filter, which suspended the processing) with the passed NextAction.

Parameters:

nextAction - the NextAction, based on which FilterChain will continue processing.

fork

public void fork()

This method invocation suggests the FilterChain to create a copy of this FilterChainContext and resume/fork its execution starting from the current Filter.

fork

public void fork(NextAction nextAction)

This method invocation suggests the FilterChain to create a copy of this FilterChainContext and resume/fork its execution starting from the current Filter.

If nextAction parameter is not null - then its value is treated as a result of the current Filter execution on the forked FilterChain processing. So during the forked FilterChain processing the current Filter will not be invoked, but the processing will be continued as if the current Filter returned nextAction as a result. For example if we call fork(ctx.getInvokeAction()); the forked FilterChain processing will start with the next Filter in chain.

state

public FilterChainContext.State state()

Get the current processing task state.

Returns:

the current processing task state.

nextFilterIdx

public int nextFilterIdx()

previousFilterIdx

public int previousFilterIdx()

getFilterIdx

public int getFilterIdx()

setFilterIdx

public void setFilterIdx(int index)

getStartIdx

public int getStartIdx()

setStartIdx

public void setStartIdx(int startIdx)

getEndIdx

public int getEndIdx()

setEndIdx

public void setEndIdx(int endIdx)

getFilterChain

public FilterChain getFilterChain()

Get FilterChain, which runs the Filter.

Returns:

FilterChain, which runs the Filter.

getConnection

public Connection getConnection()

Get the Connection, associated with the current processing.

Returns:

Connection object, associated with the current processing.

getCloseable

public Closeable getCloseable()

Get the Closeable, associated with the current processing. The Closeable object might be used to close/terminate an entity associated with the FilterChain processing in response to an error occurred during the processing. If not customized the Closeable object represents a Connection associated with the FilterChain processing.

Returns:

Closeable object, associated with the current processing.

getMessage

public <T> T getMessage()

Get message object, associated with the current processing. Usually FilterChain represents sequence of parser and process Filters. Each parser can change the message representation until it will come to processor Filter.

Returns:

message object, associated with the current processing.

setMessage

public void setMessage(Object message)

Set message object, associated with the current processing. Usually FilterChain represents sequence of parser and process Filters. Each parser can change the message representation until it will come to processor Filter.

Parameters:

message - message object, associated with the current processing.

getAddressHolder

public Holder<?> getAddressHolder()

Get a Holder, which contains address, associated with the current IOEvent processing. When we process IOEvent.READ event - it represents sender address, or when process IOEvent.WRITE - address of receiver.

Returns:

Holder, which contains address, associated with the current IOEvent processing.

setAddressHolder

public void setAddressHolder(Holder<?> addressHolder)

Set address, associated with the current IOEvent processing. When we process IOEvent.READ event - it represents sender address, or when process IOEvent.WRITE - address of receiver.

Parameters:

addressHolder - Holder, which contains address, associated with the current IOEvent processing.

getAddress

public Object getAddress()

Get address, associated with the current IOEvent processing. When we process IOEvent.READ event - it represents sender address, or when process IOEvent.WRITE - address of receiver.

Returns:

address, associated with the current IOEvent processing.

setAddress

public void setAddress(Object address)

Set address, associated with the current IOEvent processing. When we process IOEvent.READ event - it represents sender address, or when process IOEvent.WRITE - address of receiver.

Parameters:

address - address, associated with the current IOEvent processing.

getRunnable

protected final Runnable getRunnable()

getTransportContext

public FilterChainContext.TransportContext getTransportContext()

Get the TransportFilter related context.

Returns:

TransportFilter.

getInternalContext

public final Context getInternalContext()

Get the general Grizzly Context this filter context wraps.

Returns:

the general Grizzly Context this filter context wraps.

getInvokeAction

public NextAction getInvokeAction()

Get NextAction implementation, which instructs FilterChain to process next Filter in chain. Normally, after receiving this instruction from Filter, FilterChain executes next filter.

Returns:

NextAction implementation, which instructs FilterChain to process next Filter in chain.

getInvokeAction

public NextAction getInvokeAction(Object unparsedChunk)

Get NextAction implementation, which instructs FilterChain to process next Filter in chain. Normally, after receiving this instruction from Filter, FilterChain executes next filter.

Parameters:

unparsedChunk - signals, that there is some unparsed data remaining in the source message, so FilterChain could be rerun.

Returns:

NextAction implementation, which instructs FilterChain to process next Filter in chain.

getInvokeAction

public <E> NextAction getInvokeAction(E incompleteChunk,
 Appender<E> appender)

Get NextAction implementation, which instructs FilterChain to process next Filter in chain. Normally, after receiving this instruction from Filter, FilterChain executes next filter.

Parameters:

incompleteChunk - signals, that there is a data chunk remaining, which doesn't represent complete message. As more data becomes available but before FilterChain calls the current Filter, it will check if the Filter has any data stored after the last invocation. If a remainder is present it will append the new data to the stored one and pass the result as the FilterChainContext message.

appender - the Appender, which knows how to append chunks of type <E>.

Returns:

NextAction implementation, which instructs FilterChain to process next Filter in chain.

Throws:

IllegalArgumentException - if appender is null and remainder's type is not Buffer or Appendable.

getStopAction

public NextAction getStopAction()

Get NextAction implementation, which instructs FilterChain to stop executing phase.

Returns:

NextAction implementation, which instructs FilterChain to stop executing phase.

getStopAction

public NextAction getStopAction(Object incompleteChunk)

Get NextAction implementation, which instructs FilterChain stop executing phase.

Parameters:

incompleteChunk - signals, that there is a data chunk remaining, which doesn't represent complete message. As more data becomes available but before FilterChain calls the current Filter, it will check if the Filter has any data stored after the last invocation. If a remainder is present it will append the new data to the stored one and pass the result as the FilterChainContext message.

Returns:

NextAction implementation, which instructs FilterChain to stop executing phase.

Throws:

IllegalArgumentException - if remainder's type is not Buffer or Appendable.

getStopAction

public <E> NextAction getStopAction(E incompleteChunk,
 Appender<E> appender)

Get NextAction implementation, which instructs FilterChain stop executing phase.

Parameters:

incompleteChunk - signals, that there is a data chunk remaining, which doesn't represent complete message. As more data becomes available but before FilterChain calls the current Filter, it will check if the Filter has any data stored after the last invocation. If a remainder is present it will append the new data to the stored one and pass the result as the FilterChainContext message.

appender - the Appender, which knows how to append chunks of type <E>.

Returns:

NextAction implementation, which instructs FilterChain to stop executing phase.

Throws:

IllegalArgumentException - if appender is null and remainder's type is not Buffer or Appendable.

getForkAction

public NextAction getForkAction()

Returns:

NextAction implementation, which suggests the FilterChain to forget about the current FilterChainContext, create a copy of it and continue/fork FilterChain processing using the copied FilterChainContext starting from the current Filter.

getForkAction

public NextAction getForkAction(NextAction nextAction)

Returns:

NextAction implementation, which suggests the FilterChain to forget about the current FilterChainContext, create a copy of it and continue/fork FilterChain processing using the copied FilterChainContext starting from the current Filter.

If nextAction parameter is not null - then its value is treated as a result of the current Filter execution on the forked FilterChain processing. So during the forked FilterChain processing the current Filter will not be invoked, but the processing will be continued as if the current Filter returned nextAction as a result. For example if we call fork(ctx.getInvokeAction()); the forked FilterChain processing will start with the next Filter in chain.

getSuspendingStopAction

@Deprecated
public NextAction getSuspendingStopAction()

Deprecated.

use getForkAction()

Returns:

NextAction implementation, which instructs the FilterChain to suspend the current FilterChainContext and invoke similar logic as instructed by StopAction with a clean FilterChainContext.

getSuspendAction

public NextAction getSuspendAction()

Get NextAction, which instructs FilterChain to suspend filter chain execution.

Returns:

NextAction, which instructs FilterChain to suspend filter chain execution.

getRerunFilterAction

public NextAction getRerunFilterAction()

Get NextAction, which instructs FilterChain to rerun the filter.

Returns:

NextAction, which instructs FilterChain to rerun the filter.

read

public ReadResult read()
                throws IOException

Performs a blocking read.

Returns:

the result of the read operation.

Throws:

IOException - if an I/O error occurs.

write

public void write(Object message)

write

public void write(Object message,
 boolean blocking)

write

public void write(Object message,
 CompletionHandler<WriteResult> completionHandler)

write

public void write(Object message,
 CompletionHandler<WriteResult> completionHandler,
 boolean blocking)

write

public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler)

write

public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler,
 boolean blocking)

write

@Deprecated
public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler,
 PushBackHandler pushBackHandler)

Deprecated.

write

@Deprecated
public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler,
 PushBackHandler pushBackHandler,
 boolean blocking)

Deprecated.

write

public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler,
 MessageCloner cloner)

write

@Deprecated
public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler,
 PushBackHandler pushBackHandler,
 MessageCloner cloner)

Deprecated.

write

public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler,
 MessageCloner cloner,
 boolean blocking)

write

@Deprecated
public void write(Object address,
 Object message,
 CompletionHandler<WriteResult> completionHandler,
 PushBackHandler pushBackHandler,
 MessageCloner cloner,
 boolean blocking)

Deprecated.

flush

public void flush(CompletionHandler completionHandler)

notifyUpstream

public void notifyUpstream(FilterChainEvent event)

notifyUpstream

public void notifyUpstream(FilterChainEvent event,
 CompletionHandler<FilterChainContext> completionHandler)

notifyDownstream

public void notifyDownstream(FilterChainEvent event)

notifyDownstream

public void notifyDownstream(FilterChainEvent event,
 CompletionHandler<FilterChainContext> completionHandler)

fail

public void fail(Throwable error)

getAttributes

public AttributeHolder getAttributes()

Get associated AttributeHolder. Implementation may return null if AttributeHolder wasn't initialized yet.

Specified by:

getAttributes in interface AttributeStorage

Returns:

associated AttributeHolder. Implementation may return null if AttributeHolder wasn't initialized yet.

addCompletionListener

public final void addCompletionListener(FilterChainContext.CompletionListener listener)

Add the FilterChainContext.CompletionListener, which will be notified, when this FilterChainContext processing will be completed.

Parameters:

listener - the FilterChainContext.CompletionListener, which will be notified, when this FilterChainContext processing will be completed.

removeCompletionListener

public final boolean removeCompletionListener(FilterChainContext.CompletionListener listener)

Remove the FilterChainContext.CompletionListener.

Parameters:

listener - the FilterChainContext.CompletionListener to be removed.

Returns:

true, if the listener was removed from the list, or false, if the listener wasn't on the list.

addCopyListener

public final void addCopyListener(FilterChainContext.CopyListener listener)

Add the FilterChainContext.CopyListener, which will be notified, right after this copy() is called.

Parameters:

listener - the FilterChainContext.CopyListener, which will be notified, right after this copy() is called.

removeCopyListener

public final boolean removeCopyListener(FilterChainContext.CopyListener listener)

Remove the FilterChainContext.CopyListener.

Parameters:

listener - the FilterChainContext.CopyListener to be removed.

Returns:

true, if the listener was removed from the list, or false, if the listener wasn't on the list.

getMemoryManager

public final MemoryManager getMemoryManager()

A simple alias for FilterChainContext.getConnection().getMemoryManager().

Returns:

the MemoryManager associated with the Connection of this FilterChainContext.

copy

public FilterChainContext copy()

reset

public void reset()

Release the context associated resources.

completeAndRecycle

public void completeAndRecycle()

completeAndRelease

public void completeAndRelease()

toString

public String toString()

Overrides:

toString in class Object