Elements and Attributes of the wtc_config.dtd

 

The following sections contain reference information on the elements and attributes contained in the wtc_config.dtd:

• WTC_CONFIG

• BDMCONFIG

• tBridge

WTC_CONFIG

WTC_CONFIG is the root of the WebLogic Tuxedo Connector deployment descriptor. WTC_CONFIG has two children:

• BDMCONFIG

• tBridge

BDMCONFIG

The BDMCONFIG element provides information on how to configure domains in the WebLogic Tuxedo Connector. The configuration parameters are analogous to the DM_MIB attributes and classes used for Tuxedo domains.

T_DM_LOCAL_TDOMAIN

The T_DM_LOCAL_DOMAIN provides a view of local domains as they appears to other domains.

Attribute	Description	Type	Use
AccessPoint	Label used to identify a domain in a configuration XML file. This label must be unique within the scope of T_DM_LOCAL_TDOMAIN and T_DM_REMOTE_TDOMAIN AccessPoint names in a configuration XML file. Example: TDOM2	CDATA	#REQUIRED

WlsClusterName

Note: Although WebLogic Tuxedo Connector does not support clustering in this release of WebLogic Server, you must provide a WlsClusterName.

Required. WlsClusterName gives the name of the WebLogic Server cluster in the WSL domain on which this local access point resides.

Example: cluster20

AccessPointId

Required. Specifies the connection principal name used to identify a domain when establishing a connection to another domain.

• The AccessPointId of a T_DM_LOCAL_TDOMAIN must match the corresponding DOMAINID in the *DM_REMOTE_DOMAINS section of your Tuxedo DMCONFIG file.

• The AccessPointId of a T_DM_REMOTE_TDOMAIN must match the corresponding DOMAINID in the *DM_LOCAL_DOMAINS section of your Tuxedo DMCONFIG file.

Example: TDOM2

Type

Optional. If specified the value must be the string TDOMAIN.

Security

Note: Tuxedo 6.5 users should set the security parameter to NONE.

Optional. Security specifies the type of application security to be enforced. Valid values for this parameter are: NONE, APP_PW, or DM_PW.

• NONE: No security is used. This is the default value.

• APP_PW: Password security is enforced when a connection is established from a remote domain. The application password must be defined in a T_DM_PASSWORD element.

• DM_PW: Domain password security is enforced when a connection is established from a remote domain. Domain passwords must be defined in the T_DM_PASSWORD element.

ConnectionPolicy

Optional. Specifies the conditions under which a local domain tries to establish a connection to a remote domain.

• Valid values for local domains are: ON_DEMAND, ON_STARTUP, or INCOMING_ONLY.

• Valid values for remote domains are: ON_DEMAND, ON_STARTUP, INCOMING_ONLY, or LOCAL.

• Default setting is ON_DEMAND

  • ON_DEMAND: A connection is attempted only when requested by either a client request to a remote service or an administrative connect command.

  • ON_STARTUP: A domain gateway attempts to establish a connection with its remote domain access points at gateway server initialization time. Remote services (services advertised in JNDI by the domain gateway for this local access point) are advertised only if a connection is successfully established to that remote domain access point. If there is no active connection to a remote domain access point, then the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds. Use the MaxRetry and RetryInterval elements to specify application specific values.

  • INCOMING_ONLY: A domain gateway does not attempt an initial connection to remote domain access points at startup and remote services are initially suspended. The domain gateway is available for incoming connections from remote domain access points and remote services are advertised when the domain gateway for this local domain access point receives an incoming connection. Connection retry processing is not allowed.

  • LOCAL: Indicates the remote domain connection policy is explicitly defaulted to the local domain ConnectionPolicy attribute value. If the remote domain ConnectionPolicy is not defined, the system uses the setting specified by the associated local domain (specified by the LocalAccessPoint).

RetryInterval

Optional. The time (seconds) between automatic attempts to establish a connection to remote domain access points. Use only when ConnectionPolicy is set to ON_STARTUP.

• Minimum value: 0

• Maximum value: 2147483647

• Default setting: 60

MaxRetries

Optional. The number of times that a domain gateway tries to establish connections to remote domain access points. Use only when ConnectionPolicy is set to ON_STARTUP.

• Minimum value: 0

• Maximum value: 2147483647.

• Default value: 2147483647

Use the maximum value to retry processing until a connection is established. Use the minimum value to disable the automatic retry mechanism.

