com.vordel.circuit

Class MessageProcessor

java.lang.Object

com.vordel.circuit.FilterContainerImpl

com.vordel.circuit.MessageProcessor

All Implemented Interfaces:

FilterContainer

Direct Known Subclasses:

CircuitActivationProcessor, CircuitDelegateProcessor, DelegatingProcessor, HTTPBodyParserProcessor

public abstract class MessageProcessor
extends FilterContainerImpl

A FilterContainer that is used to implement the underlying processing functionality of a Filter.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	logMask
protected java.lang.String	logMaskType

Constructor Summary

Constructors

Constructor and Description
MessageProcessor()

Method Summary

Modifier and Type	Method and Description
void	filterAttached(ConfigContext ctx, Entity entity) Called on a filter's container when the filter is configured.
void	filterDetached()
java.lang.String	getCategory() Get the category of this processor
java.lang.String	getFilterMessage(Message message, int resultType)
int	getLogMask(Message m)
abstract boolean	invoke(Circuit c, Message m) invoked by circuit to act on a message
void	logFailure(Message m, java.lang.String circuitName) Default action for failure logging event
void	logFatal(Message m, java.lang.String circuitName) Default action for fatal logging event
void	logMessagePayload(Message m, java.lang.String circuitName, com.vordel.log.LogFormatter formatter) Default action for a payload logging event
void	logSuccess(Message m, java.lang.String circuitName) Default action for a successful logging event
protected void	report(java.lang.String msg)
protected void	report(java.lang.String msg, java.lang.Throwable t)
java.lang.String	toString()

Methods inherited from class com.vordel.circuit.FilterContainerImpl

configureFilter, createFilterContainer, getFilter, setFilter

Methods inherited from class java.lang.Object

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

Field Detail

logMask

protected int logMask

logMaskType

protected java.lang.String logMaskType

Constructor Detail

MessageProcessor

public MessageProcessor()

Method Detail

filterAttached

public void filterAttached(ConfigContext ctx,
                           Entity entity)
                    throws EntityStoreException

Description copied from class: FilterContainerImpl

Called on a filter's container when the filter is configured. Any domain-specific initialisation of the filter container can be done at this point. This will be called at least once when the filter attaches.

Overrides:

filterAttached in class FilterContainerImpl

Parameters:

ctx - configuration context for the filter attached to this container.

entity - The Entity containing this specific Filter's configuration.

Throws:

EntityStoreException

filterDetached

public void filterDetached()

Overrides:

filterDetached in class FilterContainerImpl

invoke

public abstract boolean invoke(Circuit c,
                               Message m)
                        throws CircuitAbortException

invoked by circuit to act on a message

Parameters:

c - The Circuit context

m - The message

Returns:

predicate indicating success of filter execution

Throws:

CircuitAbortException - If there's an unexpected failure when evaluating the MessageProcessor

getCategory

public java.lang.String getCategory()

Get the category of this processor

Returns:

The category

logFatal

public void logFatal(Message m,
                     java.lang.String circuitName)
              throws CircuitAbortException

Default action for fatal logging event

Parameters:

m - The Message context.

circuitName - The name of the circuit for which this logging event was invoked.

Throws:

CircuitAbortException - If there's a problem logging the message.

logFailure

public void logFailure(Message m,
                       java.lang.String circuitName)
                throws CircuitAbortException

Default action for failure logging event

Parameters:

m - The Message context.

circuitName - The name of the circuit for which this logging event was invoked.

Throws:

CircuitAbortException - If there's a problem logging the message.

logSuccess

public void logSuccess(Message m,
                       java.lang.String circuitName)
                throws CircuitAbortException

Default action for a successful logging event

Parameters:

m - The Message context.

circuitName - The name of the circuit for which this logging event was invoked.

Throws:

CircuitAbortException - If there's a problem logging the message.

logMessagePayload

public void logMessagePayload(Message m,
                              java.lang.String circuitName,
                              com.vordel.log.LogFormatter formatter)
                       throws java.io.IOException,
                              com.vordel.log.LoggingException

Default action for a payload logging event

Parameters:

m - The Message context.

circuitName - The name of the circuit for which this logging event was invoked.

formatter - How to format the logged message.

Throws:

java.io.IOException - If there's a general problem logging the payload.

com.vordel.log.LoggingException - If there's a Logging-specific problem when logging the payload.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

report

protected final void report(java.lang.String msg,
                            java.lang.Throwable t)

report

protected final void report(java.lang.String msg)

getLogMask

public int getLogMask(Message m)

getFilterMessage

public java.lang.String getFilterMessage(Message message,
                                         int resultType)