Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06

weblogic.management.configuration
Interface WTCRemoteTuxDomMBean

All Superinterfaces:
ConfigurationMBean

public interface WTCRemoteTuxDomMBean
extends ConfigurationMBean

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.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

Since:
7.0.0.0
Access limited to the following security roles:
Deployer

Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 String getAccessPoint()
          The unique name used to identify this remote Tuxedo access point.
 String getAccessPointId()
          The connection principal name used to identify this remote Tuxedo access point when attempting to establish a session connection to local Tuxedo access points.
 String getAclPolicy()
          The inbound access control list (ACL) policy toward requests from a remote Tuxedo access point.
 boolean getAllowAnonymous()
          Specifies whether the anonymous user is allowed to access remote Tuxedo services.
 String getAppKey()
          Specifies the type of AppKey plug-in used.
 int getCmpLimit()
          The compression threshold this remote Tuxedo access point uses when sending data to a local Tuxedo access point.
 String getConnectionPolicy()
          The conditions under which this remote Tuxedo access point establishes a session connection with a local Tuxedo access point.
 String getConnPrincipalName()
          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.
 String getCredentialPolicy()
          The outbound access control list (ACL) policy toward requests to a remote Tuxedo access point.
 String getCustomAppKeyClass()
          The full pathname to the custom AppKey generator class.
 String getCustomAppKeyClassParam()
          The optional parameters to be used by the custom AppKey class at the class initialization time.
 int getDefaultAppKey()
          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.
 String getFederationName()
          The context at which this remote Tuxedo access point federates to a foreign name service.
 String getFederationURL()
          The URL for a foreign name service that is federated into JNDI.
 int getKeepAlive()
          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.
 int getKeepAliveWait()
          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 inaccessible.
 String getLocalAccessPoint()
          The local domain name from which this remote Tuxedo domain is reached.
 String getMaxEncryptBits()
          The maximum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection.
 long getMaxRetries()
          The maximum number of times that this remote Tuxedo access point tries to establish a session connections to local Tuxedo access points.
 String getMinEncryptBits()
          The minimum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection.
 String getNWAddr()
          The network address and port number of this remote Tuxedo access point.
 long getRetryInterval()
          The number of seconds that this remote Tuxedo access point waits between automatic connection attempts to local Tuxedo access points.
 String getTpUsrFile()
          The full path to the user password file containing UID/GID information.
 String getTuxedoGidKw()
          The keyword for Tuxedo GID (Group ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap.
 String getTuxedoUidKw()
          The keyword for Tuxedo UID (User ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap.
 void setAccessPoint(String AccessPoint)
          Sets the value of the AccessPoint attribute.
 void setAccessPointId(String AccessPointId)
          Sets the value of the AccessPointId attribute.
 void setAclPolicy(String AclPolicy)
          Sets the value of the AclPolicy attribute.
 void setAllowAnonymous(boolean AllowAnonymous)
          Sets the value of the AllowAnonymous attribute.
 void setAppKey(String AppKey)
          Sets the value of the AppKey attribute.
 void setCmpLimit(int CmpLimit)
          Sets the value of the CmpLimit attribute.
 void setConnectionPolicy(String ConnectionPolicy)
          Sets the value of the ConnectionPolicy attribute.
 void setConnPrincipalName(String ConnPrincipalName)
          Sets the value of the ConnPrincipalName attribute.
 void setCredentialPolicy(String CredentialPolicy)
          Sets the value of the CredentialPolicy attribute.
 void setCustomAppKeyClass(String AppKeyClass)
          Sets the value of the CustomAppKeyClass attribute.
 void setCustomAppKeyClassParam(String Param)
          Sets the value of the CustomAppKeyClassParam attribute.
 void setDefaultAppKey(int DfltAppKey)
          Sets the value of the DefaultAppKey attribute.
 void setFederationName(String FederationName)
          Sets the value of the FederationName attribute.
 void setFederationURL(String FederationURL)
          Sets the value of the FederationURL attribute.
 void setKeepAlive(int KeepAlive)
          Sets the value of the KeepAlive attribute.
 void setKeepAliveWait(int KeepAliveWait)
          Sets the value of the KeepAliveWait attribute.
 void setLocalAccessPoint(String LocalAccessPoint)
          Sets the value of the LocalAccessPoint attribute.
 void setMaxEncryptBits(String MaxEncryptBits)
          Sets the value of the MaxEncryptBits attribute.
 void setMaxRetries(long MaxRetries)
          Sets the value of the MaxRetries attribute.
 void setMinEncryptBits(String MinEncryptBits)
          Sets the value of the MinEncryptBits attribute.
 void setNWAddr(String ListenAddress)
          Sets the value of the NWAddr attribute.
 void setRetryInterval(long RetryInterval)
          Sets the value of the RetryInterval attribute.
 void setTpUsrFile(String TpUsrFile)
          Sets the value of the TpUsrFile attribute.
 void setTuxedoGidKw(String GidKw)
          Sets the value of the TuxedoGidKw attribute.
 void setTuxedoUidKw(String UidKw)
          Sets the value of the TuxedoUidKw attribute.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 

Method Detail

setAccessPoint

void setAccessPoint(String AccessPoint)
                    throws InvalidAttributeValueException

Sets the value of the AccessPoint attribute.

Parameters:
AccessPoint - the name for the remote domain access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getAccessPoint()
This method can NOT set a null value.
Default Value:
"myRAP"

getAccessPoint

String getAccessPoint()

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.

Returns:
The accessPoint value

setAccessPointId

void setAccessPointId(String AccessPointId)
                      throws InvalidAttributeValueException

Sets the value of the AccessPointId attribute.

Parameters:
AccessPointId - the local domain access point identifier
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getAccessPointId()
This method can NOT set a null value.
Default Value:
"myRAPId"

getAccessPointId

String getAccessPointId()

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

Returns:
The accessPointId value

setConnectionPolicy

void setConnectionPolicy(String ConnectionPolicy)
                         throws InvalidAttributeValueException

Sets the value of the ConnectionPolicy attribute.

Parameters:
ConnectionPolicy - the connection policy for this remote Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getConnectionPolicy()
Default Value:
"LOCAL"
Valid Values:
"ON_DEMAND","ON_STARTUP","INCOMING_ONLY","LOCAL"

getConnectionPolicy

String getConnectionPolicy()

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

The allowed values are:

Returns:
The connectionPolicy value

setAclPolicy

void setAclPolicy(String AclPolicy)
                  throws InvalidAttributeValueException

Sets the value of the AclPolicy attribute.

Parameters:
AclPolicy - the AclPolicy for this remote Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getAclPolicy()
Default Value:
"LOCAL"
Valid Values:
"GLOBAL","LOCAL"

getAclPolicy

String getAclPolicy()

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.

Returns:
The aclPolicy value

setCredentialPolicy

void setCredentialPolicy(String CredentialPolicy)
                         throws InvalidAttributeValueException

Sets the value of the CredentialPolicy attribute.

Parameters:
CredentialPolicy - the CredentialPolicy for this remote Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getCredentialPolicy()
Default Value:
"LOCAL"
Valid Values:
"GLOBAL","LOCAL"

getCredentialPolicy

String getCredentialPolicy()

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

The allowed values are:

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

Returns:
The credentialPolicy value

setTpUsrFile

void setTpUsrFile(String TpUsrFile)
                  throws InvalidAttributeValueException

Sets the value of the TpUsrFile attribute.

Parameters:
TpUsrFile - the TpUsrFile URL for this remote Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getTpUsrFile()

getTpUsrFile

String getTpUsrFile()

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.

Returns:
The tpUsrFile value

setLocalAccessPoint

void setLocalAccessPoint(String LocalAccessPoint)
                         throws InvalidAttributeValueException

Sets the value of the LocalAccessPoint attribute.

Parameters:
LocalAccessPoint - the name for the local Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getLocalAccessPoint()
This method can NOT set a null value.
Default Value:
"myLAP"

getLocalAccessPoint

String getLocalAccessPoint()

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

Returns:
The localAccessPoint value

setConnPrincipalName

void setConnPrincipalName(String ConnPrincipalName)
                          throws InvalidAttributeValueException

Sets the value of the ConnPrincipalName attribute.

Parameters:
ConnPrincipalName - The new connPrincipalName value
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getConnPrincipalName()

getConnPrincipalName

String getConnPrincipalName()

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.

Returns:
The connPrincipalName value

setRetryInterval

void setRetryInterval(long RetryInterval)
                      throws InvalidAttributeValueException

Sets the value of the RetryInterval attribute.

Parameters:
RetryInterval - the retry interval for this remote Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getRetryInterval()
Default Value:
-1
Maximum Value:
java.lang.Integer.MAX_VALUE
Minimum Value:
-1

getRetryInterval

long getRetryInterval()

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.

Returns:
The retryInterval value

setMaxRetries

void setMaxRetries(long MaxRetries)
                   throws InvalidAttributeValueException

Sets the value of the MaxRetries attribute.

Parameters:
MaxRetries - the number of times to attempt connection to local Tuxedo access points
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getMaxRetries()
Default Value:
-1
Maximum Value:
java.lang.Long.MAX_VALUE
Minimum Value:
-1

getMaxRetries

long getMaxRetries()

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.

Returns:
The maxRetries value

setNWAddr

void setNWAddr(String ListenAddress)
               throws InvalidAttributeValueException

Sets the value of the NWAddr attribute.

Parameters:
ListenAddress - The new nWAddr value
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getNWAddr()
Default Value:
"//localhost:8902"

getNWAddr

String getNWAddr()

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

Specify the address in one of the following formats: Notes:

Returns:
The nWAddr value

setFederationURL

void setFederationURL(String FederationURL)
                      throws InvalidAttributeValueException

Sets the value of the FederationURL attribute.

Parameters:
FederationURL - url for a foreign name service federated into JNDI
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getFederationURL()

getFederationURL

String getFederationURL()

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:

Returns:
The federationURL value

setFederationName

void setFederationName(String FederationName)
                       throws InvalidAttributeValueException

Sets the value of the FederationName attribute.

Parameters:
FederationName - context at which to federate to foreign name service
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getFederationName()

getFederationName

String getFederationName()

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

Returns:
The federationName value

setCmpLimit

void setCmpLimit(int CmpLimit)
                 throws InvalidAttributeValueException

Sets the value of the CmpLimit attribute.

Parameters:
CmpLimit - The compression threshold for this remote Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getCmpLimit()
Default Value:
java.lang.Integer.MAX_VALUE
Maximum Value:
java.lang.Integer.MAX_VALUE
Minimum Value:
0

getCmpLimit

int getCmpLimit()

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.

Returns:
The cmpLimit value

setMinEncryptBits

void setMinEncryptBits(String MinEncryptBits)
                       throws InvalidAttributeValueException

Sets the value of the MinEncryptBits attribute.

Parameters:
MinEncryptBits - The minimum encryption level desired for this remote Tuxedo access point
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getMinEncryptBits()
Default Value:
"0"
Valid Values:
"0","40","56","128"

getMinEncryptBits

String getMinEncryptBits()

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:

Returns:
The minEncryptBits value

setMaxEncryptBits

void setMaxEncryptBits(String MaxEncryptBits)
                       throws InvalidAttributeValueException

Sets the value of the MaxEncryptBits attribute.

Parameters:
MaxEncryptBits - The maximum encryption level desired for this remote Tuxedo domain
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getMaxEncryptBits()
Default Value:
"128"
Valid Values:
"0","40","56","128"

getMaxEncryptBits

String getMaxEncryptBits()

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:

Returns:
The maxEncryptBits value

setAppKey

void setAppKey(String AppKey)
               throws InvalidAttributeValueException

Sets the value of the AppKey attribute.

Parameters:
AppKey - The type of appkey generator plug-in selected.
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getAppKey()
Default Value:
"TpUsrFile"
Valid Values:
"TpUsrFile","LDAP","Custom"

getAppKey

String getAppKey()

Specifies the type of AppKey plug-in used.

The allowed values are:

Returns:
The appKey value

setAllowAnonymous

void setAllowAnonymous(boolean AllowAnonymous)
                       throws InvalidAttributeValueException

Sets the value of the AllowAnonymous attribute.

Parameters:
AllowAnonymous - Specify if anonymous user is allowed to access Tuxedo
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getAllowAnonymous()
Default Value:
false

getAllowAnonymous

boolean getAllowAnonymous()

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.

Returns:
The allowAnonymous value

setDefaultAppKey

void setDefaultAppKey(int DfltAppKey)
                      throws InvalidAttributeValueException

Sets the value of the DefaultAppKey attribute.

Parameters:
DfltAppKey - The default AppKey value
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getDefaultAppKey()
Default Value:
-1

getDefaultAppKey

int getDefaultAppKey()

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.

Returns:
The defaultAppKey value

setTuxedoUidKw

void setTuxedoUidKw(String UidKw)
                    throws InvalidAttributeValueException

Sets the value of the TuxedoUidKw attribute.

Parameters:
UidKw - The Tuxedo user id keyword
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getTuxedoUidKw()
Default Value:
"TUXEDO_UID"

getTuxedoUidKw

String getTuxedoUidKw()

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.

Returns:
The tuxedoUidKw value

setTuxedoGidKw

void setTuxedoGidKw(String GidKw)
                    throws InvalidAttributeValueException

Sets the value of the TuxedoGidKw attribute.

Parameters:
GidKw - The Tuxedo group id keyword
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getTuxedoGidKw()
Default Value:
"TUXEDO_GID"

getTuxedoGidKw

String getTuxedoGidKw()

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.

Returns:
The tuxedoGidKw value

setCustomAppKeyClass

void setCustomAppKeyClass(String AppKeyClass)
                          throws InvalidAttributeValueException

Sets the value of the CustomAppKeyClass attribute.

Parameters:
AppKeyClass - The custom AppKey class full pathname
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getCustomAppKeyClass()

getCustomAppKeyClass

String getCustomAppKeyClass()

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.

Returns:
The customAppKeyClass value

setCustomAppKeyClassParam

void setCustomAppKeyClassParam(String Param)
                               throws InvalidAttributeValueException

Sets the value of the CustomAppKeyClassParam attribute.

Parameters:
Param - Optional parameter for information to be used by Custom class
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getCustomAppKeyClassParam()

getCustomAppKeyClassParam

String getCustomAppKeyClassParam()

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

Returns:
The customAppKeyClassParam value

setKeepAlive

void setKeepAlive(int KeepAlive)
                  throws InvalidAttributeValueException

Sets the value of the KeepAlive attribute. The value of 0 means no Application Level KeepAlive. Any other values in the valid value range means the maximum inactive time before start counting the the wait timer. The value is measured in millisecond and rounded up to second.

Parameters:
Keepalive - The Application Level KeepAlive value.
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getKeepAlive()
Default Value:
0
Maximum Value:
java.lang.Integer.MAX_VALUE
Minimum Value:
-1

getKeepAlive

int getKeepAlive()

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.

Returns:
keepAlive value

setKeepAliveWait

void setKeepAliveWait(int KeepAliveWait)
                      throws InvalidAttributeValueException

Sets the value of the KeepAliveWait attribute. The value of 0 means don't initiate Application Level KeepAlive, but do acknowledge if receive one. Any other values in the valid value range means the maximum time allowed without receiving acknowledgement before WTC declares the connection is inaccessible. The value is measured in millisecond and rounded up to second.

Parameters:
KeepaliveWait - The Application Level KeepAliveWait value.
Throws:
InvalidAttributeValueException
See Also:
WTCRemoteTuxDomMBean.getKeepAliveWait()
Default Value:
0
Maximum Value:
java.lang.Integer.MAX_VALUE
Minimum Value:
0

getKeepAliveWait

int getKeepAliveWait()

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

Returns:
keepAlive value

Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06