Oracle® Fusion Middleware User's Guide for Technology Adapters 11g Release 1 (11.1.1) Part Number E10231-03 |
|
|
View PDF |
This appendix lists and describes the properties of Oracle JCA Adapters.
This appendix includes the following sections:
For more information, see Chapter 33, "Configuring Service and Reference Binding Components", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.
This section describes the properties applicable to the Oracle File and FTP Adapters, including:
Table A-1, "JCA Properties for Oracle File and FTP Adapters"
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"
For properties applicable to all Oracle JCA Adapters, see Section A.7, "Generic Oracle JCA Adapter Properties".
For more information, see:
Section 33.1.2.3, "Oracle File Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite
Section 33.1.2.4, "Oracle FTP Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite
Table A-1 JCA Properties for Oracle File and FTP Adapters
Property | Description |
---|---|
|
If this property is set to The file name can either be specified in the |
|
If set to |
|
Set it to the batch size for the batching transformation. |
|
Set it to the character set for the attachment. This parameter is not used internally by the Oracle File and FTP Adapters, and it is meant for third party applications that process the attachments published by the Oracle File and FTP Adapters. |
|
Set it to the chunk size for the chunked interaction operation. |
|
The maximum number of translation activities that can be allowed to execute in parallel for a particular outbound scenario. The translation step during the outbound operation is CPU-intensive and must be guarded because it might cause other applications or threads to starve. The maximum value is |
|
Set it to the mime-type of the attachment. This parameter is not used internally by the Oracle File and FTP Adapters, and it is meant for third party applications that process the attachments published by the Oracle File or FTP Adapter. |
|
If set to |
|
When you choose multiple directories, the generated JCA files use semicolon ( |
|
This property is used for outbound batching. When the time specified elapses, the outgoing file is created. The parameter is of type |
|
Set it to the encoding used for the attachment. This parameter is not used internally by the Oracle File and FTP Adapters, and it is meant for third party applications that process the attachments published by the Oracle File and FTP Adapters. |
|
This property specifies the pattern for types of files to be excluded during polling. The property is of type |
|
Use this parameter to specify a static single file name during the write operation. |
|
This property is used for the naming convention for the outbound write operation file. |
|
This property is used for outbound batching. The outgoing file is created when the file size condition is met. The parameter is of type |
|
This property specifies the pattern for types of files to pick up during polling. The parameter is of type |
|
If set to |
|
This property specifies the sorter that the Oracle File and FTP Adapters use to sort files in inbound. You can set this parameter to:
|
|
This property specifies the logical directory in which to archive successfully processed files. The property is of type |
|
This parameter specifies the logical input directory to be polled. The parameter is of type |
|
This property specifies the maximum number of files that the Oracle File or FTP Adapter submits for processing in each polling cycle. For example, if the inbound directory has 1000 files and |
|
This parameter specifies the minimum age of files to be retrieved. This enables a large file to be completely copied into the input directory before it is retrieved for processing. The age is determined by the last modified time stamp. For example, if you know that it takes three to four minutes for a file to be written, then set the minimum age of pollable files to five minutes. If a file is detected in the input directory and its modification time is within five minutes of the current time, then the file is not retrieved because it is still potentially being written to. |
|
This property is used for outbound batching. The outgoing file is created when the number of messages condition is met. The parameter is of type |
|
This property specifies where to archive successfully processed files. The property is of type |
|
This property specifies the physical input directory or directories to be polled. The parameter is of type |
|
This parameter specifies how often to poll a given input directory for new files. The parameter is of type |
|
This property indicates whether the file contains multiple messages and how many messages to publish to the BPEL process at a time. The parameter is of type For example, if a certain file has 11 records and this parameter is set to 2, then the file will be processed 2 records at a time and the final record will be processed in the sixth iteration. |
|
If this property is set to |
|
Specifies the Oracle database sequence name to be used if you have already configured the outbound Oracle File or FTP Adapter for High Availability. |
|
If the value is |
|
The source file for the File IO operation. |
|
The source directory for the File IO operation. |
|
Set it to the schema for the source file. |
|
Set it to the root element name for the source file. |
|
Set this to |
|
The target file for the File IO operation. |
|
The target directory for the File IO operation. |
|
Set it to the schema for the target file. |
|
Set it to the root element name for the target file. |
|
Set this to |
|
If this property is available, then the adapter creates its own processor threads rather than depend on the global thread pool processor threads (by deafult, 4 of them). In other words, this parameter partitions the in-memory queue and each composite application gets its own in-memory queue.
|
|
The name of the trigger file that activates the inbound Oracle File or FTP Adapter. |
|
The directory path where the Oracle File or FTP Adapter looks for the trigger files. |
|
This property defines the strategy that the Oracle File or FTP Adapter uses to look for the specified trigger file in the trigger file directory. The acceptable values are |
|
Set it to |
|
This parameter can be set to This is typically used in large payload scenarios where the inbound adapter is used as a notifier. |
|
If set to |
|
Set it to the |
Table A-2 JCA Properties Specific to Oracle FTP Adapter
Property | Description |
---|---|
|
Set this property to either |
|
Set this property to |
|
Set this property to |
|
Set this property to |
|
Set this property to |
Table A-3 Binding Properties for Oracle File and FTP Adapters
Property | Description |
---|---|
|
Lets you control the behavior of the inbound Oracle File Adapter during the polling operation. If set to |
|
Set it to |
|
This property is applicable only if |
|
This property is used to override the encoding specified in the NXSD schema for inbound Oracle File and FTP Adapters. |
|
Setting to |
|
This property lets you control the size of rejected messages for inbound Oracle File or FTP Adapter partner link. For example, if you set it to |
|
Number of times that inbound Oracle File and FTP Adapters retry to establish a database connection in distributed polling scenarios. |
|
Number of milliseconds after which inbound Oracle File and FTP Adapters retry to establish a database connection in distributed polling scenarios. |
|
Set it to the class name that specifies the mutex that you want to use for the outbound write operation. This class must extend the |
|
Setting to |
|
This property is used by the inbound highly available adapter when using |
|
This property is used by the inbound highly available adapter when using |
|
This property is used by the inbound adapter to configure the recovery interval in case of errors. For example, if the physical directory is nonexistent, then the adapter uses this value to perform periodic sleep or wakeup checks to check whether the physical directory has been created and is accessible. |
|
If set to |
|
This property is used by inbound Oracle File or FTP Adapter during read-only polling in a clustered environment. Setting it to |
Table A-4 Binding Properties Specific to Oracle FTP Adapter
Property | Description |
---|---|
|
This property is used by the Oracle FTP Adapter to handle time zone issues, typically to convert the time difference between the FTP server and the system on which the Oracle FTP Adapter is running to millisecond. |
Table A-5 JCA Properties for Oracle File Adapter: Normalized Properties
Property | Description |
---|---|
|
This property specifies the name of the file read from the inbound directory or written to the outbound directory. |
|
This property specifies the name of the directory from which file is read from or written to. |
|
This property specifies the size of the file published from the inbound Oracle File Adapter. |
|
This property is used to specify a unique identifier for the file being published from the inbound adapter. |
|
If a file has multiple messages and de-batching is used, then this normalized property specifies the message (record) number from the same batch. In this case, the |
Table A-6 JCA Properties for Oracle FTP Adapter: Normalized Properties
Property | Description |
---|---|
|
This property specifies the name of the file read from the inbound directory or written to the outbound directory. |
|
This property specifies the name of the directory from which file is read from or written to. |
|
This property specifies the size of the file published from the inbound Oracle File Adapter. The size can be zero. |
|
This property is used to specify a unique identifier for the file being published from the inbound Oracle FTP Adapter. |
|
If a file has multiple messages and de-batching is used, then this normalized property specifies the message (record) number from the match batch. In this case, the |
This section describes the properties applicable to the Oracle Socket Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Section A.7, "Generic Oracle JCA Adapter Properties".
For more information, see Section 33.1.2.7, "Oracle Socket Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-7 JCA Properties for Oracle Socket Adapter
Property | Description |
---|---|
|
Byte order of the remote machine being communicated with. |
|
If |
|
Character encoding used by the remote computer. |
|
In case of outbound, the computer name on which the socket server is running, to which you want to connect. In case of inbound, it is always |
|
In case of outbound, it is the port number on which a socket server is running, to which the adapter will be connecting. In case of inbound, it is the port number on which the socket adapter listens for incoming connections. |
|
If |
|
Mechanism for defining the protocol. Set to |
|
If |
This section describes the properties applicable to the Oracle AQ Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Section A.7, "Generic Oracle JCA Adapter Properties".
For more information, see Section 33.1.2.1, "Oracle AQ Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-8 JCA Properties for Oracle AQ Adapter
Property | Description |
---|---|
|
The name of the AQ Queue being read from or written to. |
|
The schema where the queue resides. If not specified, the schema of the current connection will be used. |
|
When this property is set to |
|
When this property is set to |
|
Specify the consumer name or names that are the intended recipients for the messages enqueued by the adapter. The message remains in the queue until all recipients have dequeued the message. If the field is left empty, then all the currently active consumers are recipients. |
|
Applicable only for multi-consumer queues. If specified, only the messages targeted for the particular consumer will be made available for processing. |
|
This property is used to identify the field containing the business payload if the queue is an ADT queue. You can specify an attribute of ADT to constitute a payload or an entire ADT to represent payload. In former case the 'ObjectFieldName' should be same as the attribute name of the ADT. In latter case this property is not specified. |
|
Only applicable if the |
|
When a dequeue is performed from a multiconsumer queue, it is sometimes necessary to screen the messages and accept only those that meet certain conditions. These conditions can be based on payload or queue header values and is specified using |
|
This property is valid for dequeue operations only. Enter a Boolean expression similar to the |
|
You can assign an identifier to each message, thus providing a means to retrieve specific messages at a later time. The value to enter is agreed upon between the enqueuing sender and the dequeuing receiver for asynchronous conversations. This can be overridden on a per message basis through the normalized message property, |
|
This property exposes a configurable control mechanism through which you can specify the payload size threshold in the adapter layer. The messages that have sizes beyond the configured threshold limit are rejected. If this property is not configured, it does not impose any restriction on the size of messages. |
Table A-9 JCA Properties for Oracle AQ Adapter: Normalized Properties
Property | Description |
---|---|
|
The number of failed attempts at dequeuing the message. |
|
User-assigned correlation ID. |
|
The number of seconds after which the message is available for dequeuing. |
|
The time at which the message was enqueued. |
|
The exception queue name. |
|
The number of seconds before the message expires. This parameter is an offset from the |
|
The hexadecimal representation of the message ID for the dequeued message. |
|
The hexadecimal representation of the original message ID. |
|
Priority of the message. A smaller number indicates a higher priority. The priority can be any number. The default value is zero. |
|
The list of recipients for this message, separated by commas. This overrides |
|
Contains string or DOM of current headers (XML DOM representation of payload headers.) |
Table A-10 Binding Properties for Oracle AQ Adapter
Property | Description |
---|---|
|
The time for which the Oracle AQ Adapter will wait before trying to re-create a connection after a connection is lost. The default value is 15s. |
|
It is the interval after which the |
|
Specifies the number of poller threads that are created when an endpoint is activated. The default value is 1. |
This section describes the properties applicable to the Oracle JMS Adapter, including:
For properties applicable to all Oracle JCA Adapters, see Section A.7, "Generic Oracle JCA Adapter Properties".
For more information, see Section 33.1.2.5, "Oracle JMS Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-11 JCA Properties for Oracle JMS Adapter
Property | Description |
---|---|
|
The name of the queue or topic being read from or written to. |
|
The only value of this property supported in the current version is false. A value of |
|
This property specifies the type of JMS message that is being dequeued or enqueued by the adapter. For Map messages the value is |
|
Name used to identify a durable subscription. When working with durable subscriptions ensure that ClientID is also specified in addition to |
|
A string whose syntax is based on a subset of the SQL92 conditional expression syntax and lets you specify the messages adapter is interested in, by using header field references and property references. Only messages whose header and property values match the selector are delivered. |
|
Only applicable when dealing with messages of type |
|
Only applicable when dealing with message of type |
|
This property is applicable for a synchronous request-reply scenario and specify the name of destination for sending a message. |
|
This property is applicable for a synchronous request-reply scenario and specify the name of destination for receiving a reply. |
|
This property is applicable for a synchronous request-reply scenario. When set to |
|
When this property is set to |
|
Represents the delivery mode to use. The message producer's default delivery mode is |
|
Represents the message's lifetime (in milliseconds). The message producer's default time to live is unlimited; the message never expires. A value of |
|
This property exposes a configurable control mechanism through which you can specify the payload size threshold in the adapter layer. The messages that have sizes beyond the configured threshold limit are rejected. If this property is not configured, it does not impose any restriction on the size of messages. |
|
Represents priority for this message. The message producer's default priority is 4. This can be overridden on a per message basis using normalized message property |
Table A-12 JCA Properties for Oracle JMS Adapter: Normalized Properties
Property | Description |
---|---|
|
This property specifies the destination to which the message is sent, and is set by the JMS producer. |
|
This property represents the properties that define the context used to look up the destination object to which the message must be sent |
|
This property is set by both producers and consumers for linking the response message with the request message. This is an optional attribute. |
|
This property specifies the JMS message type. |
|
This is an optional attribute that indicates the destination to which a message reply must be sent. |
|
This property is used by the consumer to set a priority number between 0 and 9. Larger numbers represent a higher priority. |
|
This property specifies the duration of the message before the expiration. When a message's expiration time is reached, the JMS provider should discard it. |
|
This property is set to |
|
This property is used to specify a unique message identifier. The exact scope of uniqueness is provider-defined. |
|
This property is used as an indication of whether a message is being re-delivered. If a client receives a message with the JMSRedelivered field set, it is likely, but not guaranteed, that this message was delivered earlier but that its receipt was not acknowledged at that time. |
|
This property is used to specify the time when the message was handed off to the JMS provider to be sent. |
|
This property represents any custom (application-specific) properties of the message. |
|
This property represents any MapMessage element that is not transferred as payload. |
Table A-13 Binding Properties for Oracle JMS Adapter
Property | Description |
---|---|
|
Used to encode inbound text messages. This property is superseded by the newly supported property called |
|
Specifies the number of poller threads that are created when an endpoint is activated. The default is 1. |
|
Timeout value used for the synchronous receive call. It is the time after which receive() API will time out if no message is received on the inbound queue. The default value is 1s. |
|
This property is not supported anymore. |
|
Used by the inbound connection retry layer. The time for which the Oracle JMS Adapter will wait before trying to re-create a connection after a connection is lost. The default value is 30s. |
|
Declaratively impose custom property settings on Destination objects received during inbound request/reply scenarios. |
|
Used to specify whether correlation Id should be used for correlation. Valid values are |
|
Used to specify whether message Id should be used for correlation. Valid values are |
|
The boolean property specifies if the reply message TTL is set to 0 (message never expires) or some specified value related to message expiration. The default value is false. |
|
If the same small number of JMS receivers are used for the same request destination repeatedly, then set this property to |
|
Applicable for a synchronous request-reply scenario. If set to |
|
Used to bypass headers. For scenarios in which a composite does not use or produce the headers, the value of |
This section describes the properties applicable to the Oracle Database Adapter, including:
Table A-14, "JCA Properties for Oracle Database Adapter: Instance Properties"
Table A-15, "JCA Properties for Oracle Database Adapter: Normalized Message Properties"
For properties applicable to all Oracle JCA Adapters, see Section A.7, "Generic Oracle JCA Adapter Properties".
For more information, see:
Section 33.1.2.2, "Oracle Database Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.
Appendix H, "Normalized Message Properties", in the Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite.
Table A-14 JCA Properties for Oracle Database Adapter: Instance Properties
Property | Description |
---|---|
|
This is a mandatory property. Refers to the JNDI name ( |
|
The default value is |
|
This is a mandatory property. This points to the type of database being connected to. The suggested values for this property are:
You also can give the full package and class name of a subclass of |
|
The default value is |
|
The default value is |
|
The default value is |
|
This is a mandatory property. It specifies the JNDI name ( |
Table A-15 JCA Properties for Oracle Database Adapter: Normalized Message Properties
Property | Description |
---|---|
|
Inbound/Outbound |
|
Outbound. |
|
Outbound. You cannot assign values to the |
|
Outbound. When set, specifies |
|
Outbound. When set, specifies |
|
Outbound. Valid values are |
|
Outbound. When set, specifies |
|
Outbound. Set to define the roles associated with the proxy user. The value should be a |
|
Outbound. When set, specifies |
|
Outbound. You cannot assign values to the |
|
Outbound. |
Footnote 1 For more information, see Section 9.3.4, "Proxy Authentication Support".
This section describes the properties applicable to the Oracle MQ Series Adapter, including:
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"
For properties applicable to all Oracle JCA Adapters, see Section A.7, "Generic Oracle JCA Adapter Properties".
For more information, see Section 33.1.2.6, "Oracle MQ Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-16 JCA Properties for Oracle MQ Series Adapter
Property | Description |
---|---|
|
This property specifies the name of the MQ Queue for sending or retrieving messages. |
|
This property specifies the type of message: Normal, Request, Reply, or Report |
|
This property specifies the type of MQ message format, such as Default, and Request/Reply. |
|
This property specifies the message priority. Its value ranges from |
|
This property is used to set the message persistence. The message persists when this property is set to |
|
This property is used when message delivery fails. The default value is |
|
This property is used for partial delivery to a distribution list. The default value is |
|
This property is used when the size of the message is larger than the maximum limit set on the queue. |
|
This property specifies the time after which the message would be removed by the Queue Manager. The default value is |
|
This property specifies the name of the queue to which the reply or report must be sent. |
ReportCOA |
If this property is set, then a confirmation on arrival report is sent to the replyto queue on arrival of a message in the destination queue. The default value is |
ReportCO |
If this property is set, then a confirmation on delivery report is sent to the replyto queue on arrival of a message in the destination queue. The default value is |
ReportException |
If this property is set, then an exception report is sent to the replyto queue when message delivery to the destination queue fails. The default value is |
ReportExpiry |
If this property is set, then an expiry report is sent to the replyto queue when a message sent to the destination queue expires. The default value is |
WaitInterval |
This property specifies the waiting interval for dequeuing the message in outbound MQ queue. |
MessageId |
This property is used to generate a Message Id for a reply or a report message. By default a new Message Id is generated. |
CorrelationId |
This property is used to generate a correlation Id for a reply or a report message. By default the message Id of the request message is used as the correlation Id. |
QueueOpenOptions |
This property specifies the queue open options to use while accessing the queue. |
SecondaryQueueManagerName |
This property specifies the queue manager for the enqueue queue. This should be used only when the outbound enqueue queue resides outside the inbound queue manager. |
BackoutQueue |
This property is used to specify a backout queue to which rejected messages from an inbound queue are to be sent. |
BackoutQueueManagerName |
This property is used to specify the queue manager for the backout queue. This should be used only when the Backout Queue resides outside the inbound queue manager. |
MaximumBackoutCount |
This property is used to specify the maximum backout retry count after which rejected message is sent to the backout queue. |
BackoutInterval |
This property is used to specify intervel between the backout retries. The default value is 5 seconds. |
BackoutRetries |
This property is used to specify the number of backout retries. The default value is 3. |
FallbackReplyToQueueName |
This property is used for sending the report to Normal message. |
FallbackReplyToQueueManagerName |
This property is used when the Primary Queue Manager specified in JNDI connection cannot access the queue. |
DistributionList |
This property is used to specify the elements of the distribution list for enqueuing the message. |
Table A-17 JCA Properties for Oracle MQ Series Adapter: Normalized Properties
Property | Description |
---|---|
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
|
Inbound/Outbound |
Table A-18 Connection Properties for Oracle MQ Series Adapter
Property | Description |
---|---|
|
Name of the host computer. |
|
Port number to be used. |
|
Set it to the server connection channel to be used. |
|
A valid queue manager name. |
|
Set |
|
Character encoding used by the client. |
|
Location of the connection factory. |
|
Operating system used by the host computer. |
|
Algorithm used by the key store. |
|
This value is the keystore where Oracle MQ Series Adapter will have its private keys. This is required when an adapter needs to authenticate itself to the MQ Series server. |
|
This value is the password that is required to access keystore. |
|
The name of the keystore provider. |
|
This is the location where the adapter keeps its trusted certificates information. This information is required when an adapter needs to authenticate to the MQ Series server. |
|
This property specifies the password of the Trust Store location. |
|
This property specifies the type of the key store. |
|
Key Management Algorithm. |
|
A distinguished name pattern. If |
|
The true or false value for this property means that the Oracle MQ Series Adapter is SSL enabled or SSL disabled. |
|
This property is used if credential mapping is not set. |
|
This is the password to connect to the queue manager. This property is used if credential mapping is not set. |
|
This property is used to enable or disable XA transactions. If set to |
|
This is the |
|
This is the |
|
This is the |
Table A-19 Binding Properties for Oracle MQ Series Adapter
Property | Description |
---|---|
|
This property is used to specify the name of the inbound MQ queue. |
|
This property is used for dequeuing the messages with binary zero value. The default value for this property is |
This section describes the properties applicable to all Oracle JCA Adapters, including:
For properties specific to each of the Oracle JCA Adapters, see:
For more information, see Section 33.1.2.8, "Oracle JCA Adapters Endpoint Properties", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.
Table A-20 JCA Properties for all Oracle JCA Adapters