Sonic ESB API

com.sonicsw.xq
Interface XQConstants


public interface XQConstants


Field Summary
static int ADDRESS_ENDPOINT
          XQAddress object references an ENDPOINT
static int ADDRESS_EXPRESSION
          XQAddress object references an Expression
static int ADDRESS_PROCESS
          XQAddress object references a PROCESS
static int ADDRESS_REPLY_TO
          XQAddress object references a REPLY_TO address
static int ADDRESS_SERVICE
          XQAddress object references a SERVICE
static java.lang.String ADDRESS_STRING_ENDPOINT
          String name for an ENDPOINT address used in XQAddress The constant value is "ENDPOINT".
static java.lang.String ADDRESS_STRING_EXPRESSION
          String name for a EXPRESSION address used in XQAddress The constant value is "EXPRESSION".
static java.lang.String ADDRESS_STRING_PROCESS
          String name for a PROCESS address used in XQAddress The constant value is "PROCESS".
static java.lang.String ADDRESS_STRING_REPLY_TO
          String name for a REPLY_TO address used in XQAddress The constant value is "REPLY_TO".
static java.lang.String ADDRESS_STRING_SERVICE
          String name for a SERVICE address used in XQAddress The constant value is "SERVICE".
static int ALL_PARTS
          XQMessage Part index value, signifying all parts.
static int ALO_QOS
          Int value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API.
static int BE_QOS
          Int value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API.
static java.lang.String CONTENT_ID_FAULT
          CONTENT_ID_FAULT Content ID of faults expected by the Web Service invocation steps used in ESB Processes.
static java.lang.String CONTENT_TYPE_ANYTEXT
          Prefix used for message or message part that contains any text data.
static java.lang.String CONTENT_TYPE_BPHEADER
          Message or message part contains a SonicXQ Business Process Header The constant value is "application/x-sonicxq-bpheader; version=2.0".
static java.lang.String CONTENT_TYPE_BPHEADER_OLD
          Message or message part contains a pre-XQ1.5 SonicXQ Business Process Header The constant value is "application/x-sonicxq-bpheader".
static java.lang.String CONTENT_TYPE_BYTES
          Message or message part contains binary data.
static java.lang.String CONTENT_TYPE_FAULTHEADER
          Message or message part contains a SonicXQ Business Process Header related to fault handling The constant value is "application/x-sonicfault-bpheader; version=2.0".
static java.lang.String CONTENT_TYPE_HTML
          Message or message part contains html data.
static java.lang.String CONTENT_TYPE_TEXT
          Message or message part contains text data.
static java.lang.String CONTENT_TYPE_XML
          Message or message part contains XML data.
static int DECISION_NODE
          Itinerary constant used in SonicESB processes to identify a process step.
static java.lang.String DSDATA_PROVIDER_URL
          A property key used to specify the location of the Directory Service The constant value is "providerURL".
static int EXO_QOS
          Int value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API.
static int FANOUT_NODE
          Itinerary constant used in SonicESB processes to identify a process step.
static java.lang.String HEADER_FAULT_CODE
           
static java.lang.String HEADER_FAULT_NAME
           
static java.lang.String HEADER_FAULT_STRING
           
static int ITINERARY_NODE
          This value is NOT returned from the process environment provided by XQProcessContext.getStepType().
static java.lang.String JMS_PROP_PREFIX
          Prefix used on all XQ message properties that are added to a JMS message.
static java.lang.String JNDI_URL_PREFIX
          A URL prefix that indicates the content of the URL is stored in a JNDI store.
static java.lang.String NS_PREFIX_SONICXQ
          SonicXQ Namespace Prefix The constant value is "xq:".
static java.lang.String NS_URI_SONICXQ
          SonicXQ Namespace URI.
static java.lang.String PARAM_APPLICATION_NAME
          XQParameters key value used to retrieve the application name from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ApplicationName".
static java.lang.String PARAM_COMPONENT_NAME
          XQParameters key value used to retrieve the XQ component name from the service environment provided in both the XQInitContext and the XQServiceContext.
static java.lang.String PARAM_CONTAINER_NAME
          XQParameters key value used to retrieve the MF container name from the service environment provided in both the XQInitContext and the XQServiceContext.
static java.lang.String PARAM_CURRENT_PROCESS_STEP
          XQParameters key value used to retrieve the step name of the current process.
static java.lang.String PARAM_DOMAIN_NAME
          XQParameters key value used to retrieve the MF domain name from the service environment provided in both the XQInitContext and the XQServiceContext.
