WebLogic Server 8.1 API Reference

weblogic.management.configuration
Interface WTCRemoteTuxDomMBean

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.

Author:

Copyright © 2002 BEA Systems, Inc. All Rights Reserved.

Fields inherited from class weblogic.management.configuration.ConfigurationMBean

CACHING_STUB_SVUID

Method Summary

java.lang.String	getAccessPoint() Gets the accessPoint attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getAccessPointId() Gets the accessPointId attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getAclPolicy() Gets the aclPolicy attribute of the WTCRemoteTuxDomMBean object
boolean	getAllowAnonymous() Gets the allowAnonymous attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getAppKey() Gets the appKey attribute of the WTCRemoteTuxDomMBean object
int	getCmpLimit() Gets the cmpLimit attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getConnectionPolicy() Gets the connectionPolicy attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getConnPrincipalName() Gets the connPrincipalName attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getCredentialPolicy() Gets the credentialPolicy attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getCustomAppKeyClass() Gets the customAppKeyClass attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getCustomAppKeyClassParam() Gets the customAppKeyClassParam attribute of the WTCRemoteTuxDomMBean object
int	getDefaultAppKey() Gets the defaultAppKey attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getFederationName() Gets the federationName attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getFederationURL() Gets the federationURL attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getLocalAccessPoint() Gets the localAccessPoint attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getMaxEncryptBits() Gets the maxEncryptBits attribute of the WTCRemoteTuxDomMBean object
long	getMaxRetries() Gets the maxRetries attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getMinEncryptBits() Gets the minEncryptBits attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getNWAddr() Gets the nWAddr attribute of the WTCRemoteTuxDomMBean object
long	getRetryInterval() Gets the retryInterval attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getTpUsrFile() Gets the tpUsrFile attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getTuxedoGidKw() Gets the tuxedoGidKw attribute of the WTCRemoteTuxDomMBean object
java.lang.String	getTuxedoUidKw() Gets the tuxedoUidKw attribute of the WTCRemoteTuxDomMBean object
void	setAccessPoint(java.lang.String AccessPoint) Defines a name used to identify a domain in a WTCServer MBean.
void	setAccessPointId(java.lang.String AccessPointId) Defines the connection principal name used to identify a domain when establishing a connection to another domain.
void	setAclPolicy(java.lang.String AclPolicy) Defines the inbound access control list (ACL) policy toward requests from a remote domain.
void	setAllowAnonymous(boolean AllowAnonymous) Decides whether the anonymous user is allowed to access Tuxedo.
void	setAppKey(java.lang.String AppKey) Defines the AppKey generator selection.
void	setCmpLimit(int CmpLimit) Defines the compression threshold used when sending data to a remote domain.
void	setConnectionPolicy(java.lang.String ConnectionPolicy) Defines the conditions under which a local domain tries to establish a connection to a remote domain.
void	setConnPrincipalName(java.lang.String ConnPrincipalName) Defines the principal name used to verify the identity of this domain when establishing a connection to another domain.
void	setCredentialPolicy(java.lang.String CredentialPolicy) Defines the outbound access control list (ACL) policy toward requests to a remote domain.
void	setCustomAppKeyClass(java.lang.String AppKeyClass) Defines the full pathname to the custom AppKey generator class.
void	setCustomAppKeyClassParam(java.lang.String Param) Defines the optional parameters to be used by the custom AppKey class at the class initialization time.
void	setDefaultAppKey(int DfltAppKey) Defines the default AppKey value to be used by anonymous user and other users who are not defined in the user database if the plug-in allows them to access Tuxedo.
void	setFederationName(java.lang.String FederationName) Defines the context at which to federate to a foreign name service.
void	setFederationURL(java.lang.String FederationURL) Defines the URL for a foreign name service that is federated into JNDI.
void	setLocalAccessPoint(java.lang.String LocalAccessPoint) Defines the local domain name from which a remote domain is reached.
void	setMaxEncryptBits(java.lang.String MaxEncryptBits) Defines the maximum encryption key length (in bits) used when establishing a network connection for a local domain.
void	setMaxRetries(long MaxRetries) Defines the number of times that a domain gateway tries to establish connections to remote domain access points.
void	setMinEncryptBits(java.lang.String MinEncryptBits) Defines the minimum encryption key length (in bits) used when establishing a network connection for a local domain.
void	setNWAddr(java.lang.String ListenAddress) Defines the network address of the local domain gateway.
void	setRetryInterval(long RetryInterval) Defines the number of seconds between automatic attempts to establish a connection to remote domain access points.
void	setTpUsrFile(java.lang.String TpUsrFile) Defines the full path to user password file containing uid/gid information.
void	setTuxedoGidKw(java.lang.String GidKw) Defines the keyword for Tuxedo GID (group id) used in the WlsUser when using the Tuxedo migration utility tpmigldap.
void	setTuxedoUidKw(java.lang.String UidKw) Defines the keyword for Tuxedo UID (user id) used in the WlsUser when using the Tuxedo migration utility tpmigldap.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getNotes, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

