WTCRemoteTuxDomMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

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.

Since 7.0.0.0    
Security roles The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:

  • Deployer
   
Fully Qualified Interface Name If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.WTCRemoteTuxDomMBean
   
Factory Methods No factory methods. Instances of this MBean are created automatically.

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value myRAP

 

AccessPointId

The connection principal name used to identify this remote Tuxedo access point when attempting to establish a session connection to local Tuxedo access points.

   
Privileges Read/Write    
Type java.lang.String
Default Value myRAPId

 

AclPolicy

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

The allowed values are:

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

   
Privileges Read/Write    
Type java.lang.String
Default Value LOCAL
Legal Values

  • GLOBAL

  • LOCAL

 

AllowAnonymous

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.

   
Privileges Read/Write    
Type boolean

 

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value TpUsrFile
Legal Values

  • TpUsrFile

  • LDAP

  • Custom

 

CachingDisabled

Private property that disables caching in proxies.

   
Privileges Read only    
Type boolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

 

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.

   
Privileges Read/Write    
Type int
Default Value 2147483647
Minimum value 0
Maximum value 2147483647

 

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value LOCAL
Legal Values

  • ON_DEMAND

  • ON_STARTUP

  • INCOMING_ONLY

  • LOCAL

 

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 BEA Tuxedo 7.1 or later software.

Note: ConnPrincipalName is not supported in this release.

   
Privileges Read/Write    
Type java.lang.String

 

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value LOCAL
Legal Values

  • GLOBAL

  • LOCAL

 

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.

   
Privileges Read/Write    
Type java.lang.String

 

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

   
Privileges Read/Write    
Type java.lang.String

 

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.

   
Privileges Read/Write    
Type int
Default Value -1

 

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.

   
Privileges Read/Write    
Type java.lang.String

 

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.

   
Privileges Read/Write    
Type java.lang.String

 

KeepAlive

Return value tells whether this local Tuxedo access point is configured with Application Level Keep Alive, and it maximum idle time value before wait timer start ticking.

   
Privileges Read/Write    
Type int
Default Value 0
Minimum value -1
Maximum value 2147483647

 

KeepAliveWait

Return value that tells whether this local Tuxedo access point requires the acknowledgement of Application Level Keep Alive, and how long it will wait without receiving acknowledgement before declare the connection is inaccessable.

   
Privileges Read/Write    
Type int
Default Value 0
Minimum value 0
Maximum value 2147483647

 

LocalAccessPoint

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

   
Privileges Read/Write    
Type java.lang.String
Default Value myLAP

 

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value 128
Legal Values

  • 0

  • 40

  • 56

  • 128

 

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: A value of -1 indicates that the Max Retries value from the local Tuxedo access point is used. Be sure to set the ConnectionPolicy value for the local Tuxedo access point to ON_STARTUP also.

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.

   
Privileges Read/Write    
Type long
Default Value -1
Minimum value -1
Maximum value 9223372036854775807

 

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

   
Privileges Read only    
Type javax.management.MBeanInfo
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

 

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value 0
Legal Values

  • 0

  • 40

  • 56

  • 128
Secure value 40

 

Name of

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 of=user-specified-name

   
Privileges Read/Write    
Type java.lang.String

 

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. 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.

   
Privileges Read/Write    
Type java.lang.String

 

NWAddr

The network address and port number of this remote Tuxedo access point. Specify the TCP/IP address in the format: //hostname:port_number or //#.#.#.#:port_number.

Note: 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 port number at which the access point listens for incoming requests.

   
Privileges Read/Write    
Type java.lang.String
Default Value //localhost:8902

 

ObjectName

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

Deprecated.

   
Privileges Read only    
Type weblogic.management.WebLogicObjectName
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

 

Parent

Return the immediate parent for this MBean

   
Privileges Read/Write    
Type

 

Registered

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

Deprecated.

   
Privileges Read only    
Type boolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

 

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: A value of -1 means that the RetryInterval value from the local Tuxedo access point is used. Be sure to set the ConnectionPolicy value for the local Tuxedo access point to ON_STARTUP also.

   
Privileges Read/Write    
Type long
Default Value -1
Minimum value -1
Maximum value 2147483647

 

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.

   
Privileges Read/Write    
Type java.lang.String

 

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value TUXEDO_GID

 

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.

   
Privileges Read/Write    
Type java.lang.String
Default Value TUXEDO_UID

 

Type

Returns the type of the MBean.

   
Privileges Read only    
Type java.lang.String
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Operations

This section describes the following operations:

 

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

Operation Name "freezeCurrentValue"    
Parameters Object [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

Signature String [] { "java.lang.String" }
Returns void
Exceptions

  • javax.management.AttributeNotFoundException

  • javax.management.MBeanException

 

isSet

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

Operation Name "isSet"    
Parameters Object [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to check

Signature String [] { "java.lang.String" }
Returns boolean

 

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

Operation Name "restoreDefaultValue"    
Parameters Object [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

Signature String [] { "java.lang.String" }
Returns void
Exceptions

  • javax.management.AttributeNotFoundException

 

unSet

Restore the given property to its default value.

Operation Name "unSet"    
Parameters Object [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to restore

Signature String [] { "java.lang.String" }
Returns void