static java.lang.String PARAM_EVENT_ADDRESS
          XQParameters key value used to retrieve the event address from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_EVENT_ENDPOINT
          XQParameters key value used to retrieve the event endpoint from the service environment provided in XQServiceContext.
static java.lang.String PARAM_EXIT_ENDPOINTS
          XQParameters key value used to retrieve the exit endpoints from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_FAILOVER_IDENTITY
          XQParameters key value used to retrieve the MF container's failover identity from the service environment provided in both the XQInitContext and the XQServiceContext.
static java.lang.String PARAM_FAULT_ADDRESS
          XQParameters key value used to retrieve the fault address from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_FAULT_CODE
           
static java.lang.String PARAM_FAULT_HANDLER
           
static java.lang.String PARAM_FAULT_HANDLER_NODE_NAME
           
static java.lang.String PARAM_FAULT_HANDLER_NODE_TYPE
           
static java.lang.String PARAM_FAULT_HANDLER_RETRY_COUNT
           
static java.lang.String PARAM_FAULT_MESSAGE
           
static java.lang.String PARAM_FAULT_NAME
           
static java.lang.String PARAM_FAULTSOURCE_CONTAINER_NAME
           
static java.lang.String PARAM_FAULTSOURCE_HOST_NAME
           
static java.lang.String PARAM_FAULTSOURCE_PROCESS_NAME
          XQParameters key value used to retrieve the name of the process that threw the fault from the XQFaultProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_FAULTSOURCE_SERVICE_NAME
           
static java.lang.String PARAM_FAULTSOURCE_STEP_NAME
          XQParameters key value used to retrieve the name of the step in the process that threw the fault from the XQFaultProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_FAULTSOURCE_TOP_PROCESS_NAME
          XQParameters key value used to retrieve the name of the top process of the process that threw the fault from the XQFaultProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_LISTENERS
          XQParameters key value used to retrieve the number of listeners from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.Listeners".
static int PARAM_OBJECT
          Parameter type used to retrieve an XQParameter value as a Java Object.
static java.lang.String PARAM_PROCESS_DESC
          XQParameters key value used to retrieve the process description from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_PROCESS_INFLIGHT_PROPS
           
static java.lang.String PARAM_PROCESS_NAME
          XQParameters key value used to retrieve the process name from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_PROCESS_NEXT
          XQParameters key value used to retrieve the process next steps from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_PROCESS_STEP
          XQParameters key value used to retrieve the process step name from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_PROCESS_STEP_TYPE
          XQParameters key value used to retrieve the process step type from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_PROCESS_TOKEN
           
static java.lang.String PARAM_QOS
          XQParameters key value used to retrieve the qos from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_RME_ADDRESS
          XQParameters key value used to retrieve the rme address from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_SERVICE_NAME
          XQParameters key value used to retrieve the service name from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ServiceName".
static int PARAM_STRING
          Parameter type used to retrieve an XQParameter value as a STRING.
static java.lang.String PARAM_TIMESTAMP
          XQParameters key value used to retrieve the timestamp from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_TOP_PROCESS_NAME
          XQParameters key value used to store the top-level process name in the process environment provided in XQProcessContext.
static java.lang.String PARAM_TRACKING_ID
          XQParameters key value used to retrieve the tracking id from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_TRACKING_LEVEL
          XQParameters key value used to retrieve the tracking level from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static java.lang.String PARAM_TTL
          XQParameters key value used to retrieve the timetolive from the process environment provided in XQProcessContext, accessible from XQServiceContext.
static int PARAM_XML
          Parameter type used to retrieve an XQParameter value as XML data.
static java.lang.String PARAM_XQ_CONTAINER_NAME
          XQParameters key value used to retrieve the XQ container name from the service environment provided in both the XQInitContext and the XQServiceContext.
static float PROCESS_MODEL_VERSION
           
static java.lang.String SERVICE_PARAM_ENTRY_ENDPOINT_ADDRESS
          XQParameters key value used to retrieve the entry endpoint address from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.EntryEndpointAddress".
static java.lang.String SERVICE_PARAM_EXIT_ENDPOINT_ADDRESS_LIST
          XQParameters key value used to retrieve the exit endpoint addresses from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ExitEndpointList".
static java.lang.String SERVICE_PARAM_FAULT_ENDPOINT_ADDRESS
          XQParameters key value used to retrieve the fault endpoint address from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.FaultEndpointAddress".
static java.lang.String SERVICE_PARAM_REJECTEDMESSAGE_ENDPOINT_ADDRESS
          XQParameters key value used to retrieve the rejected message endpoint address from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.RejectedMessageEndpointAddress".