setAccessPoint

public void setAccessPoint(java.lang.String AccessPoint)
                    throws javax.management.InvalidAttributeValueException

Defines a name used to identify a domain in a WTCServer MBean. This name must be unique within the scope of WTCLocalTuxDom and WTCRemoteTuxDom AccessPoint names in a WTCServer MBean.

Legal NULL: false

Parameters:

AccessPoint - the name for the remote domain access point

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getAccessPoint

public java.lang.String getAccessPoint()

Gets the accessPoint attribute of the WTCRemoteTuxDomMBean object

Returns:

The accessPoint value

setAccessPointId

public void setAccessPointId(java.lang.String AccessPointId)
                      throws javax.management.InvalidAttributeValueException

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

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

Legal NULL: false

Parameters:

AccessPointId - the local domain access point identifier

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getAccessPointId

public java.lang.String getAccessPointId()

Gets the accessPointId attribute of the WTCRemoteTuxDomMBean object

Returns:

The accessPointId value

setConnectionPolicy

public void setConnectionPolicy(java.lang.String ConnectionPolicy)
                         throws javax.management.InvalidAttributeValueException

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

• 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 attributes 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.

Default Value: "ON_DEMAND"

Legal Values: "ON_DEMAND","ON_STARTUP","INCOMING_ONLY","LOCAL"

Parameters:

ConnectionPolicy - the connection policy for this remote domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getConnectionPolicy

public java.lang.String getConnectionPolicy()

Gets the connectionPolicy attribute of the WTCRemoteTuxDomMBean object

Returns:

The connectionPolicy value

setAclPolicy

public void setAclPolicy(java.lang.String AclPolicy)
                  throws javax.management.InvalidAttributeValueException

Defines the inbound access control list (ACL) policy toward requests from a remote domain.

• If Interoperate is set to Yes, AclPolicy is ignored.
• LOCAL: The local domain modifies the identity of 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"

Legal Values: "GLOBAL","LOCAL"

Parameters:

AclPolicy - the AclPolicy for this remote domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getAclPolicy

public java.lang.String getAclPolicy()

Gets the aclPolicy attribute of the WTCRemoteTuxDomMBean object

Returns:

The aclPolicy value

setCredentialPolicy

public void setCredentialPolicy(java.lang.String CredentialPolicy)
                         throws javax.management.InvalidAttributeValueException

Defines the outbound access control list (ACL) policy toward requests to a remote domain.

• If Interoperate is set to Yes, CredentialPolicy is ignored.
• 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"

Legal Values: "GLOBAL","LOCAL"

Parameters:

CredentialPolicy - the CredentialPolicy for this remote domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getCredentialPolicy

public java.lang.String getCredentialPolicy()

Gets the credentialPolicy attribute of the WTCRemoteTuxDomMBean object

Returns:

The credentialPolicy value

setTpUsrFile

public void setTpUsrFile(java.lang.String TpUsrFile)
                  throws javax.management.InvalidAttributeValueException

Defines the full path to user password file containing uid/gid information. This file is the same one 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.

Parameters:

TpUsrFile - the TpUsrFile for this remote domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getTpUsrFile

public java.lang.String getTpUsrFile()

Gets the tpUsrFile attribute of the WTCRemoteTuxDomMBean object

Returns:

The tpUsrFile value

setLocalAccessPoint

public void setLocalAccessPoint(java.lang.String LocalAccessPoint)
                         throws javax.management.InvalidAttributeValueException

Defines the local domain name from which a remote domain is reached.

Legal NULL: false

Parameters:

LocalAccessPoint - the name for the local domain access point

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getLocalAccessPoint

public java.lang.String getLocalAccessPoint()

Gets the localAccessPoint attribute of the WTCRemoteTuxDomMBean object

Returns:

The localAccessPoint value

setConnPrincipalName

public void setConnPrincipalName(java.lang.String ConnPrincipalName)
                          throws javax.management.InvalidAttributeValueException

Defines the principal name used to verify the identity of this 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 not specified, the connection pricipal name defaults to the AccessPointID for this domain.

Note: ConnectionPrincipalName is not supported in this release.

Parameters:

ConnPrincipalName - The new connPrincipalName value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getConnPrincipalName

public java.lang.String getConnPrincipalName()

Gets the connPrincipalName attribute of the WTCRemoteTuxDomMBean object

Returns:

The connPrincipalName value

setRetryInterval

public void setRetryInterval(long RetryInterval)
                      throws javax.management.InvalidAttributeValueException

Defines the number of seconds between automatic attempts to establish a connection to remote domain access points.

