A Oracle JCA Adapter Properties

This appendix describes the JCA and binding properties that are applicable to Oracle JCA Adapters.

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.

If you are configuring newly created adapters in Reference Configuration mode, you can modify JCA Adapter endpoint properties directly in the Adapter Configuration Wizard. See JCA Endpoint Properties in the Adapter Configuration Wizard.

This appendix includes the following sections:

For more information, see Configuring Service and Reference Binding Components in Administering Oracle SOA Suite and Oracle Business Process Management Suite.

A.1 JCA Endpoint Properties in the Adapter Configuration Wizard

Beginning with Release 12c (12.2.1.4), you can create either a Reference Configuration domain or a Classic domain on the Templates screen in the Configuration Wizard during installation. A Reference Configuration domain guards servers from running into out-of-memory, stuck threads, endpoint connectivity, and database issues. A Reference Configuration domain supports SOA, OSB, SOA + OSB, and B2B topologies.

Developing a SOA or Service Bus project in Reference Configuration mode means that you enable Reference Configuration settings in JDeveloper so that new adapters that you create in the application will have special JCA endpoint properties defined in their source files. You can modify these properties directly in the Adapter Configuration Wizard for projects newly created in Release 12c (12.2.1.4). The changes are updated in the corresponding target file.

Note:

You will not see JCA Endpoint Properties screens in the Adapter Configuration Wizard for projects migrated from previous releases even if you have enabled Reference Configuration settings in adapters in JDeveloper.

For more information about the Reference Configuration domain and settings, see:

Table A-1 JCA Properties in the Adapter Configuration Wizard

Property Adapter Inbound Outbound Target File

Thread Count

File Adapter

ThreadCount = -1

JCA file

<property name="ThreadCount" value="-1"/>

MQ Adapter

InboundThreadCount = 1

JCA file

<property name="InboundThreadCount" value="1"/>

DB Adapter

NumberOfThreads = 1

JCA file

<property name="NumberOfThreads" value="1"/>

JMS Adapter

adapter.jms.receive.threads = 1

adapter.jms.receive.timeout = 1000 (ms)

composite.xml - as binding properties

<property name="adapter.jms.receive.threads" type="xs:String" many="false" override="may">1</property>

<property name="adapter.jms.receive.timeout" type="xs:String" many="false" override="may">1000</property>

AQ Adapter

adapter.aq.dequeue.threads = 1

DequeueTimeOut=1 (in second)

composite.xml - as binding properties

<property name="adapter.aq.dequeue.threads" type="xs:String" many="false" override="may">1</property>

<property name="DequeueTimeOut" type="xs:String" many="false" override="may">1</property>

Enable elastic WorkManager

JMS Adapter

File and FTP Adapter

adapter.jms.SinglePollCycle = true

composite.xml - as binding properties

<property name="adapter.jms.SinglePollCycle" type="xs:String" many="false" override="may">true</property>

Set MaxTransactionSize and MaxRaiseSize

DB Adapter (Polling Only)

MaxTransactionSize = 10

MaxRaiseSize = 1

JCA file

<property name="MaxTransactionSize" value="10"/>

<property name="MaxRaiseSize" value="1"/>

ConcurrentThreshold

File Adapter (Write Only)

ConcurrentThreshold = 20

JCA file

<property name="ConcurrentThreshold" value="20"/>

PublishSize and ChunkSize

File Adapter (Read Only)

PublishSize = 1

FileAdapter (Chunked Read only)

ChunkSize = 10

JCA file

<property name="PublishSize" value="10"/>

Define finite retries

All Adapters

jca.retry.count = 5

jca.retry.interval = 2

jca.retry.backoff = 2

-

composite.xml - as binding properties

<property name="jca.retry.count" type="xs:int" many="false" override="may">5</property>

<property name="jca.retry.interval" type="xs:int" many="false" override="may">2</property>

<property name="jca.retry.backoff" type="xs:int" many="false" override="may">2</property>

Set payloadSizeThreshold

All Adapters

payloadSizeThreshold=10 MB

-

composite.xml - as binding properties

<property name="payloadSizeThreshold" type="xs:int" many="false" override="may">10000000</property>

Use eis/HAFileAdapter as JNDI name

File Adapter

location="eis/HAFileAdapter"

location="eis/HAFileAdapter"

JCA file

<connection-factory UIincludeWildcard="*" location="eis/HAFileAdapter"/>

Detailed information related to adapter properties such as descriptions and recommended values is provided in the topics for each adapter.

A.2 Generic Oracle JCA Adapter Properties

Table A-2 JCA Properties for all Oracle JCA Adapters

Property Description

wsdlLocation

An optional adapter-config attribute of type xs:string.

When set to the name of the WSDL associated with the adapter's JCA file, Oracle Service Bus can automatically resolve the WSDL to allow bulk import of JCA files and related WSDL and schemas.

The following example shows the FulfillmentBatch_jms.jca file with the adapter-config attribute wsdlLocation set to the name of the corresponding WSDL file FulFillmentBatch.wsdl.

<adapter-config name="FulfillmentBatch" adapter="Jms Adapter" xmlns="http://platform.integration.oracle/blocks/adapter/fw/metadata" wsdlLocation="FulfillmentBatch.wsdl" >
...
</adapter-config>

A.3 Generic Oracle JCA Adapter Binding Properties

Table A-3 Generic Oracle JCA Adapters Binding Properties

Property Description

activationInstances

Deprecated, because each adapter now natively supports multithreading. However, the property still works and controls how many instances of a particular inbound JCA activation agent will be spawned. The property can thus be used to increase concurrency. The activationInstances property can be dynamically updated by using the BPEL console (Descriptor page) and makes the adapter framework either spawn more instances or shutdown existing instances on the fly (in the shutdown case, in reverse order, that is, the highest instance number will be shut down first).

enableReports

Set to true, enables Adapter Reports to be generated in Fusion Middleware Control for the configured Inbound Adapter.

enableSnapshots

Set to true, enables Snapshot Reports to be generated in Fusion Middleware Control for the configured Inbound Adapter.

jca.retry.backoff

Indicates the retry interval growth factor as a positive integer.

jca.retry.count

Indicates maximum number of retries before rejection.

jca.retry.interval

Indicates interval in seconds between retries.

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.

minimumDelayBetweenMessages

Default is False, or no delay. Inbound-only. This property is configured in milliseconds. Ensures that there at least will be some delay between two consecutive messages posted to the downstream composite application.

Note that minimumDelayBetweenMessages is effective per adapter polling thread. If you have configured multiple adapter polling threads, this setting controls the delay between messages processed by each thread only.

singleton

In a Clustered High Availability environment, setting this property to true ensures that only one instance is created at one point of time.

snapshotInterval

The interval between snapshot reports.

useRejectedMessageRecovery

If set to true, you can recover or abort a Rejected message.

useWorkManager

Default is False. Supplies a custom work manager rather than the default work manager that is currently used with adapters. You can configure an inbound JCA endpoint (SCA service endpoint) to use a specific WebLogic WorkManager, using the binding property useWorkManager. The JCA binding delegates the WorkManager name to the SOA Infrastructure Executor, which accepts the work manager in its constructor. The value you enter into the useWorkManager property should be just the "name" part; the rest is added. For example, the name could be fileRead. If this JNDI lookup fails, the SOA Executor falls back to the default SOA work manager normally used if no work manager specified).

A.4 Oracle AQ Adapter Properties

The following tables describe the properties applicable to the Oracle AQ Adapter:

  • Table A-4 JCA Properties for Oracle AQ Adapter

  • Table A-5 JCA Properties for Oracle AQ Adapter: Normalized Properties

  • Table A-6 Binding Properties for Oracle AQ Adapter

For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.

For more information, see Oracle AQ Adapter in Administering Oracle SOA Suite and Oracle Business Process Management Suite.

Table A-4 JCA Properties for Oracle AQ Adapter

Property Description

QueueName

The name of the AQ Queue being read from or written to.

DatabaseSchema

The schema where the queue resides. If not specified, the schema of the current connection is used.

SchemaValidation

When this property is set to "true", the payload is validated against the schema specified. If the validation fails, then the message is rejected.

EnableStreaming

When this property is set to "true", the payload from the queue is streamed instead of being processed as an in-memory DOM. You must use this feature while handling large payloads. This property is applicable when processing RAW messages, XMLType messages, and ADT type messages for which a payload is specified through an ADT attribute.

RecipientList

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.

Consumer

Applicable only for multiconsumer queues. If specified, only the messages targeted for the particular consumer are made available for processing.

ObjectFieldName

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.

PayloadHeaderRequired

Only applicable if the ObjectFieldName property specifies a value. If set to "true", it ensures that all non payload attributes of ADT are available for processing as Normalized Message property 'jca.aq.HeaderDocument'.

