flex.messaging.endpoints.amf
Class SuspendableAMFFilter

java.lang.Object
  flex.messaging.endpoints.amf.SuspendableAMFFilter

Direct Known Subclasses:

SuspendableBatchProcessFilter, SuspendableLegacyFilter, SuspendableMessageBrokerFilter, SuspendableSerializationFilter

public abstract class SuspendableAMFFilter
extends Object

Base class for suspendable AMF filter implementations. This class performs no internal synchronization.

Field Summary

static int	DIRECTION_INBOUND Indicates a filter is in its inbound processing state.
static int	DIRECTION_OUTBOUND Indicates a filter is in its outbound processing state.

Constructor Summary

SuspendableAMFFilter()
Constructs a SuspendableAMFFilter.

Method Summary

static SuspendableAMFFilter	buildChain(SuspendableAMFFilter[] members) Utility method that takes an array of filters and connects them into a chain, preserving their relative ordering.
ActionContext	getContext() Returns the ActionContext for the chain.
int	getDirection() Returns the current processing direction for the chain.
SuspendableAMFFilter	getNext() Returns the filter that follows this filter in a chain.
SuspendableAMFFilter	getPrevious() Returns the filter that precedes this filter in a chain.
SuspendableAMFFilter	getSuspendedFilter() Returns the specific filter within a chain that has been suspended and may be resumed.
void	invoke(ActionContext context) Invokes the chain.
boolean	isInboundAborted() Returns true if inbound processing for the chain has been aborted.
boolean	isSuspended() Returns true if the chain this filter belongs to is suspended.
void	resume() Resumes the execution of a suspended chain.
void	setContext(ActionContext value) Sets the ActionContext for the chain.
void	setDirection(int value) Sets the current processing direction for the chain.
void	setInboundAborted(boolean value) Flags inbound processing as aborted.
void	setNext(SuspendableAMFFilter value) Assigns a filter to follow this filter in a chain.
void	setPrevious(SuspendableAMFFilter value) Assigns a filter to precede this filter in a chain.
void	setSuspendedFilter(SuspendableAMFFilter value) Assigns a reference to the specific filter in the chain that is currently suspended.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIRECTION_INBOUND

public static final int DIRECTION_INBOUND

Indicates a filter is in its inbound processing state.

See Also:

SuspendableAMFFilter.getDirection(), Constant Field Values

DIRECTION_OUTBOUND

public static final int DIRECTION_OUTBOUND

Indicates a filter is in its outbound processing state.

See Also:

SuspendableAMFFilter.getDirection(), Constant Field Values

Constructor Detail

SuspendableAMFFilter

public SuspendableAMFFilter()

Constructs a SuspendableAMFFilter.

Method Detail

buildChain

public static SuspendableAMFFilter buildChain(SuspendableAMFFilter[] members)

Utility method that takes an array of filters and connects them into a chain, preserving their relative ordering.

Parameters:

members - The individual filters for the chain in their desired order.

Returns:

The first filter in the chain.

isInboundAborted

public boolean isInboundAborted()

Returns true if inbound processing for the chain has been aborted.

setInboundAborted

public void setInboundAborted(boolean value)

Flags inbound processing as aborted. Alternately, re-enables inbound processing.

getContext

public ActionContext getContext()

Returns the ActionContext for the chain.

setContext

public void setContext(ActionContext value)

Sets the ActionContext for the chain.

getDirection

public int getDirection()

Returns the current processing direction for the chain.

See Also:

SuspendableAMFFilter.DIRECTION_INBOUND, SuspendableAMFFilter.DIRECTION_OUTBOUND

setDirection

public void setDirection(int value)

Sets the current processing direction for the chain.

See Also:

SuspendableAMFFilter.DIRECTION_INBOUND, SuspendableAMFFilter.DIRECTION_OUTBOUND

getNext

public SuspendableAMFFilter getNext()

Returns the filter that follows this filter in a chain.

setNext

public void setNext(SuspendableAMFFilter value)

Assigns a filter to follow this filter in a chain.

getPrevious

public SuspendableAMFFilter getPrevious()

Returns the filter that precedes this filter in a chain.

setPrevious

public void setPrevious(SuspendableAMFFilter value)

Assigns a filter to precede this filter in a chain.

isSuspended

public boolean isSuspended()

Returns true if the chain this filter belongs to is suspended.

getSuspendedFilter

public SuspendableAMFFilter getSuspendedFilter()

Returns the specific filter within a chain that has been suspended and may be resumed.

setSuspendedFilter

public void setSuspendedFilter(SuspendableAMFFilter value)

Assigns a reference to the specific filter in the chain that is currently suspended.

invoke

public void invoke(ActionContext context)
            throws IOException

Invokes the chain.

Throws:

IllegalStateException - If the chain is suspended; use resume() to resume a suspended chain's invocation.

IOException

resume

public void resume()
            throws IOException

Resumes the execution of a suspended chain.

Throws:

IllegalStateException - If the chain is not suspended; use invoke(ActionContext) to execute an unsuspended chain.

IOException