static java.lang.String SERVICE_PARAM_SERVICE_TYPE
          XQParameters key value used to retrieve the service type from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ServiceType".
static java.lang.String SERVICE_PARAM_WSDL_URL_CONTENTS
          XQParameters key value used to retrieve the WSDL URL contents from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.WSDLUrlContents".
static java.lang.String SONIC_URL_PREFIX
          A URL prefix that indicates the content of the URL is stored in a ESB Service or process.
static java.lang.String SONICFS_URL_PREFIX
          A URL prefix that indicates that the content of the URL is stored in the SonicESB Directory Service.
static int STEP_NODE
          Itinerary constant used in SonicESB processes to identify a process step.
static java.lang.String STRING_ALO_QOS
          String value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API.
static java.lang.String STRING_BE_QOS
          String value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API.
static java.lang.String STRING_EXO_QOS
          String value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API.
static int TRACKING_ADD_MESSAGE_CONTENT
          Tracking level of a SonicESB process.
static int TRACKING_ADD_MESSAGE_HEADERS
          Tracking level of a SonicESB process.
static java.lang.String TRACKING_MESSAGE_CONTENT_ID
          Tracking messages are multi-part messages.
static int TRACKING_OFF
          Tracking level of a SonicESB process.
static int TRACKING_PROCESS_ENTRY_AND_EXIT
          Tracking level of a SonicESB process.
static int TRACKING_SERVICE_ENTRY_AND_EXIT
          Tracking level of a SonicESB process.
 

Field Detail

PARAM_STRING

static final int PARAM_STRING
Parameter type used to retrieve an XQParameter value as a STRING.

See Also:
Constant Field Values

PARAM_XML

static final int PARAM_XML
Parameter type used to retrieve an XQParameter value as XML data.

See Also:
Constant Field Values

PARAM_OBJECT

static final int PARAM_OBJECT
Parameter type used to retrieve an XQParameter value as a Java Object.

See Also:
Constant Field Values

ADDRESS_ENDPOINT

static final int ADDRESS_ENDPOINT
XQAddress object references an ENDPOINT

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_SERVICE

static final int ADDRESS_SERVICE
XQAddress object references a SERVICE

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_PROCESS

static final int ADDRESS_PROCESS
XQAddress object references a PROCESS

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_REPLY_TO

static final int ADDRESS_REPLY_TO
XQAddress object references a REPLY_TO address

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_EXPRESSION

static final int ADDRESS_EXPRESSION
XQAddress object references an Expression

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_STRING_ENDPOINT

static final java.lang.String ADDRESS_STRING_ENDPOINT
String name for an ENDPOINT address used in XQAddress The constant value is "ENDPOINT".

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_STRING_SERVICE

static final java.lang.String ADDRESS_STRING_SERVICE
String name for a SERVICE address used in XQAddress The constant value is "SERVICE".

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_STRING_PROCESS

static final java.lang.String ADDRESS_STRING_PROCESS
String name for a PROCESS address used in XQAddress The constant value is "PROCESS".

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_STRING_REPLY_TO

static final java.lang.String ADDRESS_STRING_REPLY_TO
String name for a REPLY_TO address used in XQAddress The constant value is "REPLY_TO".

See Also:
XQAddressFactory, Constant Field Values

ADDRESS_STRING_EXPRESSION

static final java.lang.String ADDRESS_STRING_EXPRESSION
String name for a EXPRESSION address used in XQAddress The constant value is "EXPRESSION".

See Also:
XQAddressFactory, Constant Field Values

CONTENT_TYPE_XML

static final java.lang.String CONTENT_TYPE_XML
Message or message part contains XML data. The constant value is "text/xml".

See Also:
Constant Field Values

CONTENT_TYPE_TEXT

static final java.lang.String CONTENT_TYPE_TEXT
Message or message part contains text data. The constant value is "text/plain".

See Also:
Constant Field Values

CONTENT_TYPE_HTML

static final java.lang.String CONTENT_TYPE_HTML
Message or message part contains html data. The constant value is "text/html".

See Also:
Constant Field Values

CONTENT_TYPE_ANYTEXT

static final java.lang.String CONTENT_TYPE_ANYTEXT
Prefix used for message or message part that contains any text data. The constant value is "text/".

See Also:
Constant Field Values

CONTENT_TYPE_BYTES

static final java.lang.String CONTENT_TYPE_BYTES
Message or message part contains binary data. The constant value is "application/octet-stream".