MessageSelectorRule

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 MessageSelectorRule property of the adapter. These conditions may concern selecting messages of a certain priority, or some aspect of the message payload, such as in selecting only loan applications above $100,000.

DequeueCondition

This property is valid for dequeue operations only. Enter a Boolean expression similar to the WHERE clause of a SQL query. This expression can include conditions on message properties, user data properties (object payloads only), and PL/SQL or SQL functions. If multiple messages satisfy the dequeue condition, then the order of dequeuing is indeterminate, and the sort order of the queue is not honored.

Correlation

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, 'jca.aq.Correlation'. When specified for the dequeue operation, it only dequeues messages that match the value specified. If none is specified, all messages in the queue are available to the dequeue operation.

PayloadSizeThreshold

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-5 JCA Properties for Oracle AQ Adapter: Normalized Properties

Property Description

jca.aq.Attempts

The number of failed attempts at dequeuing the message.

jca.aq.Correlation

User-assigned correlation ID.

jca.aq.Delay

The number of seconds after which the message is available for dequeuing.

jca.aq.EnqueueTime

The time at which the message was enqueued.

jca.aq.ExceptionQueue

The exception queue name.

jca.aq.Expiration

The number of seconds before the message expires. This parameter is an offset from the Delay parameter. Default value of -1(never expires) is used if not specified.

jca.aq.MessageId

The hexadecimal representation of the message ID for the dequeued message.

jca.aq.OrigMessageId

The hexadecimal representation of the original message ID.

jca.aq.Priority

Priority of the message. A smaller number indicates a higher priority. The priority can be any number. The default value is zero.

jca.aq.RecipientList

The list of recipients for this message, separated by commas. This overrides RecipientList in InteractionSpec.

jca.aq.HeaderDocument

Contains string or DOM of current headers (XML DOM representation of payload headers.)

Table A-6 Binding Properties for Oracle AQ Adapter

Property Description

ConnectionRetryDelay

The time for which the Oracle AQ Adapter waits before trying to re-create a connection after a connection is lost. The default value is 15s.

DequeueTimeOut

It is the interval after which the dequeue() API times out if no message is received on the inbound queue. The default value is 1s.

adapter.aq.dequeue.threads

Specifies the number of poller threads that are created when an endpoint is activated. The default value is 1.

A.5 Coherence Adapter Properties

The following tables describe the properties applicable to the Coherence Adapter:

  • Table A-7 Coherence Adapter JCA Properties

  • Table A-8 Coherence Adapter Normalized Properties

  • Table A-9 Coherence Adapter Connection Factory Properties

Table A-7 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 CacheName in any Coherence Adapter operation does not exist.

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/retrieved 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/retrieve 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.

EXPIRY_NEVER

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, IndexName should be set to value price.For index on the attribute firstName, IndexName should be set to author.firstName

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

Table A-8 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.

Table A-9 Coherence Adapter Connection Factory Properties

Name Description Value

ConnectionFactoryLocation

Specifies the JNDI name of connection factory provided by coherence-transaction.rar.

tangosol.coherenceTx

ServiceName

Name of the cache service to be associated with the connection. ServiceName is only required for t ransactional caches. For the non-transaction/extend case it is not required.

XATransactionalCache - for XA

TransactionalCache - for Local cache

Leave blank for Remote cache

CacheConfigLocation

Location of cache configuration file that defines the cache and extend client settings

-

ClassLoaderMode

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

WLSExtendProxy

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.

True

PojoJarFile

Specifies the location of domain classes that will be used for the cache operations.

-

A.6 Oracle Database Adapter Properties

The following tables describe the properties applicable to the Oracle Database Adapter:

  • Table A-10 JCA Properties for Oracle Database Adapter: Instance Properties

  • Table A-11 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:

Table A-10 JCA Properties for Oracle Database Adapter: Instance Properties

Property Description

DataSourceName

Either this property or xADataSource name is a mandatory property, or both. Refers to the JNDI name (jdbc/...) of the tx-level="local" data source connecting to. All operations using this pool are locally transacted, independent on the global transaction. If both xADataSourceName and dataSourceName are specified, then the latter is used for READ operations.

LogTopLinkAll

The default value is FALSE. You must increase DB Adapter logging to include all underlying TopLink log messages at maximum granularity. This property provides maximum visibility, but adapter logging is tuned to show the most relevant TopLink SQL logging.

PlatformClassName

This is a mandatory property. This points to the type of database being connected to. The suggested values for this property are:

  • Oracle11Platform

  • Oracle10Platform

  • Oracle9Platform

  • Oracle8Platform

  • DB2Platform

  • InformixPlatform

  • SybasePlatform

  • SQLServerPlatform

  • MySQLPlatform

  • DatabasePlatform

You also can give the full package and class name of a subclass of oracle.toplink.platform.database.DatabasePlatform. For DB2 on AS/400, Oracle recommends that you give the value of oracle.tip.adapter.db.toplinkext.DB2AS400Platform.

UsesBatchWriting

The default value is TRUE. Multiple identical statements are executed as a single batch statement. You must only disable this property for certain JDBC drivers that have known issues.

UsesSkipLocking

The default value is TRUE. Oracle Database polling statements using SELECT FOR UPDATE are automatically be upgraded to SELECT FOR UPDATE SKIP LOCKED, which provides better concurrent performance. Disable this property only for certain cases where skip locking is not compatible with another feature or your use case.

UsesNativeSequencing

The default value is TRUE. If any SOA services are configured to automatically assign sequence numbers on INSERT operation, then a TRUE value indicates that the sequence values are coming from a database native sequence.

XADataSourceName

This is a mandatory property. It specifies the JNDI name (jdbc/...) of the tx-level="global" data source connecting to the database. All operations using this pool bind to the global transaction and commit or roll back as a unit.

Table A-11 JCA Properties for Oracle Database Adapter: Normalized Message Properties

Property Description

jca.db.CursorName

Inbound/Outbound.

jca.db.DataSourceName

Outbound.

jca.db.Password

Outbound. You cannot assign values to the jca.db.password property on Oracle Containers for Java EE because its data source does not support setting password dynamically to the getConnection method. Consider using jca.db.ProxyPassword instead.

jca.db.ProxyCertificateFoot 1

Outbound. When set, specifies OracleConnection.PROXYTYPE_CERTIFICATE as the proxy type. The value is a base64Binary encoded byte[] array that contains the certificate. If set, do not set jca.db.ProxyDistinguishedName, jca.db.ProxyUser, and jca.db.ProxyPassword.

jca.db.ProxyDistinguishedNameFoot 1

Outbound. When set, specifies OracleConnection.PROXYTYPE_DISTINGUISHED_NAME as the proxy type. The value should be the proxy distinguished name as a java.lang.String. If set, then set none of jca.db.ProxyCertificate, jca.db.ProxyUserName and jca.db.ProxyPassword.

jca.db.ProxyIsThickDriverFoot 1

Outbound. Values are true and false. Set to true if using the OCI driver, as there is some discrepancy in the JDBC-level API between the thick and thin drivers.

jca.db.ProxyPasswordFoot 1

Outbound. When set, specifies OracleConnection.PROXYTYPE_USER_PASSWORD as the proxy type. The value should be the password for the proxy user as a java.lang.String. If set, you must also set jca.db.ProxyUserName. If set, then set neither jca.db.ProxyCertificate nor jca.db.ProxyDistinguished name.

jca.db.ProxyRolesFoot 1

Outbound. Set to define the roles associated with the proxy user. The value should be a String[] array where each java.lang.String corresponds to a role name. This property is applicable when using any of OracleConnection.PROXYTYPE_USER_PASSWORD, OracleConnection.PROXYTYPE_CERTIFICATE, and OracleConnection.PROXYTYPE_DISTINGUISHED_NAME.

jca.db.ProxyUserNameFoot 1

Outbound. When set, specifies OracleConnection.PROXYTYPE_USER_PASSWORD as the proxy type. The value should be the user name of the proxy user as a java.lang.String. If set, you must also set jca.db.ProxyPassword. If set, then set neither jca.db.ProxyCertificate nor jca.db.ProxyDistinguished name.

jca.db.UserName

Outbound. You cannot assign values to the jca.db.userName property on Oracle Containers for Java EE because its data source does not support setting user name dynamically to the getConnection method. Consider using jca.db.ProxyUserName instead.

jca.db.XADataSourceName

Outbound.

Footnote 1

For more information, see Proxy Authentication Support.

A.7 Oracle File and FTP Adapters Properties

