weblogic.management.configuration
Interface WTCLocalTuxDomMBean

All Superinterfaces:

ConfigurationMBean

public interface WTCLocalTuxDomMBean
extends ConfigurationMBean

This interface provides access to the WTC local 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.

Since:

7.0.0.0

Access limited to the following security roles:

Deployer

setAccessPoint

void setAccessPoint(String AccessPoint)
                    throws InvalidAttributeValueException

Sets the value of the AccessPoint attribute.

Parameters:

AccessPoint - the name for the local Tuxedo access point

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getAccessPoint()

This method can NOT set a null value.

Default Value:

"myLAP"

getAccessPoint

String getAccessPoint()

The unique name used to identify this local 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 Tuxedo access point identifier

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getAccessPointId()

This method can NOT set a null value.

Default Value:

"myLAPId"

getAccessPointId

String getAccessPointId()

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

Note: The AccessPointId must match the corresponding DOMAINID in the *DM_REMOTE_DOMAINS section of your Tuxedo DMCONFIG file.

Returns:

The accessPointId value

setSecurity

void setSecurity(String Security)
                 throws InvalidAttributeValueException

Sets the value of the Security attribute.

Parameters:

Security - the security level to be enforced

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getSecurity()

Default Value:

"NONE"

Valid Values:

"NONE","APP_PW","DM_PW"

getSecurity

String getSecurity()

The type of application security enforced.

The types of security are:

• NONE: No security is used.
• APP_PW: Password security is enforced when a connection is established from a remote domain. The application password is defined in the WTCResourcesMBean.
• DM_PW: Domain password security is enforced when a connection is established from a remote domain. The domain password is defined in the WTCPasswordsMBean.

Returns:

The security value

setConnectionPolicy

void setConnectionPolicy(String ConnectionPolicy)
                         throws InvalidAttributeValueException

Sets the value of the ConnectionPolicy attribute.

Parameters:

ConnectionPolicy - the connection policy for this local Tuxedo access point

Throws:

InvalidAttributeValueException

See Also:

#getConectionPolicy

Default Value:

"ON_DEMAND"

Valid Values:

"ON_DEMAND","ON_STARTUP","INCOMING_ONLY"

getConnectionPolicy

String getConnectionPolicy()

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

The connection policies 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 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 values 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.

Returns:

The connectionPolicy 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:

WTCLocalTuxDomMBean.getConnPrincipalName()

getConnPrincipalName

String getConnPrincipalName()

The principal name used to verify the identity of this domain when establishing a connection to another domain.

Note: This parameter only applies to domains of type TDOMAIN that are running BEA Tuxedo 7.1 or later software. If not specified, the connection principal name defaults to the AccessPointID for this domain.ConnPrincipalName.

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 local Tuxedo access point

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getRetryInterval()

Default Value:

60

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getRetryInterval

long getRetryInterval()

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

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

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 remote Tuxedo access points

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getMaxRetries()

Default Value:

java.lang.Long.MAX_VALUE

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

0

getMaxRetries

long getMaxRetries()

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

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

Note: Use the minimum value to disable the retry mechanism. Use the maximum value to try until a connection is established.

Returns:

The maxRetries value

setBlockTime

void setBlockTime(long BlockTime)
                  throws InvalidAttributeValueException

Sets the value of the BlockTime attribute.

Parameters:

BlockTime - the maximum wait time allowed for a blocking call

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getBlockTime()

Default Value:

60

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getBlockTime

long getBlockTime()

The maximum number of seconds this local Tuxedo access point allows for a blocking call.

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

Returns:

The blockTime 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:

WTCLocalTuxDomMBean.getNWAddr()

Default Value:

"//localhost:8901"

getNWAddr

String getNWAddr()

The network address and port number of this local 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.

Returns:

The nWAddr value

setCmpLimit

void setCmpLimit(int CmpLimit)
                 throws InvalidAttributeValueException

Sets the value of the CmpLimit attribute.

Parameters:

CmpLimit - The compression threshold for this local Tuxedo access point

Throws:

InvalidAttributeValueException

See Also:

#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 local Tuxedo access point uses when sending data to a remote 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 local Tuxedo access point

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getMinEncryptBits()

Default Value:

"0"

Valid Values:

"0","40","56","128","256"

getMinEncryptBits

String getMinEncryptBits()

The minimum encryption key length (in bits) this local 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.

Returns:

The minEncryptBits value

setMaxEncryptBits

void setMaxEncryptBits(String MaxEncryptBits)
                       throws InvalidAttributeValueException

Sets the value of the MaxEncryptBits attribute.

Parameters:

MaxEncryptBits - The encryption level desired for this local Tuxedo access point

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getMaxEncryptBits()

Default Value:

"128"

Valid Values:

"0","40","56","128","256"

getMaxEncryptBits

String getMaxEncryptBits()

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

Value Restrictions:

• The MaxEncryptBits value must be greater than or equal to the MinEncrypBits value.
• A MaxEncryptBits of 40 can be used only with domains running Tuxedo 7.1 or higher.