ConnPrincipalName

Note: ConnPrincipalName is not supported in this release of WebLogic Server.

Optional. Specifies the connection principal name identifier. This is the principal name for identifying a domain when establishing a connection to another domain. This parameter only applies to domains of type TDOMAIN that are running BEA Tuxedo 7.1 or later software.

• If this element is not specified, the connection principal name defaults to the AccessPoint element for this domain.

NWAddr

Note: When configuring the NWAddr for a T_DM_LOCAL_DOMAIN, the port number used should be different from any port numbers assigned to other WebLogic Server processes. Example: Setting the NWAddr to //mymachine:7001 is not valid if the WebLogic Server listening port is assigned to //mymachine:7001.

Required. The network address of the local domain gateway. Specify the TCP/IP address in one of the following formats:

• //hostname:port_number

• //#.#.#.#:port_number

If hostname is used, the domain finds an address for hostname using the local name resolution facilities (usually DNS). If dotted decimal format is used, each # should be a number from 0 to 255. This dotted decimal number represents the IP address of the local machine. The port_number is the TCP port number at which the domain process listens for incoming requests.

CmpLimit

Optional. Specifies the compression threshold used when sending data to the remote domain. Application buffers larger than this size are compressed.

• Default value: 2147483647 bytes

MinEncryptBits

Note: A MinEncryptBits value of 40 only applies to domains of type TDOMAIN that are running BEA Tuxedo 7.1 or later software.

Optional. Specifies the minimum level encryption key length (in bits) used when establishing a network link for this domain.Valid values for this parameter are: 0, 40, 56, and 128.

• Default value: 0 bits

• A value of 0: No encryption used

• If this minimum level of encryption cannot be met, the network link fails.

MaxEncryptBits

Note: A MaxEncryptBits value of 40 only applies to domains of type TDOMAIN that are running BEA Tuxedo 7.1 or higher.

Optional. Specifies the maximum level encryption key length (in bits) used when establishing a network link for this domain.Valid values for this parameter are: 0, 40, 56, and 128.

• Default value: 128 bits

• A value of 0: No encryption used

Interoperate

Note: Optional. Specifies whether the local domain interoperates with remote domains that are based upon Tuxedo Release 6.5. Tuxedo 6.5 does not have the required security infrastructure to support security mapping. If you require security features and use the WebLogic Tuxedo Connector, you will need to upgrade to Tuxedo 7.1 or higher.

Valid values for this parameter are: Yes, No.

• Yes: Interoperate with Tuxedo 6.5

• No: Operates with domains Tuxedo 7.1 and higher.

• Default value: No

BlockTime

Optional. Specifies the maximum wait time (seconds) allowed for a blocking call.

T_DM_REMOTE_TDOMAIN

The T_DM_REMOTE_TDOMAIN provides a view of remote domains as they appear to the local domain.

Attribute	Description	Type	Use
AccessPoint	Label used to identify a domain in a configuration XML file. This label must be unique within the scope of T_DM_LOCAL_TDOMAIN and T_DM_REMOTE_TDOMAIN AccessPoint names in a configuration XML file. Example:TDOM3	CDATA	#REQUIRED

LocalAccessPoint

Required. The local domain name from which a remote domain is reached.

Example: TDOM2

AclPolicy

Note: If the Interperate parameter is set to Yes, the AclPolicy is ignored. For more information see, Interoperate.

Optional. Specifies the inbound access control list (ACL) policy toward requests from a remote domain. Valid values for this parameter are: LOCAL, GLOBAL.

• LOCAL: The local domain modifies the identity of the service requests received from a given remote domain to the principal name specified in the local principal name for a given remote domain.

• GLOBAL: The local domain passes the service request with no change in identity.

• Default value: LOCAL

CredentialPolicy

Note: If the Interperate parameter is set to Yes, the CredentialPolicy is ignored. For more information see, Interoperate.

Optional. Specifies the outbound access control list (ACL) policy toward requests to a remote domain. Valid values for this parameter are: LOCAL, GLOBAL.

• LOCAL: The remote domain controls the identity of service requests received from the local domain to the principal name specified in the local principal name for this remote domain.

• GLOBAL: The remote domain passes the service request with no change.

• Default value: LOCAL

FederationURL

The URL for a foreign name service that is federated into the JNDI.