The following tables describe the properties applicable to the Oracle File and FTP Adapters:

  • Table A-12 JCA Properties for Oracle File and FTP Adapters

  • Table A-13 JCA Properties Specific to Oracle FTP Adapter

  • Table A-14 Binding Properties for Oracle File and FTP Adapters

  • Table A-15 Binding Properties Specific to Oracle FTP Adapter

  • Table A-16 JCA Properties for Oracle File Adapter: Normalized Properties

  • Table A-17 JCA Properties for Oracle FTP Adapter: Normalized Properties

For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.

Table A-12 JCA Properties for Oracle File and FTP Adapters

Property Description

Append

If this property is set to true, it causes Oracle and File and FTP Adapters to append to a file on outbound. If the file does not exist, then a new file is created.

The file name can either be specified in the JCA file for the outbound operation or in the jca.file.FileName header.

AsAttachment

If set to true, it causes the inbound file to be published as an attachment.

BatchSize

Set it to the batch size for the batching transformation.

CharacterSet

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.

ChunkSize

Set it to the chunk size for the chunked interaction operation. ChunkSize property is applicable only to BPEL. Do not set this property in Oracle Service B.

ConcurrentThreshold

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 100.

ContentType

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.

DeleteFile

If set to true, the Oracle File or FTP Adapter deletes the file after processing.

DirectorySeparator

When you choose multiple directories, the generated JCA files use semicolon (;) as the separator for these directories. However, you can change the separator to something else. If you do so, manually add <property name="DirectorySeparator" value="chosen separator"/> in the generated JCA file. For example, to use comma (,) as the separator, you must first change the separator to comma (,) in the Physical directory and then add <property name="DirectorySeparator" value=","/> in the JCA file.

ElapsedTime

This property is used for outbound batching. When the time specified elapses, the outgoing file is created. The parameter is of type int and is not mandatory. The default value is 1.

Encoding

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.

ExcludeFiles

This property specifies the pattern for types of files to be excluded during polling. The property is of type String and is not mandatory.

FileName

Use this parameter to specify a static single file name during the write operation.

FileNamingConvention

This property is used for the naming convention for the outbound write operation file.

FileSize

This property is used for outbound batching. The outgoing file is created when the file size condition is met. The parameter is of type int and is not mandatory. The default value is 1000 KB.

IncludeFiles

This property specifies the pattern for types of files to pick up during polling. The parameter is of type String and is mandatory.

Lenient

Lenient property works in conjunction with deployment validation. If the inbound directory cannot be read or written to, then the adapter throws a failure and rolls back the deployment. However, if Lenient is set to true, then the deployment goes through. The default value of this property is false.

ListSorter

This property specifies the sorter that the Oracle File and FTP Adapters use to sort files in inbound. You can set this parameter to:

  • oracle.tip.adapter.file.inbound.listing.TimestampSorterAscending to sort the file names by their modified time stamps in ascending manner or

  • oracle.tip.adapter.file.inbound.listing.TimestampSorterDescending to sort the file names by their modified time stamps in descending manner

LogicalArchiveDirectory

This property specifies the logical directory in which to archive successfully processed files. The property is of type String and is not mandatory.

LogicalDirectory

This parameter specifies the logical input directory to be polled. The parameter is of type String.

MaxRaiseSize

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 MaxRaiseSize is set to 100 and the polling frequency is one minute, then the Oracle File or FTP Adapter submits 100 files every minute.

Recommended value for MaxRaiseSize for good performance is5.

MinimumAge

This parameter specifies the minimum age of files to be retrieved. This specification 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.

NumberMessages

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 int and is not mandatory. The default value is 1.

PhysicalArchiveDirectory

This property specifies where to archive successfully processed files. The property is of type String and is not mandatory.

PhysicalDirectory

This property specifies the physical input directory or directories to be polled. The parameter is of type String. The inbound directory where the files appear is mandatory. You must specify the physical directory or logical directory.

PollingFrequency

This parameter specifies how often to poll a given input directory for new files. The parameter is of type int and is mandatory. The default value is 1 minute.

Recommended value for PollingFrequency for good performance is 15 .

PublishSize

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 int and is not mandatory. The default value is 1.

For example, if a certain file has 11 records and this parameter is set to 2, then the file processes 2 records at a time and the final record is processed in the sixth iteration.

Recommended values for PublishSize for good performance should be between 100 and 500.

For debatching to work, the XML schema of File Adapter also needs to support debatching. For example, if the FileAdapter schema has maxOccurs="1" property, files cannot be debatched.

Recursive

If this property is set to true, then the adapter can process all the sub-directories under the main input directory recursively.

SequenceName

Specifies the Oracle database sequence name to be used if you have configured the outbound Oracle File or FTP Adapter for High Availability.

SingleThreadModel

If the value is true, the Oracle File or FTP Adapter poller processes files in the same thread. In other words, it does not use the global in-memory queue for processing.

SourceFileName

The source file for the File I/O operation.

SourcePhysicalDirectory

The source directory for the File I/O operation.

SourceSchema

Set to the schema for the source file.

SourceSchemaRoot

Set to the root element name for the source file.

SourceType

Set this to native if the source file is native and xml if the source file is xml.

TargetFileName

The target file for the File I/O operation.

TargetPhysicalDirectory

The target directory for the File I/O operation.

TargetSchema

Set it to the schema for the target file.

TargetSchemaRoot

Set it to the root element name for the target file.

TargetType

Set this to native if the target file is native and xml if the source file is xml.

ThreadCount

If this property is available, then the adapter creates its own processor threads rather than depend on the global thread pool processor threads (by default, 4 of them). In other words, this parameter partitions the in-memory queue and each composite application gets its own in-memory queue.

  • If the ThreadCount property is set to 0, then the threading behavior equals that of the single-threaded model.

  • If the ThreadCount property is set to -1, then the global thread pool is used, which equals the default threading model.

  • The maximum value for the ThreadCount property is 40.

Recommended values for ThreadCount for good performance is10.

TriggerFile

The name of the trigger file that activates the inbound Oracle File or FTP Adapter.

TriggerFilePhysicalDirectory

The directory path where the Oracle File or FTP Adapter looks for the trigger files.

TriggerFileStrategy

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 EndpointActivation, EveryTime, or OnceOnly.

Type

Set it to COPY, MOVE, or DELETE for the File IO interaction.

UseRemoteErrorArchive

This property defines where an error is archived during an Inbound Read. During an Inbound Read operation, if a malformed XML file is read, the malformed file results in an error. The errored file is by default sent to the remote file system for archival. The errored file can be archived at a local file system by specifying the useRemoteErrorArchive property in the jca file and setting that property to false. The default value for this property is true.

UseHeaders

This parameter can be set to true or false. If you must read file headers and skip reading the payload while using inbound Oracle File or FTP Adapter, then set the UseHeader property to true.

This is typically used in large payload scenarios where the inbound adapter is used as a notifier.

UseStaging

If set to true, then the outbound Oracle File or FTP Adapter writes translated data to a staging file, and later it streams the staging file to the target file. If set to false, then the outbound Oracle File or FTP Adapter does not use an intermediate staging file.

Xsl

Set it to the xsl transformer between the source and the target.

Table A-13 JCA Properties Specific to Oracle FTP Adapter

Property Description

FileType

Set this property to either ascii or binary depending on the requirement.

SourceIsRemote

Set this property to false if you want to notify the Oracle FTP Adapter that the source for the IO operation is a local file system as opposed to a remote FTP server.

TargetIsRemote

Set this property to false if you want to notify the Oracle FTP Adapter that the target for the IO operation is a local file system as opposed to a remote FTP server.

UseNlst

Set this property to true if you want the Oracle FTP Adapter to use the NLST FTP command instead of the LIST command that the adapter uses by default.

UseRemoteArchive

Set this property to true to notify the Oracle FTP Adapter that the archival directory is on the same FTP server. If set to false, the Oracle FTP Adapter uses a local file system folder for archival.

Table A-14 Binding Properties for Oracle File and FTP Adapters

Property Description

IgnoreListingErrors

Lets you control the behavior of the inbound Oracle File Adapter during the polling operation. If set to true, the Oracle File Adapter does not complain if it cannot read from a nested folder.

IgnoreZeroByteFile

Set it to true if you do not want Oracle File and FTP Adapters to throw an exception during the outbound read operation, if the file could not be found. This property is ignored if the schema for the inbound file is anything other than Opaque.

NestedFolderLimit

Limits the number of levels the File/FTP adapter recurses into input directory to poll for files

InMemoryTranslation

This property is applicable only if UseStaging is set to false .If UseStaging is set to true, then the translation step occurs in-memory (that is, an in-memory byte array is created). If set to false, then the adapter creates an output stream to the target file (FTP, FTPS, and SFTP included) and allows the translator to translate and write directly to the stream.

jca.message.encoding

This property is used to override the encoding specified in the NXSD schema for inbound Oracle File and FTP Adapters.

