WTCRemoteTuxDomMBean

Overview

This interface provides access to the WTC remote Tuxedo Domain configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.

Attributes

This section describes the following attributes:

AccessPoint

The unique name used to identify this remote Tuxedo access point. This name should be unique for all local and remote Tuxedo access points defined within a WTC Service. This allows you to define unique configurations having the same Access Point ID.

AccessPointId

The connection principal name used to identify this remote domain access point when attempting to establish a session connection to local Tuxedo access points. This value must be globally unique among all interconnected Tuxedo and WTC Domains.

AclPolicy

The inbound access control list (ACL) policy toward requests from a remote Tuxedo access point.

The allowed values are:

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

• GLOBAL: The local Tuxedo access point passes the service request with no change in identity.

Note: If Interoperate is set to Yes, AclPolicy is ignored.

AllowAnonymous

Specifies whether the anonymous user is allowed to access remote Tuxedo services.

Note: If the anonymous user is allowed to access Tuxedo, the default AppKey will be used for TpUsrFile and LDAP AppKey plug-ins. Interaction with the Custom AppKey plug-in depends on the design of the Custom AppKey generator.

AppKey

Specifies the type of AppKey plug-in used.

The allowed values are:

• TpUsrFile: TpUsrFile is the default plug-in. It uses an imported Tuxedo TPUSR file to provide user security information. Previous releases of WebLogic Tuxedo Connector support this option.

• LDAP: The LDAP plug-in utilizes an embedded LDAP server to provide user security information. The user record must define the Tuxedo UID and GID information in the description field. This functionality is not supported in previous releases of WebLogic Tuxedo Connector.

• Custom: The Custom plug-in provides the ability to write your own AppKey generator class to provide the security information required by Tuxedo. This functionality is not supported in previous releases of WebLogic Tuxedo Connector.

CachingDisabled

Private property that disables caching in proxies.

CmpLimit

The compression threshold this remote Tuxedo access point uses when sending data to a local Tuxedo access point. Application buffers larger than this size are compressed.

Range of Values: Between 0 and a positive 32-bit integer.

ConnectionPolicy

The conditions under which this remote Tuxedo access point establishes a session connection with a local Tuxedo access point.

The allowed values are:

• 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 Tuxedo access points at gateway server initialization time. Remote services (services advertised in JNDI by the domain gateway for this local Tuxedo access point) are advertised only if a connection is successfully established to that remote Tuxedo access point. If there is no active connection to a remote Tuxedo access point, then the remote services are suspended. By default, this connection policy retries failed connections every 60 seconds. Use the MaxRetry and RetryInterval attributes to specify application specific values.

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

• LOCAL: Specifies that the remote domain connection policy is explicitly defaulted to the local domain ConnectionPolicy attribute value.

ConnPrincipalName

The principal name used to verify the identity of this remote Tuxedo access point when it establishes a session connection with a local Tuxedo access point. If not specified, the connection principal name defaults to the AccessPointID for this access point.

Note: This parameter only applies to domains of type TDOMAIN that are running Oracle Tuxedo 7.1 or later software.

Note: ConnPrincipalName is not supported in this release.

CredentialPolicy

The outbound access control list (ACL) policy toward requests to a remote Tuxedo access point.

The allowed values are:

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

• GLOBAL: The remote Tuxedo access point passes the service request with no change.

Note:If Interoperate is set to Yes, CredentialPolicy is ignored.

CustomAppKeyClass

The full pathname to the custom AppKey generator class. (This class is only relevant if you specify Custom as the AppKey Generator.)

Note: This class is loaded at runtime if the Custom AppKey generator plug-in is selected.

CustomAppKeyClassParam

The optional parameters to be used by the custom AppKey class at the class initialization time. This class is only relevant if you specify Custom as the AppKey Generator.)

DefaultAppKey

The default AppKey value to be used by the anonymous user and other users who are not defined in the user database if the plug-in allows them to access Tuxedo.

Note: The TpUsrFile and LDAP plug-ins do not allow users that are not defined in user database to access Tuxedo unless Allow Anonymous is enabled.

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

FederationName

The context at which this remote Tuxedo access point federates to a foreign name service. If omitted, the default federation point is tuxedo.domains.

FederationURL

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

Note: The Weblogic Tuxedo Connector can federate to non-CORBA service providers.

Note: If this value is not specified, the WebLogic Tuxedo Connector:

• Assumes there is a CosNaming server in the foreign domain.

• Federates to the CosNaming server using TGIOP.

Id

Return the unique id of this MBean instance

KeepAlive

Indicates whether this remote Tuxedo access point is configured with Application Level Keep Alive.

