A Oracle JCA Adapter Properties

This appendix lists and describes the properties of Oracle JCA Adapters.

This appendix includes the following sections:

For more information, see Chapter 33, "Configuring Service and Reference Binding Components", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.

Oracle File and FTP Adapters Properties

This section describes the properties applicable to the Oracle File and FTP Adapters, including:

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

For more information, see:

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

Property Description

Append

If this property is set to true, it causes Oracle 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.

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 (same as the maximum value for dspMaxThreads in BPEL.)

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.

Distributed

This property specifies whether the Oracle File or FTP Adapter inbound directory is being polled in a distributed fashion. In other words, there are more than one processes polling the same directory in one or more managed servers.

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

If set to true, then the Oracle File Adapter does not complain if it does not have enough permission to read or write to the inbound directory. 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:

  • ListSorter="oracle.tip.adapter.file.sorter.TimestampSorterAscending in order to sort the file names by their modified timestamps in ascending manner or

  • ListSorter="oracle.tip.adapter.file.sorter.TimestampSorterDescending in order to sort the file names by their modified timestamps 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 will submit 100 files every minute.

MinimumAge

This parameter specifies the minimum age of files to be retrieved. This enables a large file to be completely copied into the input directory before it is retrieved for processing. The age is determined by the last modified time stamp. For example, if you know that it takes three to four minutes for a file to be written, then set the minimum age of pollable files to five minutes. If a file is detected in the input directory and its modification time is within five minutes of the current time, then the file is not retrieved because it is still potentially being written to.

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.

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 will be processed 2 records at a time and the final record will be processed in the sixth iteration.

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 already configured the outbound Oracle File or FTP Adapter for High Availability.

SingleThreadModel

If the value is true, 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 IO operation.

SourcePhysicalDirectory

The source directory for the File IO operation.

SourceSchema

Set it to the schema for the source file.

SourceSchemaRoot

Set it 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 IO operation.

TargetPhysicalDirectory

The target directory for the File IO 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 deafult, 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 is the same as that of the single-threaded model.

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

  • The maximum value for the ThreadCount property is 40.

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.

UseHeaders

This parameter can be set to true or false. If you need to read file headers and skip reading the payload while using inbound Oracle File and FTP Adapters, 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-2 JCA Properties Specific to Oracle FTP Adapter

Property Description

FileType

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

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.

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.

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.

Table A-3 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 is unable to 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.

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 or FTP Adapter call onBatchFailure only once after all the messages are debatched.

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