See Also:
Constant Field Values

CONTENT_TYPE_BPHEADER

static final java.lang.String CONTENT_TYPE_BPHEADER
Message or message part contains a SonicXQ Business Process Header The constant value is "application/x-sonicxq-bpheader; version=2.0".

See Also:
Constant Field Values

CONTENT_TYPE_FAULTHEADER

static final java.lang.String CONTENT_TYPE_FAULTHEADER
Message or message part contains a SonicXQ Business Process Header related to fault handling The constant value is "application/x-sonicfault-bpheader; version=2.0".

See Also:
Constant Field Values

CONTENT_TYPE_BPHEADER_OLD

static final java.lang.String CONTENT_TYPE_BPHEADER_OLD
Message or message part contains a pre-XQ1.5 SonicXQ Business Process Header The constant value is "application/x-sonicxq-bpheader".

See Also:
Constant Field Values

SONICFS_URL_PREFIX

static final java.lang.String SONICFS_URL_PREFIX
A URL prefix that indicates that the content of the URL is stored in the SonicESB Directory Service. The constant value is "sonicfs:///".

See Also:
Constant Field Values

SONIC_URL_PREFIX

static final java.lang.String SONIC_URL_PREFIX
A URL prefix that indicates the content of the URL is stored in a ESB Service or process. The constant value is "sonic:/"

See Also:
Constant Field Values

JNDI_URL_PREFIX

static final java.lang.String JNDI_URL_PREFIX
A URL prefix that indicates the content of the URL is stored in a JNDI store. The constant value is "jndi:/"

See Also:
Constant Field Values

DSDATA_PROVIDER_URL

static final java.lang.String DSDATA_PROVIDER_URL
A property key used to specify the location of the Directory Service The constant value is "providerURL".

See Also:
Constant Field Values

PARAM_CONTAINER_NAME

static final java.lang.String PARAM_CONTAINER_NAME
XQParameters key value used to retrieve the MF container name from the service environment provided in both the XQInitContext and the XQServiceContext. The constant value is "SonicXQ.ContainerName".

See Also:
Constant Field Values

PARAM_FAILOVER_IDENTITY

static final java.lang.String PARAM_FAILOVER_IDENTITY
XQParameters key value used to retrieve the MF container's failover identity from the service environment provided in both the XQInitContext and the XQServiceContext. The constant value is "SonicXQ.FailoverIdentity".

See Also:
Constant Field Values

PARAM_DOMAIN_NAME

static final java.lang.String PARAM_DOMAIN_NAME
XQParameters key value used to retrieve the MF domain name from the service environment provided in both the XQInitContext and the XQServiceContext. The constant value is "SonicXQ.DomainName".

See Also:
Constant Field Values

PARAM_XQ_CONTAINER_NAME

static final java.lang.String PARAM_XQ_CONTAINER_NAME
XQParameters key value used to retrieve the XQ container name from the service environment provided in both the XQInitContext and the XQServiceContext. The constant value is "SonicXQ.xqContainerName".

See Also:
Constant Field Values

PARAM_COMPONENT_NAME

static final java.lang.String PARAM_COMPONENT_NAME
XQParameters key value used to retrieve the XQ component name from the service environment provided in both the XQInitContext and the XQServiceContext. The constant value is "SonicXQ.ComponentName".

See Also:
Constant Field Values

PARAM_APPLICATION_NAME

static final java.lang.String PARAM_APPLICATION_NAME
XQParameters key value used to retrieve the application name from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ApplicationName".

See Also:
Constant Field Values

PARAM_SERVICE_NAME

static final java.lang.String PARAM_SERVICE_NAME
XQParameters key value used to retrieve the service name from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ServiceName".

See Also:
Constant Field Values

SERVICE_PARAM_SERVICE_TYPE

static final java.lang.String SERVICE_PARAM_SERVICE_TYPE
XQParameters key value used to retrieve the service type from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ServiceType".

See Also:
Constant Field Values

SERVICE_PARAM_ENTRY_ENDPOINT_ADDRESS

static final java.lang.String SERVICE_PARAM_ENTRY_ENDPOINT_ADDRESS
XQParameters key value used to retrieve the entry endpoint address from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.EntryEndpointAddress".

See Also:
Constant Field Values

SERVICE_PARAM_EXIT_ENDPOINT_ADDRESS_LIST

static final java.lang.String SERVICE_PARAM_EXIT_ENDPOINT_ADDRESS_LIST
XQParameters key value used to retrieve the exit endpoint addresses from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.ExitEndpointList".