Returns:

The maxEncryptBits value

setInteroperate

void setInteroperate(String Interoperate)
                     throws InvalidAttributeValueException

Sets the value of the Interoperate attribute.

Parameters:

Interoperate - The interoperatibility desired for this local Tuxedo access point

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getInteroperate()

Default Value:

"No"

Valid Values:

"Yes", "No"

getInteroperate

String getInteroperate()

Specifies whether this local Tuxedo access point interoperates with remote Tuxedo access points that are based upon Tuxedo release 6.5. If this value is set to Yes, the local Tuxedo access point interoperates with a Tuxedo 6.5 domain.

Returns:

The interoperate 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:

WTCLocalTuxDomMBean.getKeepAlive()

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

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 inaccessable. The value is measured in millisecond and rounded up to second.

Parameters:

KeepaliveWait - The Application Level KeepAliveWait value.

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.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 inaccessable.

Returns:

keepAlive value

getUseSSL

String getUseSSL()

Return value that tells whether connection initiated or accepted by this Local Tuxedo access point uses SSL on top of its transport layer. Values are:

• Off: SSL not used.
• TwoWay: Mutual Authentication with SSL required.
• OneWay: Server Authentication with SSL required.

Returns:

the useSSL value for this Local Tuxedo access point.

Default Value:

"Off"

Valid Values:

"Off", "TwoWay", "OneWay"

setUseSSL

void setUseSSL(String useSSL)
               throws InvalidAttributeValueException

Parameters:

useSSL - The new useSSL value for this Local Tuxedo access point

Throws:

InvalidAttributeValueException

getKeyStoresLocation

String getKeyStoresLocation()

Provides the configuration rule to be used for finding Local Access Point's identity key store and trust key store. In plain text, it contains information on where the identity key store and trust key store are configured. When KeyStoreLocation is configured with WLS Store, WTC uses configuration information from the WLS Key Stores configuration. Otherwise, it uses the key stores information configured in the Local Access Point.

Returns:

The keyStores value

Changes take effect after you redeploy the module or restart the server.

Default Value:

"Custom Stores"

Valid Values:

"WLS Stores", "Custom Stores"

setKeyStoresLocation

void setKeyStoresLocation(String location)
                          throws InvalidAttributeValueException

Sets the value of the KeyStoresLocation attribute.

Parameters:

location - The new keyStoresLocation value

Throws:

InvalidAttributeValueException

See Also:

#getKeyStoreLocation()

getIdentityKeyStoreFileName

String getIdentityKeyStoreFileName()

The path and file name of the identity keystore.

The path name must either be absolute or relative to where the server was booted. The identity key store file name is only used if KeystoreLocation is "Custom Stores".

Returns:

The identityKeystoreFileName value

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setIdentityKeyStoreFileName

void setIdentityKeyStoreFileName(String keystore)
                                 throws InvalidAttributeValueException

Sets the value of the identityKeyStoreFileName attribute.

Parameters:

fileName - The new identityKeyStoreFileName value

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getIdentityKeyStoreFileName()

getIdentityKeyStorePassPhrase

String getIdentityKeyStorePassPhrase()

The custom identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.

This attribute is only used if KeyStores is "Custom Stores".

When you get the value of this attribute, WebLogic Server does the following:

1. Retrieves the value of the IdentityKeyStorePassPhraseEncrypted attribute.
2. Decrypts the value and returns the unencrypted password as a String.

When you set the value of this attribute, WebLogic Server does the following:

1. Encrypts the value.
2. Sets the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute to the encrypted value.

Using this attribute (CustomIdentityKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

Instead of using this attribute, use CustomIdentityKeyStorePassPhraseEncrypted.

Returns:

The customIdentityKeyStorePassPhrase value

See Also:

#getCustomIdentityKeyStorePassPhraseEncrypted()

setIdentityKeyStorePassPhrase

void setIdentityKeyStorePassPhrase(String passPhrase)
                                   throws InvalidAttributeValueException

Sets the value of the CustomIdentityKeyStorePassPhrase attribute.

Parameters:

passPhrase - The new customIdentityKeyStorePassPhrase value

Throws:

InvalidAttributeValueException

See Also:

#getCustomIdentityKeyStorePassPhrase(), #setCustomIdentityKeyStorePassPhraseEncrypted(byte[])

getIdentityKeyStorePassPhraseEncrypted

byte[] getIdentityKeyStorePassPhraseEncrypted()

The identity keystore's encrypted passphrase. If empty or null, then the keystore will be opened without a passphrase.

This attribute is only used if KeyStores is "Custom Stores".

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, use the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

The encrypted identityKeyStorePassPhrase value

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setIdentityKeyStorePassPhraseEncrypted

void setIdentityKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)

Sets the encrypted value of the IdentityKeyStorePassPhrase attribute.

Parameters:

passPhraseEncrypted - The new encrypted identityKeyStorePassPhrase value