NotifyEachBatchFailure

Setting to true causes the Oracle File or FTP Adapter to call the Notification Agent's onBatchFailure every time an error occurs in a debatching scenario. If set to false, Oracle File and FTP Adapter call onBatchFailure only once after all messages are debatched.

oracle.tip.adapter.file.debatching.rejection.quantum

This property lets you control the size of rejected messages for inbound Oracle File and FTP Adapter partner link. For example, if you set it to 100, it causes the Oracke File or FTP Adapter to reject 100 lines from the file because the actual file is too large.

oracle.tip.adapter.file.highavailability.maxRetry

Number of times that inbound Oracle File and FTP Adapters retry to establish a database connection in distributed polling scenarios.

oracle.tip.adapter.file.highavailability.maxRetryInterval

Number of milliseconds after which inbound Oracle File and FTP Adapters retry to establish a database connection in distributed polling scenarios.

oracle.tip.adapter.file.mutex

Set it to the class name that specifies the mutex for the outbound write operation. This class must extend the oracle.tip.adapter.file.Mutex abstraction.

oracle.tip.adapter.file.rejectOriginalContent

Setting to true causes Oracle File or FTP Adapter to reject the original content. If set to false, the adapter rejects the XML data created because of the translation step.

oracle.tip.adapter.file.timeout.recoverpicked.minutes

This property is used by the inbound highly available adapter when using FILEADAPTER_IN as the coordinator. Remember that when a file is first claimed (enqueued) by a node for processing, the FILE_PROCESSED column in FILEADAPTER_IN is set to 0. At a later point in time, when a decoupled processor threads picks up the file for processing, the value of the FILE_PROCESSED column is updated from 0 to 1.

And when the file is processed completely, the FILE_PROCESSED column is updated from 1 to 2. However, if the processor thread picks up a file but the node crashes before processing the file, then the file is never processed. This property is used to undo the pick operation. The adapter does this by deleting the entries in the FILEADAPTER_IN table that have been picked up but not processed within the value specified here.

The table FILEADAPTER_IN comes by default in SOA_INFRA schema resulting in Oracle File or FTP Adapter sharing data source. For better performance, create a separate database schema, create FILEADAPTER_IN table and point it to the external table.

Set the property to a large value like 10000 to process files successfully.

oracle.tip.adapter.file.timeout.recoverunpicked.minutes

This property is used by the inbound highly available adapter when using FILEADAPTER_IN as the coordinator. Remember that when a file is first claimed by a node for processing, FILE_PROCESSED column in FILEADAPTER_IN is set to 0. Later on, when the decoupled-processor thread picks up the file for processing, the value of the FILE_PROCESSED column is updated from 0 to 1. And when the file is processed completely, the FILE_PROCESSED column is updated from 1 to 2. If the node crashes when the FILE_PROCESSED is still 0, it would mean that the file is enqueued by a node (no other nodes can pick this one up). However, it also means that the decoupled processor threads have still not picked this one for processing. This property is used to undo the claim(enqueue_ operation.) The adapter does this by deleting the entries in the FILEADAPTER_IN table that have been claimed (for example, FILE_PROCESSED =="0"), but not picked up till now.

RecoveryInterval

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.

SerializeTranslation

If set to true, then the translation step is serialized using a semaphore. The number of permits for semaphore (guarding the translation step) comes from the ConcurrentThreshold property. If false, then the translation step occurs outside the semaphore.

UseFileSystem

This property is used by inbound Oracle File and FTP Adapters during read-only polling in a clustered environment. Setting it to true causes the adapter to use the file system to store the metadata of the processed files. Setting it to false causes the adapter to use a database table.

Table A-15 Binding Properties Specific to Oracle FTP Adapter

Property Description

TimestampOffset

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.

control.so.timeout

This property allows you the define time-out for the control socket to the FTP server. The parameter should specified in milliseconds.

Table A-16 JCA Properties for Oracle File Adapter: Normalized Properties

Property Description

jca.file.FileName

This property specifies the name of the file read from the inbound directory or written to the outbound directory.

jca.file.Directory

This property specifies the name of the directory from which file is read from or written to.

jca.file.Size

This property specifies the size of the file published from the inbound Oracle File Adapter.

jca.file.Batch

This property is used to specify a unique identifier for the file being published from the inbound adapter.

jca.file.BatchIndex

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 jca.file.Batch remains the same but jca.file.BatchIndex increments by one for each publish from the same batch.

jca.file.IsEOF

This property is used with chunked interaction. It is used to find out if the end of file is reached.

Table A-17 JCA Properties for Oracle FTP Adapter: Normalized Properties

Property Description

jca.ftp.FileName

This property specifies the name of the file read from the inbound directory or written to the outbound directory.

jca.ftp.Directory

This property specifies the name of the directory from which file is read from or written to.

jca.ftp.Size

This property specifies the size of the file published from the inbound Oracle File Adapter. The size can be zero.

jca.ftp.Batch

This property is used to specify a unique identifier for the file being published from the inbound Oracle FTP Adapter.

jca.ftp.BatchIndex

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 jca.ftp.Batch remains the same but jca.ftp.BatchIndex increments by one for each publish from the same batch.

A.8 Oracle JMS Adapter Properties

The following tables describe the properties applicable to the Oracle JMS Adapter:

  • Table A-18 JCA Properties for Oracle JMS Adapter

  • Table A-19 JCA Properties for Oracle JMS Adapter: Normalized Properties

  • Table A-20 Binding Properties for Oracle JMS Adapter

For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.

For more information, see Oracle JMS Adapter in Administering Oracle SOA Suite and Oracle Business Process Management Suite

Table A-18 JCA Properties for Oracle JMS Adapter

Property Description

AllowTemporaryReplyDestination

This property is applicable for a synchronous request-reply scenario. When set to true ReplyDestinationName is not required and JMS adapter in turn uses a temporary destination to recieve a reply from.

AttachmentList

Only applicable when dealing with message of type MapMessage. This property is used to identify the field containing the business payload when dealing with Map messages. Also, the payload in this case is published as an attachment. You can use either PayloadEntry or AttachmentList. All other Map message entries are made available as normalized message properties accessed using jca.jms.Map.MapMessage entry name

DeliveryMode

Represents the delivery mode to use. The message producer's default delivery mode is PERSISTENT. This can be overridden on a per message basis using normalized message property jca.JMSDeliveryMode

DestinationName

The name of the queue or topic being read from or written to.

DurableSubscriber

Name used to identify a durable subscription. When working with durable subscriptions ensure that ClientID is also specified in addition to DurableSubscriber property. ClientID is specified as part of the FactoryProperties property when defining a Managed Connection Factory instance. This property is only applicable when working with JMS Topic scenarios

EnableStreaming

When this property is set to "true", the payload from the queue or topic is streamed instead of being processed as an in-memory DOM. You must use this feature while handling large payloads.

MessageSelector

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.

PayloadEntry

Only applicable when dealing with messages of type MapMessage. This property is used to identify the field containing the business payload when dealing with Map messages. All other Map message entries are made available as normalized message properties accessed using jca.jms.Map.MapMessage entry name

PayloadSizeThreshold

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

PayloadType

This property specifies the type of JMS message that is being dequeued or enqueued by the adapter. For Map messages the value is 'MapMessage' and for Text messages the value is 'TextMessage'.

Priority

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 jca.jms.JMSPriority

ReplyDestinationName

This property is applicable for a synchronous request-reply scenario and specify the name of destination for receiving a reply.

ReplyTimeout

This property is applicable for a synchronous request-reply scenario and specifies the timeout for receiving a reply in milliseconds. The default value is 0, which means no timeout, where the receiver will wait for the reply forever.

RequestDestinationName

This property is applicable for a synchronous request-reply scenario and specifies the name of destination for sending a message.

TimeToLive

Represents the message's lifetime (in milliseconds). The message producer's default time to live is unlimited; the message never expires. A value of 0 signifies that the message never expires.

UnitOfOrder

Specifies the use of the Unit-of-Order feature. The WebLogic Server Unit-of-Order feature enables a message producer or group of message producers acting as one, to group messages into a single unit that is processed sequentially in the order the messages were created.

UseMessageListener

Deprecated. The only value of this property supported in the current version is false. A value of false ensures that the JMS adapter uses synchronous mechanism to poll queues or topics for messages

Table A-19 JCA Properties for Oracle JMS Adapter: Normalized Properties

Property Description

jca.jms.JMSDestinationName

This property specifies the destination to which the message is sent, and is set by the JMS producer.

jca.jms.JMSDestinationProperties

This property represents the properties that define the context used to look up the destination object to which the message must be sent

jca.jms.JMSCorrelationID