This property lets you control the size of rejected messages for inbound Oracle File or FTP Adapter partner link. For example, if you set it to 100, it will cause the Oracle 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 that you want to use 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 as a result 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 one of the 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 will never be 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.

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 (this means 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 or FTP Adapter 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 already processed files. Setting it to false causes the adapter to use a database table.

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

Oracle Socket Adapter Properties

This section describes the properties applicable to the Oracle Socket Adapter, including:

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

For more information, see Section 33.1.2.7, "Oracle Socket Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.

Table A-5 JCA Properties for Oracle Socket Adapter

Property Description

ByteOrder

Byte order of the remote machine 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 will be 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.

Xslt

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

Oracle AQ Adapter Properties

This section describes the properties applicable to the Oracle AQ Adapter, including:

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

For more information, see Section 33.1.2.1, "Oracle AQ Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.

Table A-6 JCA Properties for Oracle AQ Adapter: Normalized Properties

Property Description

Attempts

The number of failed attempts at dequeuing the message.

Correlation

User-assigned correlation ID.

Delay

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

EnqueueTime

The time at which the message was enqueued.

ExceptionQueue

The exception queue name.

Expiration

The number of seconds before the message expires. This parameter is an offset from the Delay parameter.

MessageID

The hexadecimal representation of the message ID.

OrigMessageId

The hexadecimal representation of the original message ID.

Priority

Priority of the message.

A smaller number indicates a higher priority.

RecipientList

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

Table A-7 JCA Properties for Oracle AQ Adapter: Endpoint Properties

Property Description

ConnectionRetryDelay

The time for which the Oracle AQ Adapter will wait before trying to re-create a connection after a connection is lost.

DequeueTimeOut

It is the interval after which the dequeue() API will time out if no message is received on the inbound queue.

Oracle JMS Adapter Properties

This section describes the properties applicable to the Oracle JMS Adapter, including:

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

For more information, see Section 33.1.2.5, "Oracle JMS Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.

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

Property Description

adapter.jms.encoding

Used to encode the text message.

adapter.jms.receive.threads

Supports multiple inbound receivers.

adapter.jms.receive.timeout

Timeout value used for the synchronous receive call. Valid only if UseMessageListener=false.

adapter.jms.registration.interval

This value is typically set higher because you do not have to register the MessageListener property too often. Only valid if UseMessageListener=true.

adapter.jms.retry.interval

Used by the inbound connection retry layer.

jca.jms.JMSDestinationName

The destination to which the message is sent, and is set by the JMS producer.

JMSCorrelationId

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

JMSDeliveryMode

Set to persistent or nonpersistent mode by the JMS producer.

JMSExpiration

Duration of the message before the expiration is set by the producer.

JMSMessageID

Unique message identifier set by the consumer.

JMSPriority

Number between 0 and 9 set by the consumer. A larger number represents a higher priority.

JMSRedelivered

Set by the JMS provider to indicate that the provider has tried to send this message once before to the consumer and has failed.

JMSReplyTo

Optional attribute indicating the destination to which to send a message reply. Can be set by the producer and consumer.

JMSReplyToDestinationProperties

Declaratively impose custom property settings on Destination objects received during inbound request/reply scenarios.

JMSReplyUseCorrelationIdForCorrelation

Used to specify whether correlation id should be used for correlation. Valid values are true and false.

JMSReplyUseMessageIdForCorrelation

Used to specify whether message id should be used for correlation. Valid values are true and false.

JMSTimestamp

Time stamp when the message was sent to the JMS provider for forwarding.

JMSType

JMS message type.

requestReply.cacheReceivers

If the same small number of JMS receivers are used for the same Request destination repeatedly, it will improve performance to set this property to true, but not if this does not apply. Default is false.

requestReply.useCorrelation

If true, will apply a JMS Message selector for obtaining the reply message. If the Request message header contains a user-specified CorrelationID, it will be used for correlation, otherwise the JMS Message ID property.

Note: the JMS adapter uses the following message selector: "JMSCorrelationID = '<corrId>' [ AND (<wsdlSelector>) ]" where the AND branch only is included if the user has specified a Selector in the WSDL. Default value of this property is true.

suppressHeaders

Bypass headers. For scenarios in which BPEL application does not use/produce these headers. Improves performance.

Oracle Database Adapter Properties

This section describes the properties applicable to the Oracle Database Adapter, including:

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

For more information, see:

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

Property Description

dataSourceName

This is a mandatory property. Refers to the JNDI name (jdbc/...) of the tx-level="local" data source connecting to. All operations using this pool will be locally transacted, independent on the global transaction. If both xADataSourceName and dataSourceName are specified, then the latter will be 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 already 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

  • MySQL4Platform

  • 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 will be 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 will 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 will bind to the global transaction and commit or roll back as a unit.

Table A-10 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 WebLogic Server 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, then set none of jca.db.ProxyDistinguishedName, jca.db.ProxyUser, and jca.db.ProxyPassword.

jca.db.ProxyDistinguishedNameFootref 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.ProxyIsThickDriverFootref 1

Outbound. Valid 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.ProxyPasswordFootref 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.ProxyRolesFootref 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.ProxyUserNameFootref 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 WebLogic Server 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.

Oracle MQ Series Adapter Properties

This section describes the properties applicable to the Oracle AQ Adapter, including:

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

For more information, see Section 33.1.2.6, "Oracle MQ Adapter", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.

Table A-11 JCA Properties for Oracle MQ Series Adapter

Property Description

jca.mq.Inbound.MQMD.CorrelId

Outbound

jca.mq.Inbound.MQMD.MsgId

Outbound

jca.mq.Inbound.MQMD.MsgType

Outbound

jca.mq.Inbound.MQMD.Nan

Outbound

jca.mq.Inbound.MQMD.Pan

Outbound

jca.mq.Inbound.MQMD.ReplyToQ

Outbound

jca.mq.Inbound.MQMD.ReplyToQMgr

Outbound

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

Outbound

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

Outbound

jca.mq.ISpec.EnqueueMsgToQ

Outbound

jca.mq.ISpec.EnqueueMsgToQMgr

Outbound

jca.mq.MQMD.AccountingToken

Inbound/Outbound

jca.mq.MQMD.ApplIdentityData

Inbound/Outbound

jca.mq.MQMD.ApplOriginData

Inbound/Outbound

jca.mq.MQMD.BackoutCount

Inbound/Outbound

jca.mq.MQMD.CodedCharSetId

Inbound/Outbound

jca.mq.MQMD.CorrelId

Inbound/Outbound

jca.mq.MQMD.Encoding.Decimal

Inbound/Outbound

jca.mq.MQMD.Encoding.Float

Inbound/Outbound

jca.mq.MQMD.Encoding.Integer

Inbound/Outbound

jca.mq.MQMD.Expiry

Inbound/Outbound

jca.mq.MQMD.Feedback

Inbound/Outbound

jca.mq.MQMD.Feedback.ApplicationDefined

Inbound/Outbound

jca.mq.MQMD.Format

Inbound/Outbound

jca.mq.MQMD.GroupId

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsLastMsgInGroup

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsLastSegment

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsMsgInGroup

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsSegment

Inbound/Outbound

jca.mq.MQMD.MsgId

Inbound/Outbound

jca.mq.MQMD.MsgSeqNumber

Inbound/Outbound

jca.mq.MQMD.MsgType

Inbound/Outbound

jca.mq.MQMD.MsgType.ApplicationDefined

Inbound/Outbound

jca.mq.MQMD.Offset

Inbound/Outbound

jca.mq.MQMD.OriginalLength

Inbound/Outbound

jca.mq.MQMD.Persistence

Inbound/Outbound

jca.mq.MQMD.Priority

Inbound/Outbound

jca.mq.MQMD.PutApplName

Inbound/Outbound

jca.mq.MQMD.PutApplType

Inbound/Outbound

jca.mq.MQMD.PutApplType.UserDefined

Inbound/Outbound

jca.mq.MQMD.PutDateTime

Inbound/Outbound

jca.mq.MQMD.ReplyToQ

Inbound/Outbound

jca.mq.MQMD.ReplyToQMgr

Inbound/Outbound

jca.mq.MQMD.Report.Generate.COA

Inbound/Outbound

jca.mq.MQMD.Report.Generate.COD

Inbound/Outbound

jca.mq.MQMD.Report.Generate.CorrelId

Inbound/Outbound

jca.mq.MQMD.Report.Generate.Exception

Inbound/Outbound

jca.mq.MQMD.Report.Generate.Expiry

Inbound/Outbound

jca.mq.MQMD.Report.Generate.MsgId

Inbound/Outbound

jca.mq.MQMD.Report.Generate.NAN

Inbound/Outbound

jca.mq.MQMD.Report.Generate.PAN

Inbound/Outbound

jca.mq.MQMD.Report.TakeAction.OnMsgDeliveryFailure

Inbound/Outbound

jca.mq.MQMD.StrucId

Inbound/Outbound

jca.mq.MQMD.UserIdentifier

Inbound/Outbound

jca.mq.MQMD.Version

Inbound/Outbound

Table A-12 Connection Properties for Oracle MQ Series Adapter

Property Description

hostName

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 will have its private keys. This is required when an adapter needs to 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 needs to 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, then this variable can be used 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 allows 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 gets triggered when you send a message to a particular queue.

Generic Oracle JCA Adapter Properties

This section describes the properties applicable to all Oracle JCA Adapters, including:

For properties specific to each of the Oracle JCA Adapters, see:

For more information, see Section 33.1.2.8, "Oracle JCA Adapters Endpoint Properties", in the Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite.

Table A-13 JCA Properties for all Oracle JCA Adapters

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, the Oracle Service Bus can automatically resolve the WSDL to allow bulk import of JCA files and related WSDL and schemas.

The example below 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>