Package adams.flow.rest.interceptor.outgoing

Class Enqueue

java.lang.Object

org.apache.cxf.phase.AbstractPhaseInterceptor<org.apache.cxf.message.Message>

adams.flow.rest.interceptor.outgoing.AbstractOutInterceptor

adams.flow.rest.interceptor.outgoing.Enqueue

All Implemented Interfaces:

adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, InterceptorWithActor, org.apache.cxf.interceptor.Interceptor<org.apache.cxf.message.Message>, org.apache.cxf.phase.PhaseInterceptor<org.apache.cxf.message.Message>

public class Enqueue
extends AbstractOutInterceptor
implements InterceptorWithActor

Enqueues a token in the specified queue whenever an outgoing message is intercepted.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.flow.core.Actor	m_Actor	the actor to use for getting access to queues.
protected boolean	m_EnqueueMessage	whether to enqueue the message or just a NullToken.
protected adams.flow.control.StorageName	m_StorageName	the queue to enqueue the token in.

Fields inherited from class adams.flow.rest.interceptor.outgoing.AbstractOutInterceptor

m_Logger, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Enqueue()	Initializes the interceptor.

Method Summary

Modifier and Type	Method	Description
adams.flow.core.Actor	getActor()	Returns the actor in use.
boolean	getEnqueueMessage()	Returns whether to enqueue the whole message or just a NullToken.
adams.flow.control.StorageName	getStorageName()	Returns the queue in use.
void	handleMessage(org.apache.cxf.message.Message message)	Intercepts a message.
protected void	initialize()	Initializes the members.
void	setActor(adams.flow.core.Actor value)	Sets the actor to use.
void	setEnqueueMessage(boolean value)	Sets whether to enqueue the whole message or just a NullToken.
void	setStorageName(adams.flow.control.StorageName value)	Sets the queue to use.

Methods inherited from class adams.flow.rest.interceptor.outgoing.AbstractOutInterceptor

configureLogger, getLogger, getLoggingLevel, initializeLogging, isInfoLoggingEnabled, isLoggingEnabled, setLoggingLevel

Methods inherited from class org.apache.cxf.phase.AbstractPhaseInterceptor

addAfter, addAfter, addBefore, addBefore, getAdditionalInterceptors, getAfter, getBefore, getId, getPhase, handleFault, isGET, isRequestor, setAfter, setBefore

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cxf.interceptor.Interceptor

handleFault

Methods inherited from interface org.apache.cxf.phase.PhaseInterceptor

getAdditionalInterceptors, getAfter, getBefore, getId, getPhase

Field Detail

m_StorageName

protected adams.flow.control.StorageName m_StorageName

the queue to enqueue the token in.

m_EnqueueMessage

protected boolean m_EnqueueMessage

whether to enqueue the message or just a NullToken.

m_Actor

protected adams.flow.core.Actor m_Actor

the actor to use for getting access to queues.

Constructor Detail

Enqueue

public Enqueue()

Initializes the interceptor.

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOutInterceptor

setStorageName

public void setStorageName(adams.flow.control.StorageName value)

Sets the queue to use.

Parameters:

value - the queue

getStorageName

public adams.flow.control.StorageName getStorageName()

Returns the queue in use.

Returns:

the queue

setEnqueueMessage

public void setEnqueueMessage(boolean value)

Sets whether to enqueue the whole message or just a NullToken.

Parameters:

value - true if to enqueue whole message

getEnqueueMessage

public boolean getEnqueueMessage()

Returns whether to enqueue the whole message or just a NullToken.

Returns:

true if to enqueue whole message

setActor

public void setActor(adams.flow.core.Actor value)

Sets the actor to use.

Specified by:

setActor in interface InterceptorWithActor

Parameters:

value - the actor to use

getActor

public adams.flow.core.Actor getActor()

Returns the actor in use.

Specified by:

getActor in interface InterceptorWithActor

Returns:

the actor in use

handleMessage

public void handleMessage(org.apache.cxf.message.Message message)
                   throws org.apache.cxf.interceptor.Fault

Intercepts a message. Interceptors should NOT invoke handleMessage or handleFault on the next interceptor - the interceptor chain will take care of this.

Specified by:

handleMessage in interface org.apache.cxf.interceptor.Interceptor<org.apache.cxf.message.Message>

Parameters:

message -

Throws:

org.apache.cxf.interceptor.Fault