com.adaptris.core.interceptor

Class MessageThresholdNotification

java.lang.Object

com.adaptris.core.interceptor.WorkflowInterceptorImpl

com.adaptris.core.interceptor.NotifyingInterceptor

com.adaptris.core.interceptor.NotifyingInterceptorByCount

com.adaptris.core.interceptor.MessageThresholdNotification

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent, WorkflowInterceptor

@ComponentProfile(summary="Interceptor that issues a JMX notification if a message count threshold is exceeded",
                  tag="interceptor,jmx")
public class MessageThresholdNotification
extends NotifyingInterceptorByCount

Interceptor that emits a Notification if the number of messages has exceeded the specified threshold in the current timeslice.

The Notification.setUserData(Object) part of the notification is a Properties object containing information about the various counts that exceeded the interceptors threshold. Note that notifications are emitted whenever a message is deemed to have exceeded the threshold; so you will get multiple notifications whenever a message causes the threshold to be exceeded until the next time-slice is activated.

Since:

3.0.4

In the adapter configuration file this class is aliased as message-threshold-notification which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.interceptor.WorkflowInterceptorImpl

WorkflowInterceptorImpl.WorkflowInterceptorException

Field Summary

Fields inherited from class com.adaptris.core.interceptor.NotifyingInterceptorByCount

KEY_MESSAGE_COUNT, KEY_MESSAGE_ERROR, KEY_MESSAGE_SIZE, KEY_TIMESLICE_END, KEY_TIMESLICE_START

Fields inherited from class com.adaptris.core.interceptor.WorkflowInterceptorImpl

log

Constructor Summary

Constructors

Constructor and Description
MessageThresholdNotification()
MessageThresholdNotification(java.lang.String uid)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the component.
java.lang.Long	getCountThreshold()
java.lang.Long	getErrorThreshold()
java.lang.Long	getSizeThreshold()
void	init() Initialises the component.
void	setCountThreshold(java.lang.Long l) Set the message count threshold on which notifications will be emitted.
void	setErrorThreshold(java.lang.Long l) Set the message error count threshold on which notifications will be emitted.
void	setSizeThreshold(java.lang.Long l) Set the total message size threshold (in bytes) on which notifications will be emitted.
void	start() Starts the component.
void	stop() Stop the component
void	workflowEnd(AdaptrisMessage inputMsg, AdaptrisMessage outputMsg) Mark the end of a workflow.
void	workflowStart(AdaptrisMessage inputMsg) Mark the start of a workflow.

Methods inherited from class com.adaptris.core.interceptor.NotifyingInterceptorByCount

asProperties, getAndIncrementStatistic, getCurrentTimeSlice, getTimesliceDuration, setTimesliceDuration

Methods inherited from class com.adaptris.core.interceptor.WorkflowInterceptorImpl

changeState, getUniqueId, parentChannel, parentWorkflow, prepare, registerParentChannel, registerParentWorkflow, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setUniqueId, wasSuccessful

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.WorkflowInterceptor

processingStart

Constructor Detail

MessageThresholdNotification

public MessageThresholdNotification()

MessageThresholdNotification

public MessageThresholdNotification(java.lang.String uid)

Method Detail

workflowStart

public void workflowStart(AdaptrisMessage inputMsg)

Description copied from interface: WorkflowInterceptor

Mark the start of a workflow. This doesn't mean the message has started processing but only that the message will - at some point - be processed by the workflow.

Parameters:

inputMsg - the message that will be processed by this workflow.

workflowEnd

public void workflowEnd(AdaptrisMessage inputMsg,
                        AdaptrisMessage outputMsg)

Description copied from interface: WorkflowInterceptor

Mark the end of a workflow.

Parameters:

inputMsg - the original message that was originally submitted to the workflow; in the event of an exception during processing, the exception will be stored in object metadata in the inputMsg

outputMsg - the message contaning any changes that may have been applied by the services within the workflow.

See Also:

CoreConstants.OBJ_METADATA_EXCEPTION

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Throws:

CoreException - wrapping any underlying Exceptions

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

close

public void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

getCountThreshold

public java.lang.Long getCountThreshold()

setCountThreshold

public void setCountThreshold(java.lang.Long l)

Set the message count threshold on which notifications will be emitted.

Parameters:

l - the threshold, defaults to null which means no notification on this metric

getErrorThreshold

public java.lang.Long getErrorThreshold()

setErrorThreshold

public void setErrorThreshold(java.lang.Long l)

Set the message error count threshold on which notifications will be emitted.

Parameters:

l - the threshold, defaults to null which means no notifications on metric.

getSizeThreshold

public java.lang.Long getSizeThreshold()

setSizeThreshold

public void setSizeThreshold(java.lang.Long l)

Set the total message size threshold (in bytes) on which notifications will be emitted.

Parameters:

l - the threshold, defaults to null which means no notifications on metric.