@ComponentProfile(summary="Interceptor that captures the total number of messages passing through the workflow", tag="interceptor") public class MessageMetricsInterceptor extends MessageMetricsInterceptorImpl
This workflow interceptor captures the total number of messages that passed through this workflow, and captures the size of messages entering the workflow (but not the total size of messages exiting the workflow); and also the number of messages that had an error condition at the end of the workflow.
In the adapter configuration file this class is aliased as message-metrics-interceptor which is the preferred alternative to the fully qualified classname when building your configuration.
MetricsInterceptorImpl.StatisticsDelta<E extends InterceptorStatistic>
WorkflowInterceptorImpl.WorkflowInterceptorException
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
UID_SUFFIX |
DEFAULT_TIMESLICE_HISTORY_COUNT
log
Constructor and Description |
---|
MessageMetricsInterceptor() |
MessageMetricsInterceptor(java.lang.String uid,
TimeInterval timesliceDuration) |
MessageMetricsInterceptor(java.lang.String uid,
TimeInterval timesliceDuration,
java.lang.Integer historyCount) |
Modifier and Type | Method and Description |
---|---|
void |
workflowEnd(AdaptrisMessage inputMsg,
AdaptrisMessage outputMsg)
Mark the end of a workflow.
|
void |
workflowStart(AdaptrisMessage inputMsg)
Mark the start of a workflow.
|
clearStatistics, close, getStatisticManager, getStats, init, setStatisticManager, start, statisticManager, stop, update
getTimesliceDuration, getTimesliceHistoryCount, setTimesliceDuration, setTimesliceHistoryCount, timesliceHistoryCount
changeState, getUniqueId, parentChannel, parentWorkflow, prepare, registerParentChannel, registerParentWorkflow, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setUniqueId, wasSuccessful
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
processingStart
public static final java.lang.String UID_SUFFIX
public MessageMetricsInterceptor()
public MessageMetricsInterceptor(java.lang.String uid, TimeInterval timesliceDuration)
public MessageMetricsInterceptor(java.lang.String uid, TimeInterval timesliceDuration, java.lang.Integer historyCount)
public void workflowStart(AdaptrisMessage inputMsg)
WorkflowInterceptor
inputMsg
- the message that will be processed by this workflow.public void workflowEnd(AdaptrisMessage inputMsg, AdaptrisMessage outputMsg)
WorkflowInterceptor
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 inputMsgoutputMsg
- the message contaning any changes that may have been applied by the services within the workflow.CoreConstants.OBJ_METADATA_EXCEPTION