See Also:
Constant Field Values

SERVICE_PARAM_FAULT_ENDPOINT_ADDRESS

static final java.lang.String SERVICE_PARAM_FAULT_ENDPOINT_ADDRESS
XQParameters key value used to retrieve the fault endpoint address from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.FaultEndpointAddress".

See Also:
Constant Field Values

SERVICE_PARAM_REJECTEDMESSAGE_ENDPOINT_ADDRESS

static final java.lang.String SERVICE_PARAM_REJECTEDMESSAGE_ENDPOINT_ADDRESS
XQParameters key value used to retrieve the rejected message endpoint address from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.RejectedMessageEndpointAddress".

See Also:
Constant Field Values

SERVICE_PARAM_WSDL_URL_CONTENTS

static final java.lang.String SERVICE_PARAM_WSDL_URL_CONTENTS
XQParameters key value used to retrieve the WSDL URL contents from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.WSDLUrlContents".

See Also:
Constant Field Values

PARAM_LISTENERS

static final java.lang.String PARAM_LISTENERS
XQParameters key value used to retrieve the number of listeners from the service environment provided in both the XQInitContext and the XQServiceContext The constant value is "SonicXQ.Listeners".

See Also:
Constant Field Values

PARAM_PROCESS_NAME

static final java.lang.String PARAM_PROCESS_NAME
XQParameters key value used to retrieve the process name from the process environment provided in XQProcessContext, accessible from XQServiceContext. If this service is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.ProcessName".

See Also:
Constant Field Values

PARAM_TOP_PROCESS_NAME

static final java.lang.String PARAM_TOP_PROCESS_NAME
XQParameters key value used to store the top-level process name in the process environment provided in XQProcessContext. The constant value is "SonicXQ.TopLevelProcessName".

See Also:
Constant Field Values

PARAM_PROCESS_STEP

static final java.lang.String PARAM_PROCESS_STEP
XQParameters key value used to retrieve the process step name from the process environment provided in XQProcessContext, accessible from XQServiceContext. If this service is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.ProcessStep".

See Also:
Constant Field Values

PARAM_CURRENT_PROCESS_STEP

static final java.lang.String PARAM_CURRENT_PROCESS_STEP
XQParameters key value used to retrieve the step name of the current process. This step name always contains the actual name of the step and even in the case of nested processes it does NOT contain the compound step name. This is accessible from the process environment provided in XQProcessContext, accessible from XQServiceContext. If this service is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.CurrentProcessStep".

See Also:
Constant Field Values

PARAM_PROCESS_STEP_TYPE

static final java.lang.String PARAM_PROCESS_STEP_TYPE
XQParameters key value used to retrieve the process step type from the process environment provided in XQProcessContext, accessible from XQServiceContext. If this service is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.ProcessStepType".

See Also:
Constant Field Values

PARAM_PROCESS_NEXT

static final java.lang.String PARAM_PROCESS_NEXT
XQParameters key value used to retrieve the process next steps from the process environment provided in XQProcessContext, accessible from XQServiceContext. If this service is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.ProcessNext".

See Also:
Constant Field Values

PARAM_PROCESS_DESC

static final java.lang.String PARAM_PROCESS_DESC
XQParameters key value used to retrieve the process description from the process environment provided in XQProcessContext, accessible from XQServiceContext. If this service is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.ProcessDesc".

See Also:
Constant Field Values

PARAM_TRACKING_ID

static final java.lang.String PARAM_TRACKING_ID
XQParameters key value used to retrieve the tracking id from the process environment provided in XQProcessContext, accessible from XQServiceContext. If this service is not being used in the context of a process or if the process does not have tracking turned on, the value returned from XQParameters will be null. The constant value is "SonicXQ.process.trackingID".

See Also:
Constant Field Values

PARAM_EVENT_ENDPOINT

static final java.lang.String PARAM_EVENT_ENDPOINT
XQParameters key value used to retrieve the event endpoint from the service environment provided in XQServiceContext. If this service is not being used in the context of a process or if the process does not have tracking turned on, the value returned from XQParameters will be null. The constant value is "SonicXQ.EventEndpoint".

See Also:
Constant Field Values

JMS_PROP_PREFIX

static final java.lang.String JMS_PROP_PREFIX
Prefix used on all XQ message properties that are added to a JMS message. The constant value is "JMS_SonicMQ_XQ".

See Also:
Constant Field Values

NS_URI_SONICXQ