If ommitted, the WebLogic Tuxedo Connector assumes that there is a CosNaming server in the foreign domain. The WebLogic Tuxedo Connector federates to the CosNaming server using TGIOP. It is possible to federate to non-CORBA service providers.

FederationName

The context at which to federate to a foreign name service. If ommitted, the federation point is tuxedo.domains.

TpUsrFile

Optional. Full path to user password file containing uid/gid information. This is the same file generated by the Tuxedo tpusradd utility on the remote domain. Username, uid and gid information must be included and valid for correct authorization, authentication, and auditing.

T_DM_EXPORT

T_DM_EXPORT provides information on services exported by a local domain.

• If not specified, all local domains accept requests to all of the services according to the default JNDI lookup rules (see EJBName).

• If the section is defined, use it to restrict the set of local services requested from a remote domain.

Attribute	Description	Type	Use
ResourceName	The ResourceName attribute describes a exported service entry.	CDATA	#REQUIRED
LocalAccessPoint	The local access point name.	CDATA	#REQUIRED

RemoteName

Optional. The remote name of the service.

• If not specified, the ResourceName attribute is used.

EJBName

Optional. The complete name of the EJB home interface to use when invoking a service.

• If this element is not specified, the default interface used is tuxedo.services.servicenameHome.

  Example: If the service being invoked is TOUPPER and the EJBName attribute is not specified, the home interface looked up in JNDI would be tuxedo.service.TOUPPERHome.

T_DM_IMPORT

The T_DM_IMPORT provides information on services imported and available on remote domains. If T_DM_IMPORT is not configured, remote domains handle all remote services.

Attribute	Description	Type	Use
ResourceName	The ResourceName attribute describes an imported service entry. The combination of the ResourceName, LocalAccessPoint and RemoteAccessPointList attributes must be unique among all objects of this type. Example: //simpapp	CDATA	#REQUIRED
LocalAccessPoint	Specifies the local access point through which a service is offered. Example: TDOM2	CDATA	#REQUIRED
RemoteAccessPointList	A comma-separated failover list that identifies the remote domain access points through which a resource is imported. Example: TDOM3,TDOM4,TDOM5	CDATA	#REQUIRED

TranTime

Note: TranTime is not supported for this release of WebLogic Tuxedo Connector.

Optional. Specifies the default timeout value (seconds) for a transaction started in an associated service. It is the total time from the start of a transaction through the execution of the rollback or commit. 0 implies the maximum timeout value.

• Minimum value: 0

• Maximum value: 2147483648

• Default value: 30

T_DM_PASSWORD

The T_DM_PASSWORD class represents configuration information for inter-domain authentication through access points of type TDOMAIN.

Attribute	Description	Type	Use
LocalAccessPoint	The name of the local domain access point to which the password applies. Example: TDOM2	CDATA	#REQUIRED
RemoteAccessPoint	The name of the remote domain access point to which the password applies. Example: TDOM3	CDATA	#REQUIRED

LocalPassword

Required. The encrypted local password as returned from the genpasswd utility. This password is used to authenticate connections between the local domain access point identified by LocalAccessPoint and the remote domain access point identified by RemoteAccessPoint.

Attribute	Description	Type	Use
IV	The initialization vector used to encrypt the local password.	CDATA	#REQUIRED

RemotePassword

Required. The encrypted remote password as returned from the genpasswd utility. This password is used to authenticate connections between the local domain access point identified by LocalAccessPoint and the remote domain access point identified by RemoteAccessPoint.

Attribute	Description	Type	Use
IV	The initialization vector used to encrypt the remote password	CDATA	#REQUIRED

T_DM_RESOURCES

Use to specify global field table classes and application passwords for domains.

FieldTables

Optional. Identifies a list of FldTbls tables available to WebLogic Tuxedo Connector users. These tables are created via the mkfldclass or mkfldclass32 utilities and compiled into java classes. The array is used for FML and FML32 operations and is accessible through the getFldTbls(fml16|fml32) utility.

FldTblClass

Required. The name of the field table class loaded via a class loader and added to a FldTbl array. The class name used is the fully qualified name of the desired class.

Attribute	Description	Use
Type	Flag indicating what class type is used for FML / FML32 operations. Valid values are: fml16 fml32	#REQUIRED

AppPassword

Optional. The encrypted application password as returned from the genpasswd utility. This global password is used to authenticate connections between all domain access points.