This property is set by both producers and consumers for linking the response message with the request message. This is an optional attribute.

jca.jms.JMSType

This property specifies the JMS message type.

jca.jms.JMSReplyTo

This is an optional attribute that indicates the destination to which a message reply must be sent.

jca.jms.JMSPriority

This property is used by the consumer to set a priority number between 0 and 9. Larger numbers represent a higher priority.

jca.jms.JMSExpiration

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.

jca.jms.JMSDeliveryMode

This property is set to persistent or nonpersistent mode by the JMS client.

jca.jms.JMSMessageID

This property is specifies a unique message identifier. The exact scope of uniqueness is provider-defined.

jca.jms.JMSRedelivered

This property indicates whether a message is being redelivered. 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.

jca.jms.JMSTimestamp

This property is specifies the time when the message was handed off to the JMS provider to be sent.

jca.jms.JMSProperty.name

This property represents any custom (application-specific) properties of the message. The supported properties conforms to the one allowed according to JMS specification. If an invalid property value is specified, the adapter warns the user (captured in the log files) and ignores the invalid property.

jca.jms.Map.name

This property represents any MapMessage element that is not transferred as payload.

jca.jms.WeblogicUnitOfOrder

This property overrides the value specified using the property UnitOfOrder for the JmsProduceInteractionSpec.

jca.jms.JMSProperty.JMS_BEA_UnitOfOrder

Use this Normalized Property to get the Unit of order value set on the Inbound JMS Message in the receive activity of BPEL.

Table A-20 Binding Properties for Oracle JMS Adapter

Property Description

adapter.jms.encoding

This property is superseded by the newer property jca.message.encoding that is applicable for both inbound and outbound messages.

adapter.jms.DistributedDestinationConnectionEveryMember

This property can be set to true (default) or false.

When true, the adapter will create a consumer/subscriber for each member of the distributed destination. If set to false, the adapter will create a consumer/subscriber for only local members of the distributed destination. When the adapter is connecting to a distributed destination on a remote cluster or a server on remote domain, this property should always be set to true. When the adapter is connecting to a distributed destination on a local cluster, the property can be set to either true or false. If set to true, the adapter behavior remains the same as before (consumer for each distributed destination is created). If set to false, the adapter will only create a consumer/subscriber for the local members.

You do not see this property in the JDeveloper user interface as a binding property on the Service side. You must manually add the property in the composite.xml as below under the <service> /<binding.jca> tag:

<property name="adapter.jms.DistributedDestination ConnectionEveryMember" type="xs:string" many="false" override="may">false</property>

adapter.jms.receive.threads

This property specifies the number of poller threads that are created when an endpoint is activated. The default is 1.

Retaining the default value as a higher value or value higher than the adapter.jms.receive.timeout value leads to excessive CPU usage and managed servers go into critical state.

adapter.jms.receive.timeout

This property specifies the timeout value used for the synchronous receive call. It is the time after which receive() API times out if no message is received on the inbound queue. The default value is 1s.

adapter.jms.registration.interval

This property is not supported anymore.

adapter.jms.retry.interval

This property is used by the inbound connection retry layer. The time for which the Oracle JMS Adapter waits before trying to re-create a connection after a connection is lost. The default value is 30s.

JMSReplyToDestinationProperties

This property specifies whether to declaratively impose custom property settings on Destination objects received during inbound request/reply scenarios.

JMSReplyUseCorrelationIdForCorrelation

This property specifies whether to whether you want to use a correlation ID for correlation. Values are true and false (default).

JMSReplyUseMessageIdForCorrelation

This property specifies whether to whether you want to use a message ID for correlation. Values are true and false (default).

JMSReplyPropagateJMSExpiration

This 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.

RequestReply.cacheReceivers

If the same small number of JMS receivers are used for the same request destination repeatedly, then set this property to true to improve performance. The default value is false.

RequestReply.useCorrelation

This property is applicable for a synchronous request-reply scenario. If set to true, then it applies a JMS Message selector for obtaining the reply message. If the request Normalized Message property jca.jms.JMSCorrelationID is specified, then it is used for correlation, otherwise the JMS Message ID property is used. The JMS adapter uses the following message selector: "JMSCorrelationID = '<corrId>' [ AND (<wsdlSelector>) ]" where the AND branch is only included if the user specifies a MessageSelector property. The default value is true.

SuppressHeaders

This property is used to bypass headers. For scenarios in which a composite does not use or produce the headers, set to true. It may improve performance for such scenarios. The default value is false.

A.9 LDAP Adapter Properties

The following tables describe the properties applicable to the LDAP Adapter:

  • Table A-21 LDAP Adapter Connection Properties

  • Table A-22 LDAP Adapter JCA Artifacts for Entry Change Notification

  • Table A-23 LDAP Adapter JCA Artifacts for Change Log Notification

  • Table A-24 LDAP Adapter JCA Artifacts for Search Operation

  • Table A-25 LDAP Adapter DSML JCA Artifacts

  • Table A-26 LDAP Adapter Delete Operation JCA Artifacts

  • Table A-27 LDAP Adapter Add Operation JCA Artifacts

  • Table A-28 LDAP Adapter Modify Operation JCA Artifacts

  • Table A-29 LDAP Adapter ModifyDN Operation JCA Artifacts

Table A-21 LDAP Adapter Connection Properties

Property Allowed Values Description

HostName

Name or IP address of the host machine.

Machine where the LDAP server is hosted.

BindDN

Cn=admin

InboundDataSource

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.

Password

secret

Not required

SecurityProvider

SSLContextProtocol

Key management protocol, not required.

TrustAll

False

If mentioned, the client will blindly trust any certificated that the server might present. Required only if useSSL or startTLS is selected.

TrustStoreProviderName

The JSSE provider name.

P

Integer value

Port where the LDAP service is running on the host.

UseSSL

true or false (default).

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.

UseStartTLS

true or false (default). 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.

TrustAll

true or false (default).

If mentioned, the client will blindly trust any certificated that the server might present. TrustStorePath is redundant and ignored if this option is selected.

TrustStorePath

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.

TrustStorePassword

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.

Protocol

Set the protocol version enabled for secure connections with the directory server. The protocol must be supported by the SSL Context.

EnableCipherSuites

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.

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 (default)

When set to true, only the attribute names will be returned. Otherwise, both attribute names and values will be returned.

SizeLimit

Positive integer. Default = 1000. <= 0 implies no size limit will be enforced.

Maximum number of entries returned as part of a search operation. 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 page size. Note: SizeLimit implies a size within a page and does not pertain to the total number of entries returned across all the pages in a search. Default value = -1 (unlimited page size).

Maximum number of events that should be published in a page.

TimeLimit

Integer value in seconds. Default = 10.

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 value in seconds. Default = 10.

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 value in seconds. Default = 10.

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. Default = 0 (no time limit).

Maximum time the server should wait before returning the results.

SizeLimit

Integer value in seconds. Default = 1000.

Maximum number of events that should be published in one trip.

PageSize

Integer value specifying a page size. 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

AliasDereferencing

Restricted string with value in:

Unknown macro: { "never","search", "find", "always"}

Behavior for handling alias entries while processing the search.

FollowReferrals

Restricted string with value in:

Unknown macro: {"ignore","throwException","follow"}

By default, the 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 = 1.

Number of alternate locations participating in search referrals.

NameSpaceAware

true or false (default)

When set to true, the LDAP adapter generates the resulting XML from a search operation with namespaces. When set to false or not defined, the LDAP adapter generates the resulting XML from a search operation without namespaces. When the LDAP adapter search result is accessed by XQuery in BPEL, NameSpaceAware must be set to true as XQuery is a namespace-aware language.

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.

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.

SizeLimit

Integer value in seconds. Default = 1000.

Maximum number of entries returned as part of a search operation. This can be configured on the DS side as well. Lower of the two values will take effect.

TimeLimit

Integer value in seconds. Default = 0 (no time limit).

Maximum time in seconds the server should wait before returning the results.

TypesOnly

true or false (default)

When set to true, only the attribute names will be returned. Otherwise, both attribute names and values will be returned.

Table A-25 LDAP Adapter DSML JCA Artifacts

Property Name Allowed Values Description

MaxDSMLRequestSize

Integer value. Default = 0 (no limit).

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

RequestControls

String

To pass in one or more controls along with the operation.

SuppressEntryDoesNotExist

true or 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 specification.

Table A-27 LDAP Adapter Add Operation JCA Artifacts

Property Allowed values Description

SuppressEntryAlreadyExists

true or 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 specification.

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

RequestControls

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

true (default) or false.

-

A.10 Oracle MQ Series Adapter Properties