• Use only when Connection Policy is set to ON_STARTUP.
• Use -1 to default to the value defined by the WTCLocalTuxDomMBean RetryInterval attribute.

Default Value: -1

Legal Minimum Value: -1

Legal Maximum Value: java.lang.Integer.MAX_VALUE

Parameters:

RetryInterval - the retry interval for this local domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getRetryInterval

public long getRetryInterval()

Gets the retryInterval attribute of the WTCRemoteTuxDomMBean object

Returns:

The retryInterval value

setMaxRetries

public void setMaxRetries(long MaxRetries)
                   throws javax.management.InvalidAttributeValueException

Defines the number of times that a domain gateway tries to establish connections to remote domain access points. Use only when Connection Policy is set to ON_STARTUP.

• Use -1 to default to the value defined by the WTCLocalTuxDomMBean MaxRetries attribute.
• Use 0 to disable the retry mechanism.
• Use the maximum value to try until a connection is established.

Default Value: -1

Legal Minimum Value: -1

Legal Maximum Value: java.lang.Long.MAX_VALUE

Parameters:

MaxRetries - the number of times to attempt connection to local domains

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getMaxRetries

public long getMaxRetries()

Gets the maxRetries attribute of the WTCRemoteTuxDomMBean object

Returns:

The maxRetries value

setNWAddr

public void setNWAddr(java.lang.String ListenAddress)
               throws javax.management.InvalidAttributeValueException

Defines 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 the 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.

Legal NULL: false

Parameters:

ListenAddress - The new nWAddr value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getNWAddr

public java.lang.String getNWAddr()

Gets the nWAddr attribute of the WTCRemoteTuxDomMBean object

Returns:

The nWAddr value

setFederationURL

public void setFederationURL(java.lang.String FederationURL)
                      throws javax.management.InvalidAttributeValueException

Defines the URL for a foreign name service that is federated into JNDI. If omitted:

• WebLogic Tuxedo Connector assumes there is a CosNaming server in the foreign domain.
• WebLogic Tuxedo Connector federates to the CosNaming server using TGIOP.

WebLogic Tuxedo Connector can to federate to non-CORBA service providers.

Parameters:

FederationURL - url for a foreign name service federated into JNDI

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getFederationURL

public java.lang.String getFederationURL()

Gets the federationURL attribute of the WTCRemoteTuxDomMBean object

Returns:

The federationURL value

setFederationName

public void setFederationName(java.lang.String FederationName)
                       throws javax.management.InvalidAttributeValueException

Defines the context at which to federate to a foreign name service. If omitted then the federation point is tuxedo.domains.

Parameters:

FederationName - context at which to federate to foreign name service

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getFederationName

public java.lang.String getFederationName()

Gets the federationName attribute of the WTCRemoteTuxDomMBean object

Returns:

The federationName value

setCmpLimit

public void setCmpLimit(int CmpLimit)
                 throws javax.management.InvalidAttributeValueException

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

Default Value: java.lang.Integer.MAX_VALUE

Legal Minimum Value: 0

Legal Maximum Value: java.lang.Integer.MAX_VALUE

Parameters:

CmpLimit - The compression threshold for this remote domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getCmpLimit

public int getCmpLimit()

Gets the cmpLimit attribute of the WTCRemoteTuxDomMBean object

Returns:

The cmpLimit value

setMinEncryptBits

public void setMinEncryptBits(java.lang.String MinEncryptBits)
                       throws javax.management.InvalidAttributeValueException

Defines the minimum encryption key length (in bits) used when establishing a network connection for a local domain.

• A value of 0 indicates no encryption is used.
• The value of the MinEncrypBits attribute must be less than or equal to the value of the MaxEncrypBits attribute.
• A MinEncrypBits of 40 can be used only with domains running Tuxedo 7.1 or higher.

Default Value: "0"

Legal Value: WTCLegalHelper.isMinLteMax(self,value)

Legal Values: "0","40","56","128"

Parameters:

MinEncryptBits - The minimum encryption level desired for this remote domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getMinEncryptBits

public java.lang.String getMinEncryptBits()

Gets the minEncryptBits attribute of the WTCRemoteTuxDomMBean object

Returns:

The minEncryptBits value

setMaxEncryptBits

public void setMaxEncryptBits(java.lang.String MaxEncryptBits)
                       throws javax.management.InvalidAttributeValueException

Defines the maximum encryption key length (in bits) used when establishing a network connection for a local domain.

• A value of 0 indicates no encryption is used.
• 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.

Default Value: "128"

Legal Value: WTCLegalHelper.isMaxGteMin(self,value)

Legal Values: "0","40","56","128"

Parameters:

MaxEncryptBits - The encryption level desired for this remote domain

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getMaxEncryptBits

public java.lang.String getMaxEncryptBits()