Attribute	Description	Type	Use
IV	The initialization vector used to encrypt the global password	CDATA	#REQUIRED

tBridge

Note: The tBridge handles one or more redirections by starting a new thread for each redirection defined. At least one redirection must be specified or the tBridge fails and an error is logged.

Configuring the optional tBridge provides bi-directional transport of XML messages between WebLogic Server and Tuxedo.

direction

Required. Specifies the direction of data flow. Valid parameter values are: JmsQ2TuxQ, TuxQ2JmsQ, JmsQ2TuxS.

• JmsQ2TuxQ: From JMS to TUXEDO /Q.

• TuxQ2JmsQ: From TUXEDO /Q to JMS.

• JmsQ2TuxS: From JMS to TUXEDO Service reply to JMS.

fromto

Required. Element used to specify the source, target, direction, and transport of a message.

redirect

Required. Element used to redirect a message.

source

Required. The source location of a message.

target

Required. The target location to place a message

AccessPoint

Optional. An identifier unique within the scope of T_DM_LOCAL_TDOMAIN and T_DM_REMOTE_TDOMAIN entry names in the domain configuration.

Example: TDOM2

Qspace

Optional. Name of the Qspace for a source or target location.

Name

Required. Name of a JMS queue name, TUXEDO queue name, or a TUXEDO service name.

ReplyQ

Optional. Name of a JMS queue specifically for the synchronous call to a TUXEDO service. The response is returned to the JMS ReplyQ.

metadataFile

Note: This element is not supported in this release of WebLogic Tuxedo Connector.

Optional. URL of the metadata file.

translateFML

Note: The WLXT parameter value is not supported in this release of WebLogic Tuxedo Connector.

Required. Specifies the type of XML/FML translation. Valid parameter values are: NONE, FLAT, WLXT.

• NO: No data translation is performed. TextMessage maps into STRING and vice versa depending on the direction of transfer. BytesMessage maps into CARRAY and vice versa. All other data types cause the redirection to fail.

• FLAT: The message payload is transformed using the WebLogic Tuxedo Connector built-in translator.

• WLXT: The translation is done by the XML-to-nonXML WL XML Translator (WLXT). The metadataFile URL provided is passed to call the WLXT external methods to do the translation.

• Default value: NO

transactional

Note: This element is not supported in this release of WebLogic Tuxedo Connector.

Optional. Specifies the use of transactions when retrieving messages from a source location and when placing messages on a target location. Valid parameter values are: YES, NO.

• YES: Transactions are used for both operations.

• NO: Transactions are not used for either operation.

timeout

Note: The timeout for the transaction used to retrieve the message from the source location is larger than timeout. This parameter reflects the effective length of the timeout for the entire redirection.

Optional. Specifies the transaction timeout value (seconds) used to place a message on a target location. Required when transactional parameter is set to YES.

• Default value is 60.

• The value must be 0 or a positive integer.

• 0 indicates an infinite wait.

idleTime

Note: This element is not supported in this release of WebLogic Tuxedo Connector.

Optional. Specifies the amount of idle time (seconds) to wait before checking the source location for new messages. If a message is detected, all the messages on the source location are processed sequentially.

• Default value is 0.

• The value must be 0 or a positive integer.

retries

Optional. Specifies the number of attempts to redirect a message before putting the message in the specified error location and logging an error.

• Default value is 0.

• The value must be 0 or a positive integer.

retryDelay

Note: During the retryDelay, the thread processing the message can not redirect any other messages.

Optional. Specifies the minimum amount of time (milliseconds) to wait before redirecting a message.

• Default value is 10.

• The value must be a positive integer.

wlsErrorDestination

Optional. Name of the location used to store WebLogic Server JMS messages when a message cannot be redirected.

• If a wlsErrorDestination is not specified, all messages that cannot be redirected are lost.

• If the message cannot be placed into the wlsErrorDestination for any reason, an error is logged and the message is lost.

tuxErrorQueue

Optional. Name of the Tuxedo queue used to store a message that cannot be redirected to a Tuxedo/Q source queue. This queue is in the same queue space as the source queue.

• If tuxErrorDestination is not specified, all messages that cannot be redirected are lost.

• If the message cannot be placed into the tuxErrorQueue for any reason, an error is logged and the message is lost.

defaultRelativeBirthtime

Note: This element is not supported in this release of WebLogic Tuxedo Connector.