The following tables describe the properties applicable to the Oracle MQ Series Adapter:

  • Table A-30 JCA Properties for Oracle MQ Series Adapter

  • Table A-31 JCA Properties for Oracle MQ Series Adapter: Normalized Properties

  • Table A-32 Connection Properties for Oracle MQ Series Adapter

  • Table A-33 Binding Properties for Oracle MQ Series Adapter

For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.

For more information, see Oracle MQ Adapter in Administering Oracle SOA Suite and Oracle Business Process Management Suite.

Table A-30 JCA Properties for Oracle MQ Series Adapter

Property Description

QueueName

This property specifies the name of the MQ Queue for sending or retrieving messages.

MessageType

This property specifies the type of message: Normal, Request, Reply, or Report

MessageFormat

This property specifies the type of MQ message format, such as Default, and Request/Reply.

Priority

This property specifies the message priority. Its value ranges from 0 to 9. The default value is AS_Q_DEF, which uses the value defined in the destination queue.

Persistence

This property is used to set the message persistence. The message persists when this property is set to true. The defaults value is AS_Q_DEF, which uses the value defined in the destination queue.

OnDeliveryFailure

This property is used when message delivery fails. The default value is DeadLetterQueue, which sends messages to a dead letter queue. If the value is set to DISCARD, then messages are discarded.

PartialDeliveryForDL

This property is used for partial delivery to a distribution list. The default value is false.

SegmentIfRequired

This property is used when the size of the message is larger than the maximum limit set on the queue. The default value is true.

Expiry

This property specifies the time after which the message would be removed by the Queue Manager. The default value is NEVER.

ReplyToQueueName

This property specifies the name of the queue to which the reply or report must be sent.

ReportCOA

If this property is set, a confirmation on arrival report is sent to the replyto queue on arrival of a message in the destination queue. The default value is WITH_NO_DATA, and no data is sent in this case.

ReportCOD

If this property is set, a confirmation on delivery report is sent to the replyto queue on arrival of a message in the destination queue. The default value is WITH_NO_DATA, and no data is sent in this case.

ReportException

If this property is set, an exception report is sent to the replyto queue when message delivery to the destination queue fails. The default value is WITH_NO_DATA, and no data is sent in this case.

ReportExpiry

If this property is set, an expiry report is sent to the replyto queue when a message sent to the destination queue expires. The default value is WITH_NO_DATA, and no data is sent in this case.

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. Use this property 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. Use this property 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 the Normal Message Queue.

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.

MessageSelector

This property specifies which messages must be retrieved from the MQ queue. Only messages whose headers and properties match the selection criteria are retrieved.

AsAttachment

This property, set to true, configures the adapter to process all messages as attachment.

CharacterSet

This property is optional and should only be specified if the "AsAttachment" property is set to true. It defines the character set of the attachment and is meant for third-party applications that process the attachments published by the Oracle MQ Series Adapter.

Encoding

This property is optional and should only be specified if the "AsAttachment" property is set to true. It defines the encoding of the attachment and is meant for third-party applications that process the attachments published by the Oracle MQ Series Adapter.

ContentType

This property is optional and should only be specified if the "AsAttachment" property is set to true. It defines the content type of the attachment and is only meant for third-party applications that process the attachments published by the Oracle MQ Series Adapter.

MaximumSegmentLength

This property is optional and a value should only be provided if you want to segment the message into a custom size. The value should be in the following format - integerValue[M/K/B], where M stands for Megabytes, K for Kilobytes and B for Bytes. For example, 230K, 4M, 512B.

ServerHeartbeat

This property defines the amount of time in milliseconds which the adapter should wait before trying to reconnect once the MQ Queue Manager is down.

ExponentialBackOff

This property should always be used in conjunction with the MaxExponentialBackOffCount property. This property (in seconds) defines the base of the exponentially increasing time interval after which the adapter tries to reconnect to the queue manager. For for example, if the value is 2, the adapter will try to reconnect at intervals of 2 seconds, 4seconds, 8 seconds, 16 seconds.

MaxExponentialBackOffCount

This property should always be used in conjunction with the "ExponentialBackOff" property. This property is used for capping the "ExponentialBackOff" time interval. For example, if the "ExponentialBackOff" is set to 2 and "MaxExponentialBackOffCount" to 7 then the adapter retries at intervals of 2, 4, 8, 16, 32, 64, 128, 128, 128… seconds.

UseDynamicResponseQueue

The boolean property can be used to specify whether dynamic response queues should be used rather than a permanent ReplyToQueue. If set to true, then ResponseModelQueueName should always be specified.

ResponseModelQueueName

The model queue name based on which the dynamic response queues should be created for retrieving the reply message.

ResponseWaitInterval

This property specifies the wait interval for which the adapter waits for the response message to arrive on the reply queue.

LimitHeaderLength

This property is used to reduce the MQ header information. The property can be added to oracle.tip.adapter.mq.inbound.ActivationSpecImpl in the corresponding MQ adapter JCA file. The default value is false.

PollingFrequency

This parameter specifies how often the inbound MQ Adapter must poll messages on the MQ queue. The parameter is of type int in milliseconds. The default is 3000 milliseconds if the parameter is not specified.

Table A-31 JCA Properties for Oracle MQ Series Adapter: Normalized Properties

Property Description

jca.mqAccountingToken

Inbound/Outbound. Accounting token information of the message. A hexadecimal-encoded string.

jca.mq.ApplIdentityData

Inbound/Outbound. Provides additional information about the Identity of the message or its originator. Accepts any string.

jca.mq.ISpec.ResponseWaitInterval

Outbound. Wait interval for the response message to arrive on the reply queue. Accepts integer value in miliseconds.

jca.mq.MQMD.ApplOriginData

Inbound/Outbound. Provides additional information about the origin of this message. Accepts any string.

jca.mq.MQMD.BackoutCount

Inbound/Outbound.Count of the number of times the message has previously been returned by an MQQueue.get() call as part of a unit of work, and subsequently backed out. Accepts zero and positive integer values.

jca.mq.MQMD.CorrelId

Inbound/Outbound. Correlation identifier of the message to be retrieved/ to be put. Accepts a hexadecimal-encoded string.

jca.mq.MQMD.Encoding.Decimal

Inbound/Outbound. Representation used for numeric values in the application message data. Accepts NORMAL and REVERSED.

jca.mq.MQMD.Encoding.Float

Inbound/Outbound. representation used for numeric values in the application message data. Accepts NORMAL, REVERSED and S390

jca.mq.MQMD.Expiry

Inbound/Outbound. A message's expiry time has elapsed, and it is eligible to be discarded by the queue manager. Accepts NEVER or a non- Inbound/Outbound.negative integer value

jca.mq.MQMD.Feedback

Inbound/Outbound. Used with a message of type MQC.MQMT_REPORT to indicate the nature of the report. Accepts any string.

jca.mq.MQMD.Feedback.ApplicationDefined

Inbound/Outbound. application defined feedback.Accepts any string.

jca.mq.MQMD.Format

Inbound/Outbound. Format name used by the sender of the message to indicate the nature of the data in the message to the receiver.Accepts following formats NONE, ADMIN, CHANNEL_COMPLETED, CICS, CMD1, CMD2, DEAD_LETTER_HDR, DIST_HDR, EVENT, IMS, IMS_VAR_STRING, MD_EXTN, PCF, REF_MSG_HDR, RF_HDR_1, RF_HDR_2, STRING, TRIGGER, WORK_INFO_HDR, XMIT_Q_HDR

jca.mq.MQMD.GroupId

Inbound/Outbound. Byte string that identifies the message group to which the physical message belongs. Accepts hexadecimal-encoded string.

jca.mq.MQMD.MsgFlags.IsMsgInGroup

Inbound/Outbound. Specifies if the message belongs to a group. Accepts true, false.

jca.mq.MQMD.MsgFlags.IsLastMsgInGroup

Inbound/Outbound. Specifies if the message is the last message of the group. Accepts true, false

jca.mq.MQMD.MsgFlags.IsSegment

Inbound/Outbound. Specifies if the message is a segment. Accepts true, false

jca.mq.MQMD.MsgFlags.IsLastSegment

Inbound/Outbound. Specifies if message is the last segment. Accepts true, false

jca.mq.MQMD.MsgId

Inbound/Outbound. Message identifier of the message to be retrieved/ to be put. Accepts hexadecimal encoded string

jca.mq.MQMD.MsgSeqNumber

Inbound/Outbound. Sequence number of a logical message within a group. Accepts non- Inbound/Outbound.negative integer value

jca.mq.MQMD.MsgType

Inbound/Outbound. Indicates the type of the message. Accepts any string.

jca.mq.MQMD.MsgType.ApplicationDefined

Inbound/Outbound. Application -defined message type. Accepts any string.

jca.mq.MQMD.Offset

