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>

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

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.

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

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.

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.

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.ProxyCertificate^Foot 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.ProxyDistinguishedName^Foot 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.ProxyIsThickDriver^Foot 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.ProxyPassword^Foot 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.ProxyRoles^Foot 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.ProxyUserName^Foot 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.

Append

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

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

AsAttachment

If set to true, the inbound file is published as an attachment.

BatchSize

The batch size for the batching transformation.

CharacterSet

The character set for the attachment. This property 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

The chunk size for the chunked interaction operation. This property is applicable only to BPEL. Do not set it in Oracle Service Bus.

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

The mime-type of the attachment. This property 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.

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

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

Encoding

The encoding used for the attachment. This property 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

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

FileName

Specifies 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

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

IncludeFiles

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

Lenient

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 set to true, then the deployment goes through. The default value of this property is false.

ListSorter

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

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

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

LogicalErrorArchiveDirectory

Specifies the logical directory where the inbound Oracle File and FTP Adapters archive files in case of failures such as errors encountered during translation or publishing. The property is of type String and is not mandatory.

If not specified, the default archive directory is used. The default archive directory is typically under the control directory ControlDir, configured in the connection pool properties. For example, if ControlDir is /mycontroldir, then the default archive directory is /mycontroldir/fileftp/defaultArchive. If ControlDir is ${user.dir}, then the control directory is usually under the domain's fileftp folder (middleware_home/user_projects/domains/domain_name/fileftp).

LogicalArchiveDirectory

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

LogicalDirectory

Specifies the logical input directory to be polled. The property is of type String.

MaxRaiseSize

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 is 5.

MinimumAge

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

Used for outbound batching. The outgoing file is created when the number of messages condition is met. The property is of type int and is not mandatory. The default value is 1.

PhysicalErrorArchiveDirectory

Specifies the physical directory where the inbound Oracle File and FTP Adapters archive files in case of failures such as errors encountered during translation or publishing. The property is of type String and is not mandatory.

If not specified, the default archive directory is used. The default archive directory is typically under the control directory ControlDir, configured in the connection pool properties. For example, if ControlDir is /mycontroldir, then the default archive directory is /mycontroldir/fileftp/defaultArchive. If ControlDir is ${user.dir}, then the control directory is usually under the domain's fileftp folder (middleware_home/user_projects/domains/domain_name/fileftp).

PhysicalArchiveDirectory

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

PhysicalDirectory

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

PollingFrequency

Specifies how often to poll a given input directory for new files. The property 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 property is of type int and is not mandatory. The default value is 1.

For example, if a certain file has 11 records and this property 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 set to true, the Oracle File or FTP Adapter can process all the subdirectories 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 set to 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 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

The schema for the target file.

TargetSchemaRoot

The root element name for the target file.

TargetType

Set 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 property partitions the in-memory queue and each composite application gets its own in-memory queue.

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

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

• The maximum value is 40.

Recommended value for ThreadCount for good performance is 10.

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

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 to COPY, MOVE, or DELETE for the File IO interaction.

UseRemoteErrorArchive

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

If set to true, then the outbound Oracle File or FTP Adapter reads file headers and skips reading the payload.

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 to the XSL transformer between the source and the target.

FileType

Set to either ascii or binary depending on the requirement.

SourceIsRemote

Set 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 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

If set to true, the Oracle FTP Adapter uses the NLST FTP command instead of the LIST command that the adapter uses by default.

UseRemoteArchive

If set to true, the Oracle FTP Adapter is notified 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.

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

If set to true, the Oracle File and FTP Adapters do not 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

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

Overrides the encoding specified in the NXSD schema for inbound Oracle File and FTP Adapters.

NotifyEachBatchFailure

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

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

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

If set to true, Oracle File and FTP Adapters 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

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

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

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 set to false, then the translation step occurs outside the semaphore.

UseFileSystem

Used by inbound Oracle File and FTP Adapters during read-only polling in a clustered environment.If set to true, the adapter uses the file system to store the metadata of the processed files. If set to false, the adapter uses a database table.

TimestampOffset

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

Defines the time-out for the control socket to the FTP server. Specified in milliseconds.

jca.file.FileName

Specifies the name of the file read from the inbound directory or written to the outbound directory.

jca.file.Directory

Specifies the name of the directory from which file is read from or written to.

jca.file.Size

Specifies the size of the file published from the inbound Oracle File Adapter.

jca.file.Batch

Specifies 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

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

jca.ftp.FileName

Specifies the name of the file read from the inbound directory or written to the outbound directory.

jca.ftp.Directory

Specifies the name of the directory from which file is read from or written to.

jca.ftp.Size

Specifies the size of the file published from the inbound Oracle File Adapter. The size can be zero.

jca.ftp.Batch

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

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

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.

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.

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.

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.

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.

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.

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.