Optional. Specifies the deq_time (seconds) for a message being redirected into Tuxedo from WebLogic Server if the JMS_BEA_TuxGtway_Tuxedo_Birthtime property is not set.

defaultRelativeExpiration

Note: This element is not supported in this release of WebLogic Tuxedo Connector.

Optional. Specifies the exp_time (seconds) for a message being redirected into Tuxedo from WebLogic Server if the JMSExpiration property is not set.

It is not possible to get the expiration time from a Tuxedo/Q message. Use defaultRelativeExpiration to set an expiration time for messages being redirected to Tuxedo/Q.)

expirationAdjustment

Note: This element is not supported in this release of WebLogic Tuxedo Connector.

Optional. Specifies the amount of time (seconds) that is added to the expiration time of a message before it is put onto the target location.

• This value is added to the expiration time when the expiration time for a message is non-zero prior to being retrieved from the source location.

• Use this adjustment to account for any network or processing latency incurred as a result of using the tBridge.

priorityMapping

Required. Provides a method to map the priorities between the JMS and Tuxedo.

• JMS has ten priorities (0 - 9).

• Tuxedo/Q has 100 priorities (1 - 100).

The priorityMapping section provides a mechanism to map the priorities between the Tuxedo and JMS subsystems. There are two mapping directions:

• JmstoTux

• TuxtoJms

Defaults are provided for all values, shown below in pairs of value:range. The default values are overridden by describing pMap pairs for a mapping direction. The value specifies the given input priority and the range specifies a sequential group of resulting output priorities.

JmstoTux- 0:1 | 1:12 | 2:23 | 3:34 | 4:45 | 5:56 | 6:67 | 7:78 | 8:89 | 9:100

TuxtoJms- 1-10:0 | 11-20:1 | 21-30:2 | 31-40:3 | 41-50:4| 51-60:5 | 61-70:6 | 71-80:7 | 81-90:8 | 91-100:9

JmstoTux

Required. Used to specify the priority mapping direction from JMS into Tuxedo /Q message priority.

TuxtoJms

Required. Used to specify the priority mapping direction from Tuxedo /Q into JMS message priority.

pMap

Required. The pMap element contains two elements: value and range. The value specifies the given input priority and the range specifies a sequential group of resulting output priorities.

range

Required. The range specifies a sequential group of resulting output priorities (right side of the pMap).

value

Required. The value specifies the given input priority (left side of the pMap).

deliveryModeOverride

Note: If deliveryModeOverride is not specified, then the message is placed on the target location with the same delivery mode specified from the source location.

Optional. Specifies the delivery mode to use when placing messages onto the target location.The deliveryModeOverride value overrides any delivery mode associated with a message. Valid values for this parameter are: PERSIST, NONPERSIST.

defaultReplyDeliveryMode

Note: If neither defaultReplyDeliveryMode is specified or JMS_BEA_TuxGtway_Tuxedo_ReplyDeliveryMode is set, the default semantics defined for Tuxedo are used by the Tuxedo/Q subsystem.

Optional. Specifies the reply delivery mode to associate with a message when placing messages onto the target location. Use this element for messages being redirected to Tuxedo/Q from JMS when the JMS_BEA_TuxGtway_Tuxedo_ReplyDeliveryMode property is not set for a message. Valid values for this parameter are: PERSIST, NONPERSIST, DEFAULT.

userID

Optional. Specifies a user identity for all messages handled by the tBridge for ACL checks when security options are configured.

• All messages assume this identity until the security/authentication contexts are passed between subsystems. Until security contexts are passed, there is no secure method to identify who generated a message recieved from the source location.

• The argument user may be specified as either a user name or a user identification number (uid).

allowNonStandardTypes

Optional. Specifies if non-standard data types are allowed to pass through the tBridge. Valid values for this parameter are: NO, YES.

• NO: Non-standard data types are rejected and placed onto the specified error location.

• YES: Non-Standard data types are placed on the target location as BLOBs with a tag indicating the original type.

Standard data types are:

• ASCII text (TextMessage, STRING)

• BLOB (BytesMessage, CARRAY)

jndiFactory

Required. Name of the JNDI lookup factory.

Example: weblogic.jndi.WLInitialContextFactory

jmsFactory

Required. Name of the JMS connection factory.

Example: weblogic.jms.ConnectionFactory

tuxFactory

Required. Name of the Tuxedo Connection factory.

Example: tuxedo.services.TuxedoConnection