See Also:

WTCLocalTuxDomMBean.getIdentityKeyStorePassPhraseEncrypted()

getPrivateKeyAlias

String getPrivateKeyAlias()

The string alias used to store and retrieve the Local Tuxedo access point's private key in the keystore. This private key is associated with the Local Tuxedo access point's digital certificate.

Returns:

The privateKeyAlias value

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setPrivateKeyAlias

void setPrivateKeyAlias(String alias)
                        throws InvalidAttributeValueException

Sets the value of the PrivateKeyAlias attribute.

Parameters:

alias - The new privateKeyAlias value

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getPrivateKeyAlias()

getPrivateKeyPassPhrase

String getPrivateKeyPassPhrase()

The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated.

When you get the value of this attribute, WebLogic Server does the following:

1. Retrieves the value of the PrivateKeyPassPhraseEncrypted attribute.
2. Decrypts the value and returns the unencrypted passphrase as a String.

When you set the value of this attribute, WebLogic Server does the following:

1. Encrypts the value.
2. Sets the value of the PrivateKeyPassPhraseEncrypted attribute to the encrypted value.

Using this attribute (PrivateKeyPassPhrase) is a potential security risk because the String object (which contains the unencrypted passphrase) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

Instead of using this attribute, use getPrivateKeyPassPhraseEncrypted.

Returns:

The privateKeyPassPhrase value

setPrivateKeyPassPhrase

void setPrivateKeyPassPhrase(String passPhrase)
                             throws InvalidAttributeValueException

Sets the value of the PrivateKeyPassPhrase attribute.

Parameters:

phrase - The new privateKeyPassPhrase value

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getPrivateKeyPassPhrase(), WTCLocalTuxDomMBean.setPrivateKeyPassPhraseEncrypted(byte[])

getPrivateKeyPassPhraseEncrypted

byte[] getPrivateKeyPassPhraseEncrypted()

The encrypted passphrase used to retrieve the Local Tuxedo access point's private key from the keystore. This passphrase is assigned to the private key when it is generated.

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

The encrypted privateKeyPassPhrase value

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setPrivateKeyPassPhraseEncrypted

void setPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)

Sets the value of the privateKeyPassPhrase attribute.

Parameters:

phraseEncrypted - The new encrypted serverPrivateKeyPassPhrase value

See Also:

#setPrivateKeyPassPhraseEncrypted()

getTrustKeyStoreFileName

String getTrustKeyStoreFileName()

The path and file name of the trust keystore.

The path name must either be absolute or relative to where the server was booted. This file name is only used if KeyStores is "Custom Stores".

Returns:

The trustKeyStoreFileName value

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setTrustKeyStoreFileName

void setTrustKeyStoreFileName(String keystore)
                              throws InvalidAttributeValueException

Sets the value of the TrustKeyStoreFilename attribute.

Parameters:

fileName - The new trustKeyStoreFileName value

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getTrustKeyStoreFileName()

getTrustKeyStorePassPhrase

String getTrustKeyStorePassPhrase()

The trust keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.

This attribute is only used if KeyStores is "Custom Stores".

When you get the value of this attribute, WebLogic Server does the following:

1. Retrieves the value of the TrustKeyStorePassPhraseEncrypted attribute.
2. Decrypts the value and returns the unencrypted password as a String.

When you set the value of this attribute, WebLogic Server does the following:

1. Encrypts the value.
2. Sets the value of the TrustKeyStorePassPhraseEncrypted attribute to the encrypted value.

Using this attribute (TrustKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

Instead of using this attribute, use TrustKeyStorePassPhraseEncrypted.

Returns:

The trustKeyStorePassPhrase value

See Also:

WTCLocalTuxDomMBean.getTrustKeyStorePassPhraseEncrypted()

setTrustKeyStorePassPhrase

void setTrustKeyStorePassPhrase(String passPhrase)
                                throws InvalidAttributeValueException

Sets the value of the TrustKeyStorePassPhrase attribute.

Parameters:

passPhrase - The new trustKeyStorePassPhrase value

Throws:

InvalidAttributeValueException

See Also:

WTCLocalTuxDomMBean.getTrustKeyStorePassPhrase(), WTCLocalTuxDomMBean.setTrustKeyStorePassPhraseEncrypted(byte[])

getTrustKeyStorePassPhraseEncrypted

byte[] getTrustKeyStorePassPhraseEncrypted()

The trust keystore's encrypted passphrase. If empty or null, then the keystore will be opened without a passphrase.

This attribute is only used if KeyStores is "Custom Stores".

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, use the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

The encrypted trustKeyStorePassPhrase value

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setTrustKeyStorePassPhraseEncrypted

void setTrustKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)

Sets the encrypted value of the TrustKeyStorePassPhrase attribute.

Parameters:

passPhraseEncrypted - The new encrypted trustKeyStorePassPhrase value

See Also:

WTCLocalTuxDomMBean.getTrustKeyStorePassPhraseEncrypted()