Inbound/Outbound. The offset of data in a physical message from the start of a logical message. Accepts non- Inbound/Outbound.Negative integer value.

jca.mq.MQMD.OriginalLength

Inbound/Outbound. Original length of a segmented message. Accepts non-Negative integer value Inbound/Outbound

jca.mq.MQMD.Persistence

Inbound/Outbound. message persistence. Accepts true, false, AS_Q_DEF

jca.mq.MQMD.Priority

Inbound/Outbound. Message priority. Accepts 0- Inbound/Outbound.9, AS_Q_DEF

jca.mq.MQMD.PutApplName

Inbound/Outbound. Name of the application that Put the message. Accepts any string

jca.mq.MQMD.PutApplType

Inbound/Outbound. Type of application that Put the message. Accepts any string.

jca.mq.MQMD.PutApplType.UserDefined

Inbound/Outbound. User-defined Put application type. Accepts any string.

jca.mq.MQMD.PutDateTime

Inbound/Outbound. Time and date that the message was Put. Accepts year:month:date, year:month:date:hour:minute, year:month:date:hour:minute:second

jca.mq.MQMD.ReplyToQMgr

Inbound/Outbound. Name of the queue manager to which reply or report messages should be sent. Accepts any sting.

jca.mq.MQMD.ReplyToQ

Inbound/Outbound. Name of the queue to which reply or report messages should be sent. Accepts any string

jca.mq.MQMD.Report.Generate.CorrelId

Inbound/Outbound. scheme to generate the CorrelationId of reply or report message. Accepts PASS_CORREL_ID, COPY_MSG_ID

jca.mq.MQMD.Report.Generate.MsgId

Inbound/Outbound. Scheme to generate the MessageId of reply or report message. Accepts NEW_MSG_ID, PASS_MSG_ID

jca.mq.MQMD.Report.Generate.COA

Inbound/Outbound. Specifies the content of COA report. Accepts WITH_NO_DATA, WITH_PARTIAL_DATA, WITH_FULL_DATA

jca.mq.MQMD.Report.Generate.COD

Inbound/Outbound. Specifies the content of COD report. Accepts WITH_NO_DATA, WITH_PARTIAL_DATA, WITH_FULL_DATA

jca.mq.MQMD.Report.Generate.Exception

Inbound/Outbound. Specifies the content of the Exception report. Accepts WITH_NO_DATA, WITH_PARTIAL_DATA, WITH_FULL_DATA

jca.mq.MQMD.Report.Generate.Expiry

Inbound/Outbound. Specifies the content of the Expiry report. Accepts WITH_NO_DATA, WITH_PARTIAL_DATA, WITH_FULL_DATA

jca.mq.MQMD.Report.Generate.NAN

Inbound/Outbound. Specifies if the incoming/outgoing message is NAN or not. Accepts true, false

jca.mq.MQMD.Report.Generate.PAN

Inbound/Outbound. specify if incoming/outgoing message is PAN or not. Accepts true, false

jca.mq.MQMD.Report.TakeAction.OnMsgDeliveryFailure

Inbound/Outbound.

jca.mq.MQMD.Report.TakeAction.OnMsgDeliveryFailure

Accepts DISCARD, DEADLETTERQUEUE

jca.mq.MQMD.StrucId

Inbound/Outbound. Struct id of MQMD. Accepts any string

jca.mq.MQMD.UserIdentifier

Inbound/Outbound. User who originated this message. Accepts any string.

jca.mq.MQMD.Version

Inbound/Outbound. Version of MQMD. Accepts VERSION_1, VERSION_2

jca.mq.Inbound.MQMD.CorrelId

Outbound. Correlation identifier of the message retrieved in Async req-reply scenario. Accepts hexadecimal encoded string

jca.mq.Inbound.MQMD.MsgId

Outbound. Message identifier of the messageretrieved in Async req-reply scenario. Accepts hexadecimal-encoded string.

jca.mq.Inbound.MQMD.MsgType

Outbound. Message Type of the message retrieved in Async req-reply scenario. Accepts any string.

jca.mq.Inbound.MQMD.Nan

Outbound. NAN report option of the message retrieved in the Async req-reply scenario. Aceepts true, false

jca.mq.Inbound.MQMD.Pan

Outbound. PAN report option of the message retrieved in the Async req-reply scenario. Accepts true, false

jca.mq.Inbound.MQMD.ReplyToQMgr

Outbound. ReplyToQueueManager of the message retrieved in the Async req-reply scenario. Accepts any string.

jca.mq.Inbound.MQMD.ReplyToQ

Outbound. ReplyToQueue of the message retrieved in the Async req-reply scenario. Accepts any string.

jca.mq.Inbound.MQMD.Report.Generate.CorrelId

Outbound. Correlation scheme, for generation of CorrelationId, of the message retrieved in Async req-reply scenario. Accepts PASS_CORREL_ID, COPY_MSG_ID

jca.mq.Inbound.MQMD.Report.Generate.MsgId

Outbound. Correlation scheme, for generation of MessageId, of the message retrieved in Async req-reply scenario. Accepts NEW_MSG_ID, PASS_MSG_ID

jca.mq.ISpec.EnqueueMsgToQMgr

Outbound. Queue Manager for outbound queue. Accepts any string

jca.mq.ISpec.EnqueueMsgToQ

Outbound. Queue name of outbound queue. Accepts any string.

Table A-32 Connection Properties for Oracle MQ Series Adapter

Property Description

HostNam

Name of the host computer.

PortNumber

Port number to be used.

ChannelName

Set it to the server connection channel to be used.

QueueManagerName

A valid queue manager name.

CipherSuite

Set CipherSuite to the name matching the CipherSpec set on the SVRCONN channel. If set to null (default), then no SSL encryption is performed.

ClientEncoding

Character encoding used by the client.

ConnectionFactoryLocation

Location of the connection factory.

HostOSType

Operating system used by the host computer.

KeyStoreAlgorithm

Algorithm used by the key store.

KeyStoreLocation

This value is the keystore where Oracle MQ Series Adapter has its private keys. This is required when an adapter must authenticate itself to the MQ Series server.

KeyStorePassword

This value is the password that is required to access keystore.

KeyStoreProviderName

The name of the keystore provider.

TrustStoreLocation

This is the location where the adapter keeps its trusted certificates information. This information is required when an adapter must authenticate to the MQ Series server.

TrustStorePassword

This property specifies the password of the Trust Store location.

KeyStoreType

This property specifies the type of the key store.

Protocol

Key Management Algorithm.

SSLPeerName

A distinguished name pattern. If CipherSuite is set, you can use this variable to ensure that the correct queue manager is used. If set to null (default), then the DN of the queue manager is not checked. This variable is ignored if sslCipherSuite is null.

SSLEnable

The true or false value for this property means that the Oracle MQ Series Adapter is SSL enabled or SSL disabled.

UserID

This property is used if credential mapping is not set.

Password

This is the password to connect to the queue manager. This property is used if credential mapping is not set.

XATransaction

This property is used to enable or disable XA transactions. If set to true, then XA transaction is enabled.

ReceiveExit

This is the Receive Exit java class, which gets triggered when you receive a message on a particular queue.

SecurityExit

This is the Security Exit java class, which enables you to customize the security flows that occur when an attempt is made to connect to a queue manager.

SendExit

This is the Send Exit java class, which is triggered when you send a message to a particular queue.

CCDTurl

The value is a path to the CCDT file which should be used by the MQ Series Adapter for client connection details.

KeyStoreName

The name of the key store under the given stripe. Used when KeyStoreType is set to "kss".

StripeNameForKeyStore

The name of the stripe within which key store is created. Used when KeyStoreType is set to kss.

StripeNameForTrustStore

The name of the stripe within which trust store is created. Used when TrustStoreType is set to kss

TrustStoreAlgorithm

Algorithm used by the trust store.

TrustStoreName

The name of the trust store under the given stripe. Used when TrustStoreType is set to kss.

TrustStoreProviderName

The name of the trust store provider.

TrustStoreType

This property specifies the type of the trust store.

Table A-33 Binding Properties for Oracle MQ Series Adapter

Property Description

adapter.mq.inbound.queueName

This property is used to specify the name of the inbound MQ queue.

adapter.mq.inbound.binaryNulls

This property is used for dequeuing the messages with binary zero value. The default value for this property is true.

A.11 MSMQ JCA Adapter Properties

The following tables describe the properties applicable to the MSMQ JCA Adapter:

Table A-34 MSMQ Adapter JCA Properties

Property Description Default Value Required

DestinationType

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:

PUBLIC_QUEUE

PRIVATE_QUEUE

DISTRIBUTION_LIST

None

Yes

DestinationName

Name of the MSMQ queue.

None

Yes, if UseActiveDirectoryPath is False