Gets the maxEncryptBits attribute of the WTCRemoteTuxDomMBean object

Returns:

The maxEncryptBits value

setAppKey

public void setAppKey(java.lang.String AppKey)
               throws javax.management.InvalidAttributeValueException

Defines the AppKey generator selection. There are three choices.

• TpUsrFile.
• LDAP.
• Custom.

The TpUsrFile is default, it is based on the imported Tuxedo TPUSR file as the source of the user security information. In WLS 7.0 and before the WTC only support this option. The LDAP utilize the embedded LDAP server as source of user security information. The user record must define the Tuxedo UID and GID information in the description field. The last choice Custome user must write their own AppKey generator class that can get the user security information to be passed to Tuxedo.

Default Value: "TpUsrFile"

Legal Values: "TpUsrFile","LDAP","Custom"

Parameters:

AppKey - The type of appkey generator plug-in selected.

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getAppKey

public java.lang.String getAppKey()

Gets the appKey attribute of the WTCRemoteTuxDomMBean object

Returns:

The appKey value

setAllowAnonymous

public void setAllowAnonymous(boolean AllowAnonymous)
                       throws javax.management.InvalidAttributeValueException

Decides whether the anonymous user is allowed to access Tuxedo. If anonymous is allowed to access Tuxedo the the default AppKey will be used for TpUsrFile, and LDAP AppKey generators selection. As for Custom AppKey generator then it depends on the design of the Custom AppKey generator.

Default Value: false

Parameters:

AllowAnonymous - allowed anonymous user to access Tuxedo or not.

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getAllowAnonymous

public boolean getAllowAnonymous()

Gets the allowAnonymous attribute of the WTCRemoteTuxDomMBean object

Returns:

The allowAnonymous value

setDefaultAppKey

public void setDefaultAppKey(int DfltAppKey)
                      throws javax.management.InvalidAttributeValueException

Defines the default AppKey value to be used by anonymous user and other users who are not defined in the user database if the plug-in allows them to access Tuxedo. The standard plug-in TpUsrFile and LDAP does not allow user not defined in user database to access Tuxedo, the only exception is the anonymous user when Allow Anonymous is enabled.

Default Value: "-1"

Parameters:

DfltAppKey - The default AppKey value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getDefaultAppKey

public int getDefaultAppKey()

Gets the defaultAppKey attribute of the WTCRemoteTuxDomMBean object

Returns:

The defaultAppKey value

setTuxedoUidKw

public void setTuxedoUidKw(java.lang.String UidKw)
                    throws javax.management.InvalidAttributeValueException

Defines the keyword for Tuxedo UID (user id) used in the WlsUser when using the Tuxedo migration utility tpmigldap. The keyword is used to find Tuxedo UID in the user record in the embedded LDAP database.

Default Value: "TUXEDO_UID"

Parameters:

UidKw - The Tuxedo user id keyword

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getTuxedoUidKw

public java.lang.String getTuxedoUidKw()

Gets the tuxedoUidKw attribute of the WTCRemoteTuxDomMBean object

Returns:

The tuxedoUidKw value

setTuxedoGidKw

public void setTuxedoGidKw(java.lang.String GidKw)
                    throws javax.management.InvalidAttributeValueException

Defines the keyword for Tuxedo GID (group id) used in the WlsUser when using the Tuxedo migration utility tpmigldap. The keyword is used to find Tuxedo GID in the user record in the embedded LDAP database.

Default Value: "TUXEDO_GID"

Parameters:

GidKw - The Tuxedo group id keyword

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getTuxedoGidKw

public java.lang.String getTuxedoGidKw()

Gets the tuxedoGidKw attribute of the WTCRemoteTuxDomMBean object

Returns:

The tuxedoGidKw value

setCustomAppKeyClass

public void setCustomAppKeyClass(java.lang.String AppKeyClass)
                          throws javax.management.InvalidAttributeValueException

Defines the full pathname to the custom AppKey generator class. The class pointed by this full pathname will be loaded at runtime if the Custom AppKey generator plug-in is selected.

Parameters:

AppKeyClass - The custome AppKey class full pathname

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getCustomAppKeyClass

public java.lang.String getCustomAppKeyClass()

Gets the customAppKeyClass attribute of the WTCRemoteTuxDomMBean object

Returns:

The customAppKeyClass value

setCustomAppKeyClassParam

public void setCustomAppKeyClassParam(java.lang.String Param)
                               throws javax.management.InvalidAttributeValueException

Defines the optional parameters to be used by the custom AppKey class at the class initialization time.

Parameters:

Param - Optional parameter for information to be used by custom class

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getCustomAppKeyClassParam

public java.lang.String getCustomAppKeyClassParam()

Gets the customAppKeyClassParam attribute of the WTCRemoteTuxDomMBean object

Returns:

The customAppKeyClassParam value