Class CoreConstants
- java.lang.Object
-
- com.adaptris.core.CoreConstants
-
public abstract class CoreConstants extends java.lang.Object
Constants for the
core
package.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CHANNEL_ID_KEY
A channel's id is stored against this key in the logger's Mapped Diagnostic Contextstatic java.lang.String
ENDPOINT_SERVICE_UNIQUE_ID
Constant used by branching services to indicate toBranchingServiceCollection
that an end point has been reached.static java.lang.String
EVENT_CLASS
The metadata key for storing the classname of the event.static java.lang.String
EVENT_NAME_SPACE_KEY
Metadata key for storing the name space of an event when it is converted to anAdaptrisMessage
.static java.lang.String
FILE_LAST_MODIFIED_KEY
Metadata key for storing the last modified date of the consumed file.static java.lang.String
FS_CONSUME_DIRECTORY
Metadata key for storing the directory where a file was consumed from.static java.lang.String
FS_CONSUME_PARENT_DIR
Metadata key for storing the name of the immediate parent directory that a file was consumed from.static java.lang.String
FS_FILE_SIZE
Metadata key for storing the size of the messagestatic java.lang.String
FS_PRODUCE_DIRECTORY
Metadata key for storing the directory where a file was produced to by instances ofFsProducer
static java.lang.String
HTTP_METHOD
Metadata key that contains the http method (GET, POST, PUT etc) when receiving a message viaJettyMessageConsumer
or similar.static java.lang.String
HTTP_PRODUCER_RESPONSE_CODE
Metadata key that contains the last response code from an HTTP Server when usingHttpProducer
or similar.static java.lang.String
HTTP_SESSION_KEY
Metadata key forHttpSession
object metadata.static java.lang.String
KEY_WORKFLOW_SKIP_PRODUCER
Metadata key which if set to 'true' will cause a workflow implementation to skip the produce portion of its processing chain.static java.lang.String
MESSAGE_CONSUME_LOCATION
Metadata key that stores the location where the message was consumed from if available.static java.lang.String
MESSAGE_UNIQUE_ID_KEY
A message's unique ID is stored against this key in various placesstatic java.lang.String
MLE_SEQUENCE_KEY
Metadata key which specifies the next sequence number for aMleMarker
.static java.lang.String
MSG_MIME_ENCODED
Metadata key that indicates that the AdaptrisMessage payload is a Mime Multipart messagestatic java.lang.String
OBJ_METADATA_EXCEPTION
The object metadata key that contains the last captured exception.static java.lang.String
OBJ_METADATA_EXCEPTION_CAUSE
The object metadata key that contains the last component that caused the exception (generally a Service).static java.lang.String
OBJ_METADATA_MESSAGE_FAILED
Object metadata that stores the on success callback.static java.lang.String
OBJ_METADATA_ON_FAILURE_CALLBACK
Object metadata that stores the on failure callback.static java.lang.String
OBJ_METADATA_ON_SUCCESS_CALLBACK
Object metadata that stores the on success callback.static java.lang.String
ORIGINAL_NAME_KEY
Metadata key for storing the original name (generally file name) of a message.static java.lang.String
PARENT_UNIQUE_ID_KEY
Metadata key whichMessageSplitterService
uses to store the unique ID of the original parent message on the split, child message.static java.lang.String
PRODUCED_NAME_KEY
Metadata key for storing the name (generally file name) of a message that has been sent by a Producer.static java.lang.String
RETRY_COUNT_KEY
Metadta key for number of previous retries.static java.lang.String
SECURITY_REMOTE_PARTNER
Metadata key that allows override of the remote partner in security services.static java.lang.String
SECURITY_V1_COMPATIBILITY
Metadata key specifying that security has been encrypted using v1 encryption compability mode.static java.util.function.Function<AdaptrisMessage,java.lang.Boolean>
shouldStopProcessing
A simply function check to test if the processing of the given message should stop.static java.lang.String
STOP_PROCESSING_KEY
Metadata key whichService
implementations should set to indicate that any subsequent configuredService
s should not be applied to a message and that it should not be produced.static java.lang.String
STOP_PROCESSING_VALUE
Metadata value which determines whether or not to stop processing additional services and/or producersstatic java.lang.String
TRANSFORM_OVERRIDE
Metadata key that allows override of the transform services.static java.lang.String
UNIQUE_ID_JMX_PATTERN
Regex pattern for the unique id ofAdaptrisComponent
which are managed by JMX.static java.lang.String
WORKFLOW_ID_KEY
A workflow's id is stored against this key in the logger's Mapped Diagnostic Context
-
Constructor Summary
Constructors Constructor Description CoreConstants()
-
-
-
Field Detail
-
MLE_SEQUENCE_KEY
public static final java.lang.String MLE_SEQUENCE_KEY
Metadata key which specifies the next sequence number for a
MleMarker
.- See Also:
- Constant Field Values
-
STOP_PROCESSING_KEY
public static final java.lang.String STOP_PROCESSING_KEY
Metadata key which
Service
implementations should set to indicate that any subsequent configuredService
s should not be applied to a message and that it should not be produced.- See Also:
- Constant Field Values
-
STOP_PROCESSING_VALUE
public static final java.lang.String STOP_PROCESSING_VALUE
Metadata value which determines whether or not to stop processing additional services and/or producers
-
shouldStopProcessing
public static final java.util.function.Function<AdaptrisMessage,java.lang.Boolean> shouldStopProcessing
A simply function check to test if the processing of the given message should stop.
-
KEY_WORKFLOW_SKIP_PRODUCER
public static final java.lang.String KEY_WORKFLOW_SKIP_PRODUCER
Metadata key which if set to 'true' will cause a workflow implementation to skip the produce portion of its processing chain. This effectively means that workflow sequence is stopped after the service collection (configured interceptors will still be triggered) as the
Workflow.doProduce(AdaptrisMessage)
method invocation is skipped; this behaviour is not guaranteed and is determined by the underlying concreteWorkflow
implementation.The effect of setting this metadata key to 'true' will change the behaviour for standard workflow implementations as follows:
StandardWorkflow
- will cause the producer to be skippedJmsTransactedWorkflow
- will cause the producer to be skipped, but the message will be 'committed' if there have been no failures in the service collectionMultiProducerWorkflow
- will cause the standard producer to be skipped; other configured producers that are available will still be invoked.PoolingWorkflow
- will cause the producer to be skippedLargeMessageWorkflow
- will cause the producer to be skippedRequestReplyWorkflow
- unaffected by this metadata key to ensure that a reply to the triggering application can still be sent
- See Also:
- Constant Field Values
-
CHANNEL_ID_KEY
public static final java.lang.String CHANNEL_ID_KEY
A channel's id is stored against this key in the logger's Mapped Diagnostic Context
- See Also:
- Constant Field Values
-
WORKFLOW_ID_KEY
public static final java.lang.String WORKFLOW_ID_KEY
A workflow's id is stored against this key in the logger's Mapped Diagnostic Context
- See Also:
- Constant Field Values
-
MESSAGE_UNIQUE_ID_KEY
public static final java.lang.String MESSAGE_UNIQUE_ID_KEY
A message's unique ID is stored against this key in various places
- See Also:
- Constant Field Values
-
PARENT_UNIQUE_ID_KEY
public static final java.lang.String PARENT_UNIQUE_ID_KEY
Metadata key which
MessageSplitterService
uses to store the unique ID of the original parent message on the split, child message.- See Also:
- Constant Field Values
-
ENDPOINT_SERVICE_UNIQUE_ID
public static final java.lang.String ENDPOINT_SERVICE_UNIQUE_ID
Constant used by branching services to indicate to
BranchingServiceCollection
that an end point has been reached.- See Also:
- Constant Field Values
-
ORIGINAL_NAME_KEY
public static final java.lang.String ORIGINAL_NAME_KEY
Metadata key for storing the original name (generally file name) of a message.
- See Also:
- Constant Field Values
-
FILE_LAST_MODIFIED_KEY
public static final java.lang.String FILE_LAST_MODIFIED_KEY
Metadata key for storing the last modified date of the consumed file.
- See Also:
- Constant Field Values
-
FS_FILE_SIZE
public static final java.lang.String FS_FILE_SIZE
Metadata key for storing the size of the message
- See Also:
- Constant Field Values
-
PRODUCED_NAME_KEY
public static final java.lang.String PRODUCED_NAME_KEY
Metadata key for storing the name (generally file name) of a message that has been sent by a Producer.
- See Also:
- Constant Field Values
-
EVENT_NAME_SPACE_KEY
public static final java.lang.String EVENT_NAME_SPACE_KEY
Metadata key for storing the name space of an event when it is converted to an
AdaptrisMessage
. NB this is not used when converting back this allows the name space to be used as its destination.- See Also:
- Constant Field Values
-
EVENT_CLASS
public static final java.lang.String EVENT_CLASS
The metadata key for storing the classname of the event.It is generally unused, however, it is helpful to have this when unmarshalling the events.
- See Also:
- Constant Field Values
-
HTTP_SESSION_KEY
public static final java.lang.String HTTP_SESSION_KEY
Metadata key forHttpSession
object metadata.- See Also:
- Constant Field Values
-
HTTP_METHOD
public static final java.lang.String HTTP_METHOD
Metadata key that contains the http method (GET, POST, PUT etc) when receiving a message viaJettyMessageConsumer
or similar.- See Also:
- Constant Field Values
-
RETRY_COUNT_KEY
public static final java.lang.String RETRY_COUNT_KEY
Metadta key for number of previous retries.
- See Also:
- Constant Field Values
-
SECURITY_V1_COMPATIBILITY
public static final java.lang.String SECURITY_V1_COMPATIBILITY
Metadata key specifying that security has been encrypted using v1 encryption compability mode.- See Also:
- Constant Field Values
-
TRANSFORM_OVERRIDE
public static final java.lang.String TRANSFORM_OVERRIDE
Metadata key that allows override of the transform services.- See Also:
- Constant Field Values
-
SECURITY_REMOTE_PARTNER
public static final java.lang.String SECURITY_REMOTE_PARTNER
Metadata key that allows override of the remote partner in security services.- See Also:
- Constant Field Values
-
MSG_MIME_ENCODED
public static final java.lang.String MSG_MIME_ENCODED
Metadata key that indicates that the AdaptrisMessage payload is a Mime Multipart message- See Also:
- Constant Field Values
-
OBJ_METADATA_EXCEPTION
public static final java.lang.String OBJ_METADATA_EXCEPTION
The object metadata key that contains the last captured exception.
-
OBJ_METADATA_EXCEPTION_CAUSE
public static final java.lang.String OBJ_METADATA_EXCEPTION_CAUSE
The object metadata key that contains the last component that caused the exception (generally a Service).
-
HTTP_PRODUCER_RESPONSE_CODE
public static final java.lang.String HTTP_PRODUCER_RESPONSE_CODE
Metadata key that contains the last response code from an HTTP Server when usingHttpProducer
or similar.- See Also:
- Constant Field Values
-
FS_CONSUME_DIRECTORY
public static final java.lang.String FS_CONSUME_DIRECTORY
Metadata key for storing the directory where a file was consumed from.
- See Also:
- Constant Field Values
-
FS_CONSUME_PARENT_DIR
public static final java.lang.String FS_CONSUME_PARENT_DIR
Metadata key for storing the name of the immediate parent directory that a file was consumed from.
- See Also:
- Constant Field Values
-
FS_PRODUCE_DIRECTORY
public static final java.lang.String FS_PRODUCE_DIRECTORY
Metadata key for storing the directory where a file was produced to by instances of
FsProducer
- See Also:
- Constant Field Values
-
UNIQUE_ID_JMX_PATTERN
public static final java.lang.String UNIQUE_ID_JMX_PATTERN
Regex pattern for the unique id of
AdaptrisComponent
which are managed by JMX. This prevent to use reserved characters in the unique id. '@' has been added to prevent issues when a workflow and channel uid are added together like workflowUid@ChannelUid.- See Also:
- Constant Field Values
-
MESSAGE_CONSUME_LOCATION
public static final java.lang.String MESSAGE_CONSUME_LOCATION
Metadata key that stores the location where the message was consumed from if available.This will have different meanings based on the consumer; for JMS consumers it might be
Message.getJMSDestination()
; for a file system consumer, it will be the directory from which it was consumed from.Note that this metadata key may not always be populated and is reliant on the
AdaptrisMessageConsumer.consumeLocationKey()
returning a non-null value.- Since:
- 3.9.0
- See Also:
- Constant Field Values
-
OBJ_METADATA_MESSAGE_FAILED
public static final java.lang.String OBJ_METADATA_MESSAGE_FAILED
Object metadata that stores the on success callback.
-
OBJ_METADATA_ON_SUCCESS_CALLBACK
public static final java.lang.String OBJ_METADATA_ON_SUCCESS_CALLBACK
Object metadata that stores the on success callback.
-
OBJ_METADATA_ON_FAILURE_CALLBACK
public static final java.lang.String OBJ_METADATA_ON_FAILURE_CALLBACK
Object metadata that stores the on failure callback.
-
-