A normalized message is simplified to have only two parts, properties and payload. In Oracle BPEL Process Manager and Oracle Mediator, you can access, manipulate, and set headers with varying degrees of user interface support. For example, you can preserve a file name from the source directory to the target directory by propagating it through message headers.
Oracle JCA adapters transmit header information through Normalized Message properties (with the exception of the Oracle JCA Adapter for AQ's payload header).
Binding properties are message header properties for the service and reference binding components included in a deployed SOA composite application.
This appendix includes the following sections:
For more information, see “Configuring Service and Reference Binding Components” in the Administering Oracle SOA Suite and Oracle Business Process Management Suite guide.
This section describes the properties applicable to the Oracle File and FTP Adapters, including:
For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.
Table A-1 JCA Properties for Oracle File and FTP Adapters
|
Table A-2 JCA Properties Specific to Oracle FTP Adapter
|
Table A-3 Binding Properties for Oracle File and FTP Adapters
|
Table A-4 Binding Properties Specific to Oracle FTP Adapter
|
Table A-5 JCA Properties for Oracle File Adapter: Normalized Properties
|
Table A-6 JCA Properties for Oracle FTP Adapter: Normalized Properties
|
This section describes the properties applicable to the Oracle Socket Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.
For more information, see Section 33.1.2.7, "Oracle Socket Adapter", in the Administering Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-7 JCA Properties for Oracle Socket Adapter
|
This section describes the properties applicable to the Oracle AQ Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.
For more information, see Section 33.1.2.1, "Oracle AQ Adapter", in the Administering Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-8 JCA Properties for Oracle AQ Adapter
|
Table A-9 JCA Properties for Oracle AQ Adapter: Normalized Properties
|
Table A-10 Binding Properties for Oracle AQ Adapter
|
This section describes the properties applicable to the Oracle JMS Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.
For more information, see Section 33.1.2.5, "Oracle JMS Adapter", in the Administering Oracle SOA Suite and Oracle Business Process Management Suite
Table A-11 JCA Properties for Oracle JMS Adapter
|
Table A-12 JCA Properties for Oracle JMS Adapter: Normalized Properties
|
Table A-13 Binding Properties for Oracle JMS Adapter
|
This section describes the properties applicable to the Oracle Database Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.
For more information, see:
Section 33.1.2.2, "Oracle Database Adapter", in the Administering Oracle SOA Suite and Oracle Business Process Management Suite.
Appendix H, "Normalized Message Properties", in the Developing SOA Applications with Oracle SOA Suite.
Table A-14 JCA Properties for Oracle Database Adapter: Instance Properties
|
Table A-15 JCA Properties for Oracle Database Adapter: Normalized Message Properties
|
Footnote 1
For more information, see Proxy Authentication Support.
This section describes the properties applicable to the Oracle MQ Series Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.
For more information, see Section 33.1.2.6, "Oracle MQ Adapter", in the Administering Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-16 JCA Properties for Oracle MQ Series Adapter
|
Table A-17 JCA Properties for Oracle MQ Series Adapter: Normalized Properties
|
Table A-18 Connection Properties for Oracle MQ Series Adapter
|
Table A-19 Binding Properties for Oracle MQ Series Adapter
|
This section describes the properties applicable to the LDAP Adapter.
Table A-20 LDAP Adapter Connection Properties
Property | Allowed Values | Description |
---|---|---|
|
Name or IP address of the host machine. |
Machine where the ldap server is hosted. |
|
|
|
|
JDBC datasource JNDI where RCU schema is installed. This data store is used to persist the last change number. This property value is useful for last incremental synchronization scenario. (It is required to use if the LDAP adapter must be used on the inbound direction). |
JNDI string location pointing to a valid XA data source. |
OperationTimeout |
Sets the operation timeout. If the response is not received by the Directory Server in the timeout period, the operation will be abandoned and an exception will be raised. |
|
|
secret |
Not required |
|
||
|
Key management protocol, not required. |
|
|
False |
If mentioned, the client will blindly trust any certificated that the server might present. Required only if useSSL or startTLS is selected. |
|
The jsse provider name. |
|
P |
Integer value |
Port where the LDAP service is running on the host. |
|
True/False with default value as false. |
Indicates that LDAP adapter should use SSL to secure communication with the directory server. The server must be configured to listen in SSL mode and the value for the port argument must be one where the server is listening for SSL based connections. |
|
True/False with default value as false. If useSSL is true, then this must be false. |
Use start TLS extended operation to secure communication with a directory server over a non-encrypted channel. Port in this case is listening for clear-text LDAP Connections. |
|
True/false with default value as false. |
If mentioned, the client will blindly trust any certificated that the server might present. TrustStorePath is redundant and ignored if this option is selected. |
|
Must be mentioned if one of useSSL or useStartTLS is set as true. |
Specifies path to the JKS trust store file that the client use for server authentication. |
|
Specifies the password needed to access the trust store contents. In most cases, no trust store password is required. This should not be used in conjunction with the trust store password file option. |
|
|
Set the protocol version enabled for secure connections with the directory server. The protocol must be supported by the SSL Context. |
|
|
A String. Uses the default set of SSL cipher suites provided by the server's JVM. List of comma separated cipher suites allowed by the jsse provider. |
Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. |
The following table lists LDAP Adapter Binding properties. Note that some of the jca properties are applicable on multiple operations. For example, TimeLimit
can be used with EntryChangeNotification
, ChangelogNotification
or search operation. But this same property has the same meaning across these operations.
Table A-21 LDAP Adapter Binding Properties (Common Across All Adapters)
Property Name | Allowed | Description |
---|---|---|
Jca.retry.count |
Indicates maximum number of retries before rejection. |
|
Jca.retry.interval |
Measured in Seconds |
Indicates time interval between retries. |
Jca.retry.backoff |
Positive Integer |
Indicates the retry interval growth factor. |
Jca.retry.maxInterval |
Indicates maximum value of retry interval |
|
Jca.retry.maxPeriod |
Is the upper limit of the entire accumulated duration of all retries; that is, a hard limit.. |
|
Jca.retry.count |
Indicates maximum number of retries before rejection. |
|
Jca.retry.interval |
Measured in Seconds |
Indicates time interval between retries |
Jca.retry.backoff |
Positive Integer |
Indicates the retry interval growth factor |
Jca.retry.maxInterval |
Indicates max value of retry interval |
|
Jca.retry.count |
Indicates maximum number of retries before rejection. |
Table A-22 LDAP Adapter JCA Artifacts for Entry Change Notification
Property Name | Allowed Values | Description |
---|---|---|
BaseDN |
Valid DN under which events should be reported. |
Notify events under this entry. |
EventScope |
Restricted string with value in: { "baseObject", "singleLevel", "subordinates", "wholeSubtree"} |
Scope of event source under the configured basedn. |
EventType |
Value in Unknown macro: {"add", "modify", "all" } |
Unknown macro: {"add", "modify", "all" } If all is selected, then all the events will be published |
SearchFilter |
Valid string representation of LDAP filter |
Advanced filter condition. Events that satisfy the given filter condition only will be published by the adapter. |
ReturnAttributes |
Csv list of all the attributes to return as part of the event. |
- |
ReturnAttributesDelimiter |
String |
Attributes delimiter can be explicitly defined in case the default delimiter ',' is not appropriate. |
TypesOnly |
"true" or "false" with default value as "false" |
When set to true, only the attribute names will be returned. Otherwise, both attribute names and values will be returned. |
SizeLimit |
+ve integer. With default value of 1000. <= 0 implies no sizeLimit will be enforced. |
Maximum number of entries returned as part of a search op. This can be configured on the DS side as well. Lower of the two values will take effect. SizeLimit is enforced within a single page. |
PageSize |
Integer value specifying a pageSize. Note, |
Max number of events that should be published in a page. |
TimeLimit |
Integer value in seconds with default value as 10 seconds. |
Maximum time the server should wait before returning the results. |
NotificationStrategy |
String value: one of "TimeStampBased" |
Persistent search option has been deprecated in the first release. |
PollingInterval |
Integer with default value set to 10 seconds. |
Polling interval before conducting subsequent searches for new events. |
Table A-23 LDAP Adapter JCA Artifacts for Change Log Notification
Property Name | Allowed Values | Description |
---|---|---|
PollingInterval |
Integer with default value set to 10 seconds. |
Polling interval before conducting subsequent searches for new events. |
EventType |
Value in Unknown macro: {"add", "delete", "modify", moddn", "all"} Note that eventType value might vary from Directory Server implementation. For instance, moddn might be modrdn in the case of oid. |
If all is selected, all events are published, Otherwise a comma-separated list of event types to publish will be sent. For example: "add,delete" |
NotificationStrategy |
String value in Unknown macro: {"OJD", "OID" or fully qualified name of the user defined changelog implementation.} |
Unknown macro: {"OJD", "OID" or "fully qualified name of the user defined changelog implementation} Oracle.tip.adapter.ldap.inbound.<customStrategy Impl> . |
TimeLimit |
Integer value in seconds with default value as 0 for no time limit. |
Maximum time the server should wait before returning the results. |
SizeLimit |
Integer value with default value as 1000. |
Maximum number of events that should be published in one trip. |
PageSize |
Integer value specifying a pageSize. Note that sizeLimit implies within a page and not on the total number of entries returned across all the pages in a search. |
- |
Table A-24 LDAP Adapter JCA Artifacts for Search Operation
Property Name | Allowed Values | Description |
---|---|---|
SearchScope |
Restricted string with value in: { "baseObject", "singleLevel", "subordinates", "wholeSubtree"} - Subordinates is not a part of the LDAP specification and is only supported by selected DS. Check your DS server before using this option. |
Defines the search scope. This has to be defined at service deployment to control malignant search request from controlling server resources. |
AliasDereferencing |
Restricted string with value in: Unknown macro: { "never","search", "find", "always"} |
Behavior for handling alias entries while procssing the search. |
FollowReferrals |
Restricted string with value in: Unknown macro: {"ignore","throwException","follow"} By default, ldap adapter ignores all referral suggestions unless explicitly asked to follow or throw exception. |
Alternate locations where additional entries may be searched/matched as part of a search request. |
HopLimit |
Positive integer. Default value of 1. |
Number of alternate locations participating in search referrals. |
SizeLimit |
Integer with default value as 1000. |
Maximum number of entries returned as part of a search op. This can be configured on the DS side as well. Lower of the two values will take effect. |
TimeLimit |
Integer value in seconds with default value as 0 for no time limit. |
Maximum time in seconds the server should wait before returning the results. |
TypesOnly |
"true" or "false" with default value as "false" |
When set to true, only the attribute names will be returned. Otherwise, both attribute names and values will be returned. |
ReturnAttributes |
String value, delimited list of all the attributes that must be returned as part of this search response. |
The default delimiter is ',' Only names attributes will be included as part of search response. |
ReturnAttributesDelimiter |
String |
attributes delimiter can be explicitly defined in case the default delimiter ',' is not appropriate |
Table A-25 LDAP Adapter DSML JCA Artifacts
Property Name | Allowed Values | Description |
---|---|---|
MaxDSMLRequestSize |
Integer value with default value set to 0 for unlimited. |
DSML contains a batch request. This batch request can potentially contain millions of ldap operation requests. This property is used to control the maximum number of permissible operation requests that can be passed to the ldap adapter through a single dsml batch request. |
Table A-26 LDAP Adapter Delete Operation JCA Artifacts
Property | Allowed values | Description |
---|---|---|
Request Controls |
String |
To pass in one or more controls along with the operation. |
SuppressEntryDoesNotExist |
True|false |
A delete operation fails if the entry to delete doesn't exist in the target DS. This exception can be suppressed by specifying this condition on the interaction spec. |
Table A-27 LDAP Adapter Add Operation jca Artifacts
Property | Allowed values | Description |
---|---|---|
SuppressEntryAlreadyExists |
True|false |
Add operation fails if the entry to add already exist in the target DS. This exception can be suppressed by specifying this property on the interaction spec. |
objectClass |
CSV String |
Comma- separated list of all objectClasses that constitute the structure of the entry to be added in the target directory server. |
Table A-28 LDAP Adapter Modify Operation jca Artifacts
Property | Allowed values | Description |
---|---|---|
Request Controls |
String |
To pass in one or more controls along with the operation. |
Table A-29 LDAP Adapter ModifyDN Operation jca Artifacts
Property | Allowed values | Description |
---|---|---|
RequestControls |
String |
To pass in one more controls along with the operation. |
DeleteOldRDN |
N "true" or "false" with default value as "true" |
- |
This section lists Coherence Adapter Properties.
The following table lists Coherence Adapter JCA Properties
Table A-30 Coherence Adapter JCA Properties
Property | Description | Default Value |
---|---|---|
CacheName |
Identifies a particular Coherence cache to be used for a particular operation. A non-retriable error occurs when the Cache as specified by the entry |
None |
Key |
Identifier for a Cache Entry. |
None |
KeyType |
Identifies the java type of the value to be used as the key (currently any simple type from java.lang package). |
None |
ValueType |
Fully qualified class name that identifies the object stored to/retreived from cache. When you indicates to store XML into cache, you do not need to specify ValueType property. If not specified, the Coherence Adapter will convert the payload to a binary XML representation and store/retreive it to/from cache. |
None |
Filter |
Used to specify the subset of cache that the operation should be applied to. The filter expression is based on CohQL and support use of bind variables. |
None |
PageSize |
Specifies the number of items to be returned when a query operation is executed. It is only applicable for cache operations associated with remote caches |
None |
TimeToLive |
The number of milliseconds until the cache entry will expire. It is only applicable for cache operations associated with non-transactional caches. |
|
IndexName |
The name of the index to be added to the cache. To create an index on the attribute 'price' in the cache that stores Book (author.firstName, author.LastName, price) objects, |
None |
Ordered |
Boolean that specified whether contents of indexed information is ordered or not |
False |
MappingsMetadataFile |
Indicates the name of the Metadata mapping file that helps in POJO to. XML and XML to POJO conversion |
None |
CacheOperation |
The operation to be carried out on the Cache identified by CacheName. The supported values for CacheOperation are 'get','put','query' and 'remove'. |
None |
ReturnCacheKeysOnly |
Boolean that allows for only Cache identifiers (keys) to be returned when a Query operation is performed |
False |
The following table lists Coherence Adapter Normalized properties.
Table A-31 Coherence Adapter Normalized Properties
Property | Description |
---|---|
jca.coherence.CacheName |
Name of the Cache to be used for Coherence operations. This overrides 'CacheName' in CoherenceInteractionSpec |
jca.coherence.Key |
Identifies a cache entry. This overrides 'Key' in CoherenceInteractionSpec. |
jca.coherence.Filter |
Specify the filter to be used when performing Coherence operations. This overrides 'Filter' in CoherenceInteractionSpec. |
The following table lists Coherence Adapter Connection Factory Properties
Table A-32 Coherence Adapter Connection Factory Properties
Name | Description | Value |
---|---|---|
|
Specifies the JNDI name of connection factory provided by coherence-transaction.rar |
|
|
Name of the cache service to be associated with the connection. ServiceName is only required for TransactionalCaches. For the non-transaction/extend case it is not required. |
XATransactionalCache - for XA TransactionalCache - for Local cache Leave blank for Remote cache |
|
Location of cache configuration file that defines the cache and extend client settings |
- |
|
Specifies if the classloader used for cache operations is based on the domain classes as bundled with the composite or based on the PojoJarFile property of the JCA managed connection factory. Values are CUSTOM or COMPONENT. If CUSTOM, the association is based on the PojoJarFile property. If COMPONENT, it is based on the domain classes bundled along with the composite. CUSTOM is used when the same cache needs to be used across composite boundaries or from different OSB processes. COMPONENT is used when all cache operations are embedded within the same composite or OSB process. |
CUSTOM |
|
Specifies if the Extend Proxy is a standalone or running as part of WLS server. If false, it is a standalone Extend Proxy; otherwise not. Applicable only for the Remote Case. |
|
|
Specifies the location of domain classes that will be used for the cache operations. |
- |
This section describes MSMQ JCA Adapter properties.
Table A-33 MSMQ Adapter JCA Properties
Property | Description | Default Value | Required |
---|---|---|---|
|
Indicates if the message will be sent to a public queue, private queue or a group of queues as identified by the distribution list name. The values are:
|
None |
Yes |
|
Name of the MSMQ queue. |
None |
Yes, if UseActiveDirectoryPath is False |
|
The string that identifies a DistributionList or Public queue as represented in ActiveDirectory. An example string is listed below; LDAP://MyLDAPServer/CN=MyQueue,CN=msmq,CN=MyComputer,CN=Computers,DC=MyDomain,DC=MyCompany,DC=COM |
None |
Yes, if UseActiveDirectoryPath is True |
|
Boolean that allows for Active Directory Path to be used to identify a public queue instead of queue name. This property is applicable when DestinationType is ‘ |
False |
Applicable only to outbound(Enqueue) operation. This property is not applicable for inbound(Dequeue). Dequeue is not supported for Distribution lists. |
|
Boolean that allows for Direct Format name to be used for public and private queues. |
False |
- |
|
Priority can be set to any integer value between 7 and 0 (the default is 3). 7 means higher priority. 0 means lowest priority. Highest priority implies faster processing. Applicable to outbound Enqueue only |
3 |
- |
|
This property specifies a time limit (in seconds) for the message to be retrieved from the target queue. The value is assigned to |
-1 (infinite) This implies that the message never expires. |
- |
|
The property is used to specify express (non-persistent) or recoverable (persistent) messaging. Express messaging provides faster throughput. Recoverable messaging guarantees that the message will be delivered even if a computer crashes while the message is en route to the queue. The values are: Persistent, Non-Persistent, Applicable to outbound Enqueue only |
Persistent |
- |
|
The operation to be carried out. The supported values for OperationType are |
None |
Yes |
|
Values are |
String |
Yes |
|
Boolean that enables payload to be streamed. Applicable only for inbound dequeue process |
False |
- |
The following table lists MSMQ Adapter Normalized Properties.
Table A-34 MSMQ Adapter Normalized Properties
Property Name | Description | Direction |
---|---|---|
|
The property indicates when a message is sent. |
Inbound |
|
The property specifies a message's priority. This overrides |
Inbound/Outbound |
|
The property specifies a time limit (in seconds) for the message to be retrieved from the target queue. This overrides |
Inbound/Outbound |
|
The property specifies a time limit (in seconds) for the message to reach the queue. Message Queuing uses the enterprise-wide setting for the time-to-reach-queue interval if none is specified here. |
Inbound/Outbound |
|
Identifies the message using an MSMQ-generated message identifier. |
Inbound |
|
Values can be |
Inbound/outbound |
|
The property provides the length of the message body in bytes. |
Inbound |
|
The property indicates when the message arrived at the queue. |
Inbound |
The following table lists MSMQ Adapter Binding properties.
Table A-35 MSMQ Adapter Binding Properties
Property Name | Description |
---|---|
|
The time (in milliseconds) that Message Queuing will wait for a message to arrive before starting another poll-cycle. The default value is one second (1). |
|
Number of poller threads that will be initialized when endpoint activation occurs. When specified, the value of |
The following table lists MSMQ Adapter Connection Factory Properties.
Table A-36 MSMQ Adapter Connection Factory Properties
Property Name | Description | Default |
---|---|---|
|
IP Address of the MSMQ host. |
This value can be the host name and the IP address can be given as the value for the Host property. |
|
Identifies if the connection factory will allow for native access or not. Values are [ |
DCOM |
|
Indicates if the connection will participate in a transaction when sending and receiving a message. Values are [Single|None].If Single, the local and remote MSMQ queues to which the message is sent should be transactional. If Single, the local MSMQ queue from which the message is retrieved should be Transactional.If None and the queues to which the message is sent are transactional, there will be a ResourceException. |
|
User |
Identifies a user |
- |
Password |
Password for the user specified. |
- |
|
Domain of the MSMQ host. |
- |
This section describes the properties applicable to the UMS Adapter.
The following table lists UMS Adapter activation spec properties.
Table A-37 UMS Adapter Activation Spec Properties
Property Name | Description |
---|---|
|
Name of the Java class that defines custom logic for a message filtering or any other check. This class is a concrete implementation of the ICustomCallout interface. |
|
Specifies the number of inbound poller or listener threads. |
|
Specifies how the adapter will receive messages from UMS. Set to poller for polling mode Or set to listener for listener mode. |
|
Address from which to receive incoming messages. One or more comma separated email address for the Email delivery type. |
|
Email support is provided for receiving and sending outgoing messages. |
|
Polling interval in seconds for poller consume mode. |
|
Specify one or more message filters. A single filter would comprise of a Java Pattern String to match the incoming message against, along with the field type and the action (Accept or reject) to be taken. |
The following table describes UMS Adapter Interaction Spec Properties.
Table A-38 UMS Adapter Interaction Spec Properties
Property Name | Description |
---|---|
|
Email support for only receive and sending outgoing messages. |
|
Subject of Outgoing Message |
|
Sender addresses of outgoing message |
|
One or more recipient addresses |
|
Reply-To address |
|
One or more cc addresses for email delivery. |
|
One or more Bcc addresses for email delivery |
|
|
The following table describes UMS Adapter message headers.
Table A-39 UMS Adapter Message Headers
Header Field Name | Minimum Occurrence | Maximum Occurrence | Mapped Adapter Header Field Name |
---|---|---|---|
|
0 |
1 |
|
|
0 |
unlimited |
|
|
0 |
unlimited |
|
|
0 |
unlimited |
|
|
0 |
1 |
|
|
0 |
unlimited |
j |
|
0 |
unlimited |
|
|
0 |
unlimited |
|
|
0 |
unlimited |
|
|
1 |
1 |
j |
|
1 |
1 |
|
|
0 |
1 |
|
|
0 |
1 |
|
|
0 |
1 |
|
Cc |
0 |
1 |
|
Bcc |
0 |
1 |
j |
|
0 |
1 |
|
|
0 |
1 |
|
|
0 |
1 |
|
|
0 |
1 |
|
|
0 |
unlimited |
|
|
0 |
unlimited |
|
The following table describes UMS Adapter mime-part message headers.
Table A-40 UMS Adapter Mime-Part Message Headers
Header Field Name | Mapped Adapter Header Field Name | Notes |
---|---|---|
Content-Type |
|
Applicable to all channels. For SMS and IM, the current supported type is |
Content-Transfer-Encoding |
|
- |
Content-ID |
|
- |
Content-Description |
|
- |
Content-Disposition |
|
- |
Content-Language |
j |
- |
Mime-Extension-field |
|
Any other mime header field hat begins with the string “Content-“. You can add more than one header as
|
MIME-Version |
|
- |
The following table describes UMS Adapter proprietary headers.
Table A-41 UMS Adapter Proprietary Headers
Header Name | Description |
---|---|
j |
More than one proprietary header can be added in the following format: Header Name : value CRLF Header Name : value (Header Name – should be similar to ums.adapter.xxxxx CRLF - \r\n) |
This section describes the properties applicable to all Oracle JCA Adapters, including:
For properties specific to each of the Oracle JCA Adapters, see:
Table A-42 JCA Properties for all Oracle JCA Adapters
|
This section describes the properties applicable to all Oracle JCA Adapters, including:
For properties specific to each of the Oracle JCA Adapters, see:
Table A-43 Binding Properties for all Oracle JCA Adapters
|