CoreConstants (Base Interlok)

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 and Description
`static java.lang.String`	`CHANNEL_ID_KEY` A channel's id is stored against this key in the logger's Mapped Diagnostic Context
`static java.lang.String`	`EMAIL_ATTACH_CONTENT_TYPE` Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
`static java.lang.String`	`EMAIL_ATTACH_FILENAME` Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
`static java.lang.String`	`EMAIL_CC_LIST` Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
`static java.lang.String`	`EMAIL_MESSAGE_ID` Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
`static java.lang.String`	`EMAIL_SUBJECT` Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
`static java.lang.String`	`EMAIL_TEMPLATE_BODY` Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
`static java.lang.String`	`EMAIL_TOTAL_ATTACHMENTS` Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
`static java.lang.String`	`ENDPOINT_SERVICE_UNIQUE_ID` Constant used by branching services to indicate to `BranchingServiceCollection` 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 an `AdaptrisMessage`.
`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 message
`static java.lang.String`	`FS_PRODUCE_DIRECTORY` Metadata key for storing the directory where a file was produced to by instances of `FsProducer`
`static java.lang.String`	`FTP_REPLYTO_NAME` Metadata key for the FTP reply to name override.
`static java.lang.String`	`HTTP_METHOD` Metadata key that contains the http method (GET, POST, PUT etc) when receiving a message via `JettyMessageConsumer` or similar.
`static java.lang.String`	`HTTP_PRODUCER_RESPONSE_CODE` Metadata key that contains the last response code from an HTTP Server when using `HttpProducer` or similar.
`static java.lang.String`	`HTTP_SESSION_KEY` Metadata key for `HttpSession` object metadata.
`static java.lang.String`	`JCO_IDOCTYP` Deprecated. since 3.9.0 check the optional SAP package for the appropriate value.
`static java.lang.String`	`JETTY_QUERY_STRING` Deprecated. since 3.8.0 use `JettyConstants.JETTY_QUERY_STRING` instead
`static java.lang.String`	`JETTY_URI` Deprecated. since 3.8.0 use `JettyConstants.JETTY_URI` instead
`static java.lang.String`	`JETTY_URL` Deprecated. since 3.8.0 use `JettyConstants.JETTY_URL` instead
`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 places
`static java.lang.String`	`MLE_SEQUENCE_KEY` Metadata key which specifies the next sequence number for a `MleMarker`.
`static java.lang.String`	`MSG_MIME_ENCODED` Metadata key that indicates that the AdaptrisMessage payload is a Mime Multipart message
`static 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`	`OFTP_DATE` Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
`static java.lang.String`	`OFTP_DESTINATION` Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
`static java.lang.String`	`OFTP_IS_ACKNOWLEDGEMENT` Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
`static java.lang.String`	`OFTP_MESSAGE_ID` Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
`static java.lang.String`	`OFTP_SOURCE` Metadata key containing the OFTP source.
`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 which `MessageSplitterService` 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`	`SAPBC_TID` Deprecated. since 3.9.0 check the optional SAP package for the appropriate value.
`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.lang.String`	`SOCKET_OBJECT_KEY` Deprecated. since 3.9.0 check the optional socket package for the appropriate value.
`static java.lang.String`	`STOP_PROCESSING_KEY` Metadata key which `Service` implementations should set to indicate that any subsequent configured `Service`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 producers
`static 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 of `AdaptrisComponent` 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 and Description

CoreConstants()

Constructors
Constructor and Description
`CoreConstants()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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 configured Services should not be applied to a message and that it should not be produced.
    
    See Also:
    
    Constant Field Values
  - 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 concrete Workflow 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 skipped
    - JmsTransactedWorkflow - will cause the producer to be skipped, but the message will be 'committed' if there have been no failures in the service collection
    - MultiProducerWorkflow - 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 skipped
    - LargeMessageWorkflow - will cause the producer to be skipped
    - JmsReplyToWorkflow - unaffected by this metadata key to ensure that the reply is still sent
    - RequestReplyWorkflow - unaffected by this metadata key to ensure that a reply to the triggering application can still be sent
    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
    
    See Also:
    
    STOP_PROCESSING_KEY, KEY_WORKFLOW_SKIP_PRODUCER, 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 for HttpSession 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 via JettyMessageConsumer 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
  - EMAIL_SUBJECT
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String EMAIL_SUBJECT
```
    Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
    
    Metadata key specifying the email subject.
    
    See Also:
    
    Constant Field Values
  - EMAIL_ATTACH_FILENAME
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String EMAIL_ATTACH_FILENAME
```
    Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
    
    Metadata key that specifies the name of the attachment.
    
    See Also:
    
    Constant Field Values
  - EMAIL_ATTACH_CONTENT_TYPE
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String EMAIL_ATTACH_CONTENT_TYPE
```
    Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
    
    Metadata key that specifies the content-type of the attachment.
    
    See Also:
    
    Constant Field Values
  - EMAIL_TOTAL_ATTACHMENTS
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String EMAIL_TOTAL_ATTACHMENTS
```
    Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
    
    Metadata key that specifies the total number of attachments.
    
    See Also:
    
    Constant Field Values
  - EMAIL_CC_LIST
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String EMAIL_CC_LIST
```
    Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
    
    Metadata key that specifies the cc list for sending.
    
    See Also:
    
    Constant Field Values
  - EMAIL_MESSAGE_ID
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String EMAIL_MESSAGE_ID
```
    Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
    
    Metadata key specifying the email message container from whence a payload may have spawned.
    
    See Also:
    
    Constant Field Values
  - EMAIL_TEMPLATE_BODY
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String EMAIL_TEMPLATE_BODY
```
    Deprecated. since 3.9.0 check the optional mail package for the appropriate value.
    
    Metadata key specifying the email body. This is only used if the SmtpProducer is configured to send the document as an attachment.
    
    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
  - OFTP_DESTINATION
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String OFTP_DESTINATION
```
    Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
    
    Metadata key containing the OFTP destination.
    
    See Also:
    
    Constant Field Values
  - OFTP_SOURCE