static final java.lang.String NS_URI_SONICXQ
SonicXQ Namespace URI. The constant value is "http://www.sonicsw.com/sonicxq".

See Also:
Constant Field Values

NS_PREFIX_SONICXQ

static final java.lang.String NS_PREFIX_SONICXQ
SonicXQ Namespace Prefix The constant value is "xq:".

See Also:
Constant Field Values

PARAM_QOS

static final java.lang.String PARAM_QOS
XQParameters key value used to retrieve the qos from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
If this service is not being used in the context of a process or if the process does not have tracking turned on, the value returned from XQParameters will be null. The constant value is "SonicXQ.process.qos"., Constant Field Values

PARAM_RME_ADDRESS

static final java.lang.String PARAM_RME_ADDRESS
XQParameters key value used to retrieve the rme address from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
If this service is not being used in the context of a process or if the process does not have tracking turned on, the value returned from XQParameters will be null. The constant value is "SonicXQ.process.RMEAddress"., Constant Field Values

PARAM_FAULT_ADDRESS

static final java.lang.String PARAM_FAULT_ADDRESS
XQParameters key value used to retrieve the fault address from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
If this service is not being used in the context of a process or if the process does not have tracking turned on, the value returned from XQParameters will be null. The constant value is "SonicXQ.process.faultAddress"., Constant Field Values

PARAM_EVENT_ADDRESS

static final java.lang.String PARAM_EVENT_ADDRESS
XQParameters key value used to retrieve the event address from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
If this service is not being used in the context of a process or if the process does not have tracking turned on, the value returned from XQParameters will be null. The constant value is "SonicXQ.process.eventAddress"., Constant Field Values

PARAM_TRACKING_LEVEL

static final java.lang.String PARAM_TRACKING_LEVEL
XQParameters key value used to retrieve the tracking level from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
The constant value is "SonicXQ.process.trackingLevel"., Constant Field Values

PARAM_TTL

static final java.lang.String PARAM_TTL
XQParameters key value used to retrieve the timetolive from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
The constant value is "SonicXQ.process.TTL"., Constant Field Values

PARAM_TIMESTAMP

static final java.lang.String PARAM_TIMESTAMP
XQParameters key value used to retrieve the timestamp from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
The constant value is "SonicXQ.process.timestamp"., Constant Field Values

PARAM_EXIT_ENDPOINTS

static final java.lang.String PARAM_EXIT_ENDPOINTS
XQParameters key value used to retrieve the exit endpoints from the process environment provided in XQProcessContext, accessible from XQServiceContext.

See Also:
The constant value is "SonicXQ.process.exitEndpoints"., Constant Field Values

PARAM_FAULTSOURCE_TOP_PROCESS_NAME

static final java.lang.String PARAM_FAULTSOURCE_TOP_PROCESS_NAME
XQParameters key value used to retrieve the name of the top process of the process that threw the fault from the XQFaultProcessContext, accessible from XQServiceContext. If this constant is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.FaultSource.ProcessName".

See Also:
Constant Field Values

PARAM_FAULTSOURCE_PROCESS_NAME

static final java.lang.String PARAM_FAULTSOURCE_PROCESS_NAME
XQParameters key value used to retrieve the name of the process that threw the fault from the XQFaultProcessContext, accessible from XQServiceContext. If this constant is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.FaultSource.ProcessName".

See Also:
Constant Field Values

PARAM_FAULTSOURCE_STEP_NAME

static final java.lang.String PARAM_FAULTSOURCE_STEP_NAME
XQParameters key value used to retrieve the name of the step in the process that threw the fault from the XQFaultProcessContext, accessible from XQServiceContext. If this constant is not being used in the context of a process the value returned from XQParameters will be null. The constant value is "SonicXQ.FaultSource.ProcessStep".

See Also:
Constant Field Values

STEP_NODE

static final int STEP_NODE
Itinerary constant used in SonicESB processes to identify a process step. This value is returned from the process environment provided by XQProcessContext.getStepType(). STEP_NODE indicates a process step. The constant value is 0.

See Also:
Constant Field Values

DECISION_NODE

static final int DECISION_NODE
Itinerary constant used in SonicESB processes to identify a process step. This value is returned from the process environment provided by XQProcessContext.getStepType(). DECISION_NODE value indicates the step is a decision node e.g. a CBR service. The constant value is 1.

See Also:
Constant Field Values

FANOUT_NODE

static final int FANOUT_NODE
Itinerary constant used in SonicESB processes to identify a process step. This value is returned from the process environment provided by XQProcessContext.getStepType(). FANOUT_NODE indicates the step is a fanout node. The constant value is 2.