DestinationPath

The string that identifies a DistributionList or Public queue as represented in ActiveDirectory. Example:

LDAP://MyLDAPServer/CN=MyQueue,CN=msmq,CN=MyComputer,CN=Computers,DC=MyDomain,DC=MyCompany,DC=COM

None

Yes, if UseActiveDirectoryPath is True

UseActiveDirectoryPath

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 DISTRIBUTION_LIST or PUBLIC_QUEUE.

False

Applicable only to outbound(Enqueue) operation. This property is not applicable for inbound(Dequeue). Dequeue is not supported for Distribution lists.

UseDirectFormatName

Boolean that allows for Direct Format name to be used for public and private queues.

False

-

Priority

Priority can be set to any integer value between 7 (highest priority) and 0 (lowest priority). Highest priority implies faster processing. Applicable to outbound Enqueue only.

3

-

TimeToLive

A time limit (in seconds) for the message to be retrieved from the target queue. The value is assigned to MaxTimeToReceive property for a given MSMQ message. Applicable to inbound and outbound Queue.

-1 (infinite) This implies that the message never expires.

-

Delivery

Specifies 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

-

OperationType

The operation to be carried out.The values are: enqueue and dequeue.

None

Yes

BodyType

Values are String (default) and ByteArray. When opaque (schema) processing option is selected that would imply BodyType value of ByteArray.

String

Yes

EnableStreaming

Boolean that enables payload to be streamed. Applicable only for inbound dequeue process.

False

-

Table A-35 MSMQ Adapter Normalized Properties

Property Name Description Direction

jca.msmq.message.SentTime

The time when a message is sent.

Inbound

jca.msmq.message.Priority

A message's priority. This overrides Priority in the MSMQInteractionSpec.

Inbound/Outbound

jca.msmq.message.TimeToLive

The time limit (in seconds) for the message to be retrieved from the target queue. This overrides TimeToLive in the MSMQInteractionSpec

Inbound/Outbound

jca.msmq.message.MaxTimeToReachQueue

The 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

jca.msmq.message.Id

Identifies the message using an MSMQ-generated message identifier.

Inbound

jca.msmq.message.Delivery

Values can be Persistent or Non Persistent. The property specifies how Message Queuing delivers the message. This value overrides Delivery in MSMQInteractionSpec.

Inbound/outbound

jca.msmq.message.BodyLength

The length of the message body in bytes.

Inbound

jca.msmq.message.ArrivedTime

The time when the message arrived at the queue.

Inbound

Table A-36 MSMQ Adapter Binding Properties

Property Name Description

adapter.msmq.receive.timeout

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).

adapter.msmq.dequeue.threads

Number of poller threads that will be initialized when endpoint activation occurs. When specified, the value of adapter.msmq.dequeue.threads is used to spawn multiple inbound poller threads; multiple inbound threads can be used to improve performance. The default value is 1.

The following table lists MSMQ Adapter Connection Factory Properties.

Table A-37 MSMQ Adapter Connection Factory Properties

Property Name Description Default

Host

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.

AccessMode

Indicates if the connection factory will allow for native access or not. Values are [Native | DCOM]. If Native, the Oracle WebLogic Server should be installed on the same host as MSMQ.

DCOM

TransactionMode

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.

None

User

Identifies a user

-

Password

Password for the user specified.

-

Domain

Domain of the MSMQ host.

-

A.12 Oracle Socket Adapter Properties

For properties applicable to all Oracle JCA Adapters, see Generic Oracle JCA Adapter Properties.

For more information, see Oracle Socket Adapter in Administering Oracle SOA Suite and Oracle Business Process Management Suite.

Table A-38 JCA Properties for Oracle Socket Adapter

Property Description

ByteOrder

Byte order of the remote computer being communicated with.

CustomImpl

If CustomImpl is chosen as the TransMode property, then it is the name of the Java class defining the handshake. This property is a concrete implementation of the ICustomParser interface.

Encoding

Character encoding used by the remote computer.

Host

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 localhost.

Port

In case of outbound, it is the port number on which a socket server is running, to which the adapter is connecting.

In case of inbound, it is the port number on which the socket adapter listens for incoming connections.

ReplyXslt

If XSLT is chosen as the TransMode property, then it specifies the path to the style sheet defining the handshake for inbound reply.

TransMode

Mechanism for defining the protocol. Set to XSLT to use style sheets, set to CustomImpl to use custom Java code, and set to NXSD for plain schema translation. Set to Script for javascript handshake base protocol.

Xslt

If XSLT is chosen as the TransMode property, then it specifies the path to the style sheet defining the handshake for inbound request, in case of inbound and outbound request or reply.

RequestScript

Service side only. Name of the javascript file used for handling the request side communication. Use when TransMode is set to script.

ReplyScript

Service side only. Name of the javascript file used for handling the response side communication. Use when TransMode is set to script.

OutboundScript

Reference side only. Name of the javascript file used for outbound communication. Use when TransMode is set to script.

SupportNIO

By default this property is set to true (when it is not specified). NIO is supported only for the inbound direction and only for NXSD mode of translation. For other modes of translation such as XSLT, CustomImpl and Script, SupportNIO is set to false.

Additionally, NIO is supported only for non-SSL connections.

A.13 UMS JCA Adapter Properties

The following tables describe the properties applicable to the UMS Adapter:

Table A-39 UMS Adapter Activation Spec Properties

Property Name Description

JavaCalloutImpl

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.

Name-InboundThreadCount

The number of inbound poller or listener threads.

ConsumeMode

Specifies how the adapter will receive messages from UMS. Set to poller for polling mode Or set to listener for listener mode.

To

Address from which to receive incoming messages. One or more comma separated email address for the Email delivery type.

DeliveryType

Email support is provided for receiving and sending outgoing messages.

PollingInterval

Polling interval in seconds for poller consume mode.

MessageFilters

Specifies one or more message filters. A single filter would comprise a Java Pattern String to match the incoming message against, along with the field type and the action (accept or reject) to be taken.

Table A-40 UMS Adapter Interaction Spec Properties

Property Name Description

DeliveryType

Email support for only receive and sending outgoing messages.

Subject

Subject of outgoing message.

From

Sender addresses of outgoing message.

To

One or more recipient addresses.

Replyto

Reply-to address.

Cc

One or more cc addresses for email delivery.

Bcc

One or more bcc addresses for email delivery.

SendEmailAsAttachment

True to send email as an attachment.

Table A-41 UMS Adapter Message Headers

Header Field Name Minimum Occurrence Maximum Occurrence Mapped Adapter Header Field Name

Return-path

0

1

jca.ums.return-path

Received

0

unlimited

jca.ums.received

Resent-Date

0

unlimited

jca.ums.resent-date

Resent-From

0

unlimited

jca.ums.resent-from

Resent-Sender

0

1

jca.ums.resent-sender

Resent-To

0

unlimited

jca.ums.resent-to

Resent-Cc

0

unlimited

jca.ums.resent-cc

Resent-Bcc

0

unlimited

jca.ums.resent-bcc

Resent-Message-ID

0

unlimited

jca.ums.resent-message-id

Date

1

1

jca.ums.date

From

1

1

jca.ums.from (applies to SMS and IM also)

Sender

0

1

jca.ums.sender

Reply-to

0

1

jca.ums.reply-to

To

0

1

jca.ums.to (applicable to SMS and IM channels)

Cc

0

1

jca.ums.cc

Bcc

0

1

jca.ums.bcc

Message-ID

0

1

jca.ums.message-id

In-Reply-To

0

1

jca.ums.in-reply-to

References

0

1

jca.ums.references

Subject

0

1

jca.ums.subject (Applicable to SMS channel)

Comments

0

unlimited

jca.ums.comments

Keywords

0

unlimited

jca.ums.keywords

Table A-42 UMS Adapter Mime-Part Message Headers

Header Field Name Mapped Adapter Header Field Name Notes

Content-Type

jca.ums.msg.content-type

Applicable to all channels. For SMS and IM, the current supported type is text/plain only. For voice, it is text/vxml, text/x-vxml.

Content-Transfer-Encoding

jca.ums.msg.content- transfer-encoding

-

Content-ID

jca.ums.msg.content-id

-

Content-Description

jca.ums.msg.content- description

-

Content-Disposition

jca.ums.msg.content- disposition

-

Content-Language

jca.ums.msg.content-language

-

Mime-Extension-field

jca.ums.mime-extension-headers

Any other mime header field hat begins with the string “Content-“. You can add more than one header as Content-* : value CRLF Content*- : value

CRLF - \r\n

MIME-Version

jca.ums.mime-version

-

Table A-43 UMS Adapter Proprietary Headers

Header Name Description

jca.ums.msg.proprietary-headers

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)