```
public static final java.lang.String OFTP_SOURCE
```
    Metadata key containing the OFTP source.
    
    See Also:
    
    Constant Field Values
  - OFTP_MESSAGE_ID
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String OFTP_MESSAGE_ID
```
    Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
    
    Metadata key containing the OFTP message id.
    
    See Also:
    
    Constant Field Values
  - OFTP_DATE
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String OFTP_DATE
```
    Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
    
    Metadata key containing the date from the OFTP sfid.
    This is the date in the form "yyyy-MM-dd HH:mm:ss zzz".
    
    See Also:
    
    Constant Field Values
  - OFTP_IS_ACKNOWLEDGEMENT
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String OFTP_IS_ACKNOWLEDGEMENT
```
    Deprecated. since 3.9.0 check the optional oftp package for the appropriate value.
    
    Metadata key specifying the message should be treated as an EERP.
    
    See Also:
    
    Constant Field Values
  - SOCKET_OBJECT_KEY
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String SOCKET_OBJECT_KEY
```
    Deprecated. since 3.9.0 check the optional socket package for the appropriate value.
    
    Metadata key that is used to key the object metadata that contains the raw socket.
    
    See Also:
    
    Constant Field Values
  - FTP_REPLYTO_NAME
```
public static final java.lang.String FTP_REPLYTO_NAME
```
    Metadata key for the FTP reply to name override.
    
    See Also:
    
    Constant Field Values
  - SAPBC_TID
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String SAPBC_TID
```
    Deprecated. since 3.9.0 check the optional SAP package for the appropriate value.
    
    Metadata key for the transaction id sent to and from the business connector.
    
    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 using HttpProducer or similar.
    
    See Also:
    
    Constant Field Values
  - JCO_IDOCTYP
```
@Deprecated
 @Removal(version="3.11.0")
public static final java.lang.String JCO_IDOCTYP
```
    Deprecated. since 3.9.0 check the optional SAP package for the appropriate value.
    
    Metadata key that contains the IDoc type.
    This is the value of the field IDOCTYP.
    
    See Also:
    
    Constant Field Values
  - JETTY_URL
```
@Deprecated
 @Removal(version="3.10.0")
public static final java.lang.String JETTY_URL
```
    Deprecated. since 3.8.0 use JettyConstants.JETTY_URL instead
    
    See Also:
    
    Constant Field Values
  - JETTY_URI
```
@Deprecated
 @Removal(version="3.10.0")
public static final java.lang.String JETTY_URI
```
    Deprecated. since 3.8.0 use JettyConstants.JETTY_URI instead
    
    See Also:
    
    Constant Field Values
  - JETTY_QUERY_STRING
```
@Deprecated
 @Removal(version="3.10.0")
public static final java.lang.String JETTY_QUERY_STRING
```
    Deprecated. since 3.8.0 use JettyConstants.JETTY_QUERY_STRING instead
    
    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
- Constructor Detail
  - CoreConstants
```
public CoreConstants()
```

Class CoreConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MLE_SEQUENCE_KEY

STOP_PROCESSING_KEY

KEY_WORKFLOW_SKIP_PRODUCER

STOP_PROCESSING_VALUE

CHANNEL_ID_KEY

WORKFLOW_ID_KEY

MESSAGE_UNIQUE_ID_KEY

PARENT_UNIQUE_ID_KEY

ENDPOINT_SERVICE_UNIQUE_ID

ORIGINAL_NAME_KEY

FILE_LAST_MODIFIED_KEY

FS_FILE_SIZE

PRODUCED_NAME_KEY

EVENT_NAME_SPACE_KEY

EVENT_CLASS

HTTP_SESSION_KEY

HTTP_METHOD

RETRY_COUNT_KEY

EMAIL_SUBJECT

EMAIL_ATTACH_FILENAME

EMAIL_ATTACH_CONTENT_TYPE

EMAIL_TOTAL_ATTACHMENTS

EMAIL_CC_LIST

EMAIL_MESSAGE_ID

EMAIL_TEMPLATE_BODY

SECURITY_V1_COMPATIBILITY

OFTP_DESTINATION

OFTP_SOURCE

OFTP_MESSAGE_ID

OFTP_DATE

OFTP_IS_ACKNOWLEDGEMENT

SOCKET_OBJECT_KEY

FTP_REPLYTO_NAME

SAPBC_TID

TRANSFORM_OVERRIDE

SECURITY_REMOTE_PARTNER

MSG_MIME_ENCODED

OBJ_METADATA_EXCEPTION

OBJ_METADATA_EXCEPTION_CAUSE

HTTP_PRODUCER_RESPONSE_CODE

JCO_IDOCTYP

JETTY_URL

JETTY_URI

JETTY_QUERY_STRING

FS_CONSUME_DIRECTORY

FS_CONSUME_PARENT_DIR

FS_PRODUCE_DIRECTORY

UNIQUE_ID_JMX_PATTERN

MESSAGE_CONSUME_LOCATION

Constructor Detail

CoreConstants