See Also:
Constant Field Values

ITINERARY_NODE

static final int ITINERARY_NODE
This value is NOT returned from the process environment provided by XQProcessContext.getStepType(). ITINERARY_NODE indicates an itinerary node The constant value is 2.

See Also:
Constant Field Values

BE_QOS

static final int BE_QOS
Int value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API. This value is returned by the service environment provided by XQServiceContext.getQoS(). BE_QOS stands for "Best Effort" Quality of Service. This QoS is best used in non-critical scenarios, where duplicates and message drops are acceptable. The constant value is 0.

See Also:
Constant Field Values

ALO_QOS

static final int ALO_QOS
Int value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API. This value is returned by the service environment provided by XQServiceContext.getQoS(). ALO_QOS stands for "At Least Once" Quality of Service. This QoS guarantees no message loss however duplicate messages may occur. The constant value is 1.

See Also:
Constant Field Values

EXO_QOS

static final int EXO_QOS
Int value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API. This value is returned by the service environment provided by XQServiceContext.getQoS(). EXO_QOS stands for "EXactly Once" Quality of Service. This QoS guarantees maximum reliablity with no message loss or duplicates. The constant value is 2.

See Also:
Constant Field Values

STRING_BE_QOS

static final java.lang.String STRING_BE_QOS
String value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API. This value is returned by the service environment provided by XQServiceContext.getQoS(). BE_QOS stands for "Best Effort" Quality of Service. This QoS is best used in non-critical scenarios, where duplicates and message drops are acceptable. The constant value is "BEST_EFFORT".

See Also:
Constant Field Values

STRING_ALO_QOS

static final java.lang.String STRING_ALO_QOS
String value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API. This value is returned by the service environment provided by XQServiceContext.getQoS(). ALO_QOS stands for "At Least Once" Quality of Service. This QoS guarantees no message loss however duplicate messages may occur. The constant value is "AT_LEAST_ONCE".

See Also:
Constant Field Values

STRING_EXO_QOS

static final java.lang.String STRING_EXO_QOS
String value of a QoS level supported by SonicESB endpoints and asynchronous dispatch API. This value is returned by the service environment provided by XQServiceContext.getQoS(). EXO_QOS stands for "EXactly Once" Quality of Service. This QoS guarantees maximum reliablity with no message loss or duplicates. The constant value is "EXACTLY_ONCE".

See Also:
Constant Field Values

TRACKING_OFF

static final int TRACKING_OFF
Tracking level of a SonicESB process. This value is returned from the process environment provided by XQProcessContext.getTrackingLevel(). TRACKING_OFF implies no tracking. The constant value is 0.

See Also:
Constant Field Values

TRACKING_PROCESS_ENTRY_AND_EXIT

static final int TRACKING_PROCESS_ENTRY_AND_EXIT
Tracking level of a SonicESB process. This value is returned from the process environment provided by XQProcessContext.getTrackingLevel(). TRACKING_PROCESS_ENTRY_AND_EXIT tracks when a message enters and leaves a SonicESB process, including nested processes. The constant value is 1.

See Also:
Constant Field Values

TRACKING_SERVICE_ENTRY_AND_EXIT

static final int TRACKING_SERVICE_ENTRY_AND_EXIT
Tracking level of a SonicESB process. This value is returned from the process environment provided by XQProcessContext.getTrackingLevel(). TRACKING_SERVICE_ENTRY_AND_EXIT tracks when a message enters and leave a SonicESB service deployed within a SonicESB process, in addition to tracking process entries and exits. The constant value is 2.

See Also:
Constant Field Values

TRACKING_ADD_MESSAGE_HEADERS

static final int TRACKING_ADD_MESSAGE_HEADERS
Tracking level of a SonicESB process. This value is returned from the process environment provided by XQProcessContext.getTrackingLevel(). TRACKING_ADD_MESSAGE_HEADERS tracks at the TRACKING_SERVICE_ENTRY_AND_EXIT level and in addition adds the message headers of the tracked message to the tracking message content:

  <xqMessageHeaders>
    <header name="A">valueA</header>
    <header name="B">valueB</header>
  </xqMessageHeaders>
 

The constant value is 3.

See Also:
Constant Field Values

TRACKING_ADD_MESSAGE_CONTENT