• Greater than 0: Application Level Keep Alive is enabled and the value indicates the amount of idle time, in milliseconds rounded to the nearest second, allowed before starting the wait timer.

• 0: Application Level Keep Alive is not enabled for the access point.

• -1: Application Level Keep Alive is enabled and indicates that the value from the local Tuxedo access point is used to indicate the amount of idle time, in milliseconds rounded to the nearest second, allowed before starting the wait timer.

KeepAliveWait

Indicates whether this remote Tuxedo access point requires the acknowledgement of Application Level Keep Alive. If the value is:

• Greater than 0: Application Level Keep Alive is enabled and the value indicates the amount of idle time, in milliseconds rounded to the nearest second, allowed before WebLogic Tuxedo Connector marks the connection as failed if the heartbeat is not acknowledged.

• 0: Application Level Keep Alive is not enabled for the access point but the access point acknowledges if a heartbeat is received.

LocalAccessPoint

The local domain name from which this remote Tuxedo domain is reached.

MaxEncryptBits

The maximum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection. A value of 0 indicates no encryption is used.

Value Restrictions:

• The value of the MaxEncryptBits attribute must be greater than or equal to the value of the MinEncrypBits attribute.

• A MaxEncryptBits of 40 can be used only with domains running Tuxedo 7.1 or higher.

MaxRetries

The maximum number of times that this remote Tuxedo access point tries to establish a session connections to local Tuxedo access points. Use only when the ConnectionPolicy value is set to ON_STARTUP.

Note: When the ConnectionPolicy value is LOCAL, the MaxRetries value from the local Tuxedo access point is used. When the ConnectionPolicy value is ON_STARTUP, a value of -1 indicates 9223372036854775807.

Range of Values: Between -1 and a positive 64-bit integer.

• Use 0 to disable the retry mechanism.

• Use the maximum value to try until a connection is established.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

MinEncryptBits

The minimum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection. A value of 0 indicates no encryption is used.

Value Restrictions:

• The MinEncrypBits value must be less than or equal to the MaxEncrypBits value.

• A MinEncrypBits value of 40 can be used only with domains running Tuxedo 7.1 or higher.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

Notes

Optional information that you can include to describe this configuration.

WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

NWAddr

The network address and port number of this remote Tuxedo access point.

Specify the address in one of the following formats:

• TCP/IP address in the format //hostname:port_number or //#.#.#.#:port_number.

• SDP address in the format sdp://hostname:port_number or sdp://#.#.#.#:port_number.

• If the hostname is used, the access point 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/SDP port number at which the access point listens for incoming requests.

• If SDP format address is specified, the transport protocol for this access point is SDP instead of TCP. This feature is only available when WTC and Tuxedo domain gateway are both deployed on Oracle Exalogic platform. Requires Tuxedo 11gR1PS2 and higher.

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

Parent

Return the immediate parent for this MBean

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

RetryInterval

The number of seconds that this remote Tuxedo access point waits between automatic connection attempts to local Tuxedo access points. Use this only when the ConnectionPolicy value is set to ON_STARTUP.

Range of Values: Between -1 and a positive 32-bit integer.

Note: When the ConnectionPolicy value is LOCAL, the RetryInterval value from the local Tuxedo access point is used. When the ConnectionPolicy value is ON_STARTUP, a value of -1 indicates 60.

SSLProtocolVersion

The protocol version of the SSL connection this remote access point uses when establishing a SSL connection with specific local access point.

Value Restrictions:

• TLSv1.0

• TLSv1.1

• TLSv1.2

Tags

Return all tags on this Configuration MBean

TpUsrFile

The full path to the user password file containing UID/GID information. (This field is only relevant if you specify TpUsrFile as the AppKey Generator.)

Note: This file is generated by the Tuxedo tpusradd utility on the remote Tuxedo domain specified by the remote Tuxedo access point. A copy of this file must be available in your WebLogic Tuxedo Connector environment to provide correct authorization, authentication, and auditing.

TuxedoGidKw

The keyword for Tuxedo GID (Group ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap. This field is only relevant if you specify LDAP as the AppKey Generator.)

Note: The keyword is used to find Tuxedo GID in the user record in the embedded LDAP database.

TuxedoUidKw

The keyword for Tuxedo UID (User ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap. This keyword is only relevant if you specify LDAP as the AppKey Generator.)

Note: The keyword is used to find Tuxedo UID in the user record in the embedded LDAP database.

Type

Returns the type of the MBean.

Operations

This section describes the following operations:

addTag

Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note: To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

getInheritedProperties

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

isInherited

Check if the value of a property is inherited from template mbean or not.

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

removeTag

Remove a tag from this Configuration MBean

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.