Oracle® Fusion Middleware User's Guide for Technology Adapters 11g Release 1 (11.1.1) Part Number E10231-02 |
|
|
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.
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"
For properties applicable to all Oracle JCA Adapters, see 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
Section 33.1.2.4, "Oracle FTP Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA 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 specifies whether the Oracle File or FTP Adapter inbound directory is being polled in a distributed fashion. In other words, there are more than one processes polling the same directory in one or more managed servers. |
|
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. |
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 Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.
Table A-5 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:
Table A-6, "JCA Properties for Oracle AQ Adapter: Normalized Properties"
Table A-7, "JCA Properties for Oracle AQ Adapter: Endpoint Properties"
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 Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.
Table A-6 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. |
|
The hexadecimal representation of the original message ID. |
|
Priority of the message. A smaller number indicates a higher priority. |
|
The list of recipients for this message, separated by commas. This overrides |
Table A-7 JCA Properties for Oracle AQ Adapter: Endpoint Properties
Property | Description |
---|---|
|
The time for which the Oracle AQ Adapter will wait before trying to re-create a connection after a connection is lost. |
|
It is the interval after which the |
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 Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.
Table A-8 JCA Properties for Oracle JMS Adapter: Normalized Properties
Property | Description |
---|---|
|
Used to encode the text message. |
|
Supports multiple inbound receivers. |
|
Timeout value used for the synchronous receive call. Valid only if |
|
This value is typically set higher because you do not have to register the |
|
Used by the inbound connection retry layer. |
|
The destination to which the message is sent, and is set by the JMS producer. |
|
Set by both producers and consumers for linking the response message with the request message. This is an optional attribute. |
|
Set to persistent or nonpersistent mode by the JMS producer. |
|
Duration of the message before the expiration is set by the producer. |
|
Unique message identifier set by the consumer. |
|
Number between |
|
Set by the JMS provider to indicate that the provider has tried to send this message once before to the consumer and has failed. |
|
Optional attribute indicating the destination to which to send a message reply. Can be set by the producer and consumer. |
|
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 |
|
Time stamp when the message was sent to the JMS provider for forwarding. |
|
JMS message type. |
|
If the same small number of JMS receivers are used for the same Request destination repeatedly, it will improve performance to set this property to |
|
If Note: the JMS adapter uses the following message selector: |
|
Bypass headers. For scenarios in which BPEL application does not use/produce these headers. Improves performance. |
This section describes the properties applicable to the Oracle Database Adapter, including:
Table A-9, "JCA Properties for Oracle Database Adapter: Instance Properties"
Table A-10, "JCA Properties for Oracle Database Adapter: Normalized Message Properties"
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 Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.
Appendix H, "Normalized Message Properties", in the Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite.
Table A-9 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-10 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 Proxy Authentication Support.
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.6, "Oracle MQ Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.
Table A-11 JCA Properties for Oracle MQ Series Adapter
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-12 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 |
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.
Table A-13 JCA Properties for all Oracle JCA Adapters