static final int TRACKING_ADD_MESSAGE_CONTENT
Tracking level of a SonicESB process. This value is returned from the process environment provided by XQProcessContext.getTrackingLevel(). TRACKING_ADD_MESSAGE_CONTENT tracks at the TRACKING_ADD_MESSAGE_HEADERS level and in addition adds the message contet of the tracked message to the tracking message content as a multipart message.

 For tracking Level 4, the Tracking Message would always be a Multipart Message.
 The first part would have the same content as Tracking Level 3 above.   The part would be:
     �  Content-Id: TrackingMessage
     �  Content-Type: text/xml

 Parts 2�n+1 of the Tracking Message would be copies of parts 1�n of the original XQMessage.
 Note that for the case of the original message having no parts, the tracking message would be a
 single part MultipartMessage.

 In other words,
  �     The user could recover the original message parts by looking at parts 2..n+1 of the Tracking Messages.
    This would include:
    �   Part Headers
    �   Part Content

  �     The user could recover the original messages Headers by parsing the TrackingMessage part (Part 1) and
    getting header values from the <xqMessageHeaders/>

 

The constant value is 4.

See Also:
Constant Field Values

TRACKING_MESSAGE_CONTENT_ID

static final java.lang.String TRACKING_MESSAGE_CONTENT_ID
Tracking messages are multi-part messages. This identifies the message part that contains the tracking message content (as SOAP). The other parts contain the tracked message content.

See Also:
TRACKING_ADD_MESSAGE_CONTENT, Constant Field Values

ALL_PARTS

static final int ALL_PARTS
XQMessage Part index value, signifying all parts. This value is returned from Transformation service configuration params, runtime params and JavaScript rules to indicate transformation of all input message parts. The constant value is -1.

See Also:
Constant Field Values

CONTENT_ID_FAULT

static final java.lang.String CONTENT_ID_FAULT
CONTENT_ID_FAULT Content ID of faults expected by the Web Service invocation steps used in ESB Processes. If a Sonic ESB Service or Process exposes itself in a WSDL with an ESB binding, then the caller expects all faults (both explicit and implicit) to be returned as a single part message, with the part�s Content-Id having this value. If the fault message does not have this Content-Id, then the fault may be mis-interpretted as the normal successful response.

See Also:
Constant Field Values

PARAM_FAULT_HANDLER

static final java.lang.String PARAM_FAULT_HANDLER
See Also:
Constant Field Values

PARAM_FAULT_HANDLER_NODE_NAME

static final java.lang.String PARAM_FAULT_HANDLER_NODE_NAME
See Also:
Constant Field Values

PARAM_FAULT_HANDLER_NODE_TYPE

static final java.lang.String PARAM_FAULT_HANDLER_NODE_TYPE
See Also:
Constant Field Values

PARAM_PROCESS_INFLIGHT_PROPS

static final java.lang.String PARAM_PROCESS_INFLIGHT_PROPS
See Also:
Constant Field Values

PROCESS_MODEL_VERSION

static final float PROCESS_MODEL_VERSION
See Also:
Constant Field Values

PARAM_FAULT_HANDLER_RETRY_COUNT

static final java.lang.String PARAM_FAULT_HANDLER_RETRY_COUNT
See Also:
Constant Field Values

PARAM_PROCESS_TOKEN

static final java.lang.String PARAM_PROCESS_TOKEN
See Also:
Constant Field Values

HEADER_FAULT_NAME

static final java.lang.String HEADER_FAULT_NAME
See Also:
Constant Field Values

HEADER_FAULT_STRING

static final java.lang.String HEADER_FAULT_STRING
See Also:
Constant Field Values

HEADER_FAULT_CODE

static final java.lang.String HEADER_FAULT_CODE
See Also:
Constant Field Values

PARAM_FAULTSOURCE_HOST_NAME

static final java.lang.String PARAM_FAULTSOURCE_HOST_NAME
See Also:
Constant Field Values

PARAM_FAULTSOURCE_SERVICE_NAME

static final java.lang.String PARAM_FAULTSOURCE_SERVICE_NAME
See Also:
Constant Field Values

PARAM_FAULT_NAME

static final java.lang.String PARAM_FAULT_NAME
See Also:
Constant Field Values

PARAM_FAULT_CODE

static final java.lang.String PARAM_FAULT_CODE
See Also:
Constant Field Values

PARAM_FAULT_MESSAGE

static final java.lang.String PARAM_FAULT_MESSAGE
See Also:
Constant Field Values

PARAM_FAULTSOURCE_CONTAINER_NAME

static final java.lang.String PARAM_FAULTSOURCE_CONTAINER_NAME
See Also:
Constant Field Values

Sonic ESB API

Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
HTML formatted on 13-Mar-2012.