Package weblogic.management.configuration

Interface WTCLocalTuxDomMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean

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.

Access limited to the following security roles:

Deployer

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccessPoint()	The unique name used to identify this local Tuxedo access point.
java.lang.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.
long	getBlockTime()	The maximum number of seconds this local Tuxedo access point allows for a blocking call.
int	getCmpLimit()	The compression threshold this local Tuxedo access point uses when sending data to a remote Tuxedo access point.
java.lang.String	getConnectionPolicy()	The conditions under which this local Tuxedo access point establishes a session connection with a remote Tuxedo access point.
java.lang.String	getConnPrincipalName()	The principal name used to verify the identity of this domain when establishing a connection to another domain.
java.lang.String	getIdentityKeyStoreFileName()	The path and file name of the identity keystore.
java.lang.String	getIdentityKeyStorePassPhrase()	The custom identity keystore's passphrase.
byte[]	getIdentityKeyStorePassPhraseEncrypted()	The identity keystore's encrypted passphrase.
java.lang.String	getInteroperate()	Specifies whether this local Tuxedo access point interoperates with remote Tuxedo access points that are based upon Tuxedo release 6.5.
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.
java.lang.String	getKeyStoresLocation()	Provides the configuration rule to be used for finding Local Access Point's identity key store and trust key store.
java.lang.String	getMaxEncryptBits()	The maximum encryption key length (in bits) this local Tuxedo access point uses when establishing a session connection.
long	getMaxRetries()	The maximum number of times that this local Tuxedo access point tries to establish a session connection to remote Tuxedo access points.
java.lang.String	getMinEncryptBits()	The minimum encryption key length (in bits) this local Tuxedo access point uses when establishing a session connection.
java.lang.String	getNWAddr()	The network address and port number of this local Tuxedo access point.
java.lang.String	getPrivateKeyAlias()	The string alias used to store and retrieve the Local Tuxedo access point's private key in the keystore.
java.lang.String	getPrivateKeyPassPhrase()	The passphrase used to retrieve the server's private key from the keystore.
byte[]	getPrivateKeyPassPhraseEncrypted()	The encrypted passphrase used to retrieve the Local Tuxedo access point's private key from the keystore.
long	getRetryInterval()	The number of seconds that this local Tuxedo access point waits between automatic connection attempts to remote Tuxedo access points.
java.lang.String	getSecurity()	The type of application security enforced.
java.lang.String	getSSLProtocolVersion()	The protocol version of the SSL connection this local access point uses when establishing a SSL connection.
java.lang.String	getTrustKeyStoreFileName()	The path and file name of the trust keystore.
java.lang.String	getTrustKeyStorePassPhrase()	The trust keystore's passphrase.
byte[]	getTrustKeyStorePassPhraseEncrypted()	The trust keystore's encrypted passphrase.
java.lang.String	getUseSSL()	Specifies if the connection initiated or accepted by this Local Tuxedo access point uses SSL on top of its transport layer.
void	setAccessPoint(java.lang.String AccessPoint)	Sets the value of the AccessPoint attribute.
void	setAccessPointId(java.lang.String AccessPointId)	Sets the value of the AccessPointId attribute.
void	setBlockTime(long BlockTime)	Sets the value of the BlockTime attribute.
void	setCmpLimit(int CmpLimit)	Sets the value of the CmpLimit attribute.
void	setConnectionPolicy(java.lang.String ConnectionPolicy)	Sets the value of the ConnectionPolicy attribute.
void	setConnPrincipalName(java.lang.String ConnPrincipalName)	Sets the value of the ConnPrincipalName attribute.
void	setIdentityKeyStoreFileName(java.lang.String keystore)	Sets the value of the identityKeyStoreFileName attribute.
void	setIdentityKeyStorePassPhrase(java.lang.String passPhrase)	Sets the value of the CustomIdentityKeyStorePassPhrase attribute.
void	setIdentityKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)	Sets the encrypted value of the IdentityKeyStorePassPhrase attribute.
void	setInteroperate(java.lang.String Interoperate)	Sets the value of the Interoperate attribute.
void	setKeepAlive(int KeepAlive)	Sets the value of the KeepAlive attribute.
void	setKeepAliveWait(int KeepAliveWait)	Sets the value of the KeepAliveWait attribute.
void	setKeyStoresLocation(java.lang.String location)	Sets the value of the KeyStoresLocation attribute.
void	setMaxEncryptBits(java.lang.String MaxEncryptBits)	Sets the value of the MaxEncryptBits attribute.
void	setMaxRetries(long MaxRetries)	Sets the value of the MaxRetries attribute.
void	setMinEncryptBits(java.lang.String MinEncryptBits)	Sets the value of the MinEncryptBits attribute.
void	setNWAddr(java.lang.String ListenAddress)	Sets the value of the NWAddr attribute.
void	setPrivateKeyAlias(java.lang.String alias)	Sets the value of the PrivateKeyAlias attribute.
void	setPrivateKeyPassPhrase(java.lang.String passPhrase)	Sets the value of the PrivateKeyPassPhrase attribute.
void	setPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)	Sets the value of the privateKeyPassPhrase attribute.
void	setRetryInterval(long RetryInterval)	Sets the value of the RetryInterval attribute.
void	setSecurity(java.lang.String Security)	Sets the value of the Security attribute.
void	setSSLProtocolVersion(java.lang.String SSLProtocolVersion)	Sets the value of the SSLProtocolVersion attribute.
void	setTrustKeyStoreFileName(java.lang.String keystore)	Sets the value of the TrustKeyStoreFilename attribute.
void	setTrustKeyStorePassPhrase(java.lang.String passPhrase)	Sets the value of the TrustKeyStorePassPhrase attribute.
void	setTrustKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)	Sets the encrypted value of the TrustKeyStorePassPhrase attribute.
void	setUseSSL(java.lang.String useSSL)

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.WebLogicMBean

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

Method Detail

setAccessPoint

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

Sets the value of the AccessPoint attribute.

Parameters:

AccessPoint - the name for the local Tuxedo access point

Throws:

javax.management.InvalidAttributeValueException

See Also:

getAccessPoint()

Default Value:

"myLAP"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

This property cannot be null.

getAccessPoint

java.lang.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setAccessPointId

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

Sets the value of the AccessPointId attribute.

Parameters:

AccessPointId - the local Tuxedo access point identifier

Throws:

javax.management.InvalidAttributeValueException

See Also:

getAccessPointId()

Default Value:

"myLAPId"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

This property cannot be null.

getAccessPointId

java.lang.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setSecurity

void setSecurity(java.lang.String Security)
          throws javax.management.InvalidAttributeValueException

Sets the value of the Security attribute.

Parameters:

Security - the security level to be enforced

Throws:

javax.management.InvalidAttributeValueException

See Also:

getSecurity()

Default Value:

"NONE"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

"NONE","APP_PW","DM_PW"

getSecurity

java.lang.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setConnectionPolicy

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

Sets the value of the ConnectionPolicy attribute.

Parameters:

ConnectionPolicy - the connection policy for this local Tuxedo access point

Throws:

javax.management.InvalidAttributeValueException

See Also:

getConnectionPolicy()

Default Value:

"ON_DEMAND"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

"ON_DEMAND","ON_STARTUP","INCOMING_ONLY"

getConnectionPolicy

java.lang.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setConnPrincipalName

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

Sets the value of the ConnPrincipalName attribute.

Parameters:

ConnPrincipalName - The new connPrincipalName value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getConnPrincipalName()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getConnPrincipalName

java.lang.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 Oracle 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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setRetryInterval

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

Sets the value of the RetryInterval attribute.

Parameters:

RetryInterval - the retry interval for this local Tuxedo access point

Throws:

javax.management.InvalidAttributeValueException

See Also:

getRetryInterval()

Default Value:

60

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setMaxRetries

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

Sets the value of the MaxRetries attribute.

Parameters:

MaxRetries - the number of times to attempt connection to remote Tuxedo access points

Throws:

javax.management.InvalidAttributeValueException

See Also:

getMaxRetries()

Default Value:

java.lang.Long.MAX_VALUE

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setBlockTime

void setBlockTime(long BlockTime)
           throws javax.management.InvalidAttributeValueException

Sets the value of the BlockTime attribute.

Parameters:

BlockTime - the maximum wait time allowed for a blocking call

Throws:

javax.management.InvalidAttributeValueException

See Also:

getBlockTime()

Default Value:

60

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setNWAddr

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

Sets the value of the NWAddr attribute.

Parameters:

ListenAddress - The new nWAddr value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getNWAddr()

Default Value:

"//localhost:8901"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getNWAddr

java.lang.String getNWAddr()

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

Specify the address in one of the following formats:

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

Notes:

• If the hostname is used, the access point finds an address for hostname using the local name resolution facilities (usually DNS). If dotted decimal format is used, each # should be a number from 0 to 255. This dotted decimal number represents the IP address of the local machine. The port_number is the TCP/SDP port number at which the access point listens for incoming requests.
• If SDP format address is specified, the transport protocol for this access point is SDP instead of TCP. This feature is only available when WTC and Tuxedo domain gateway are both deployed on Oracle Exalogic platform. Requires Tuxedo 11gR1PS2 and higher.

Returns:

The nWAddr value

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setCmpLimit

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

Sets the value of the CmpLimit attribute.

Parameters:

CmpLimit - The compression threshold for this local Tuxedo access point

Throws:

javax.management.InvalidAttributeValueException

See Also:

getCmpLimit()

Default Value:

java.lang.Integer.MAX_VALUE

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setMinEncryptBits

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

Sets the value of the MinEncryptBits attribute.

Parameters:

MinEncryptBits - The minimum encryption level desired for this local Tuxedo access point

Throws:

javax.management.InvalidAttributeValueException

See Also:

getMinEncryptBits()

Default Value:

"0"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

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

getMinEncryptBits

java.lang.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setMaxEncryptBits

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

Sets the value of the MaxEncryptBits attribute.

Parameters:

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

Throws:

javax.management.InvalidAttributeValueException

See Also:

getMaxEncryptBits()

Default Value:

"128"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

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

getMaxEncryptBits

java.lang.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setInteroperate

void setInteroperate(java.lang.String Interoperate)
              throws javax.management.InvalidAttributeValueException

Sets the value of the Interoperate attribute.

Parameters:

Interoperate - The interoperatibility desired for this local Tuxedo access point

Throws:

javax.management.InvalidAttributeValueException

See Also:

getInteroperate()

Default Value:

"No"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

"Yes", "No"

getInteroperate

java.lang.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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setKeepAlive

void setKeepAlive(int KeepAlive)
           throws javax.management.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:

javax.management.InvalidAttributeValueException

See Also:

getKeepAlive()

Default Value:

0

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setKeepAliveWait

void setKeepAliveWait(int KeepAliveWait)
               throws javax.management.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:

javax.management.InvalidAttributeValueException

See Also:

getKeepAliveWait()

Default Value:

0

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getUseSSL

java.lang.String getUseSSL()

Specifies if the 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.

Note: If SDP transport is configured for this access point, the configured value of this attribute is ignored and off is used.

Returns:

the useSSL value for this Local Tuxedo access point.

Default Value:

"Off"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

"Off", "TwoWay", "OneWay"

setUseSSL

void setUseSSL(java.lang.String useSSL)
        throws javax.management.InvalidAttributeValueException

Parameters:

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

Throws:

javax.management.InvalidAttributeValueException

getKeyStoresLocation

java.lang.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

Default Value:

"Custom Stores"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

"WLS Stores", "Custom Stores"

setKeyStoresLocation

void setKeyStoresLocation(java.lang.String location)
                   throws javax.management.InvalidAttributeValueException

Sets the value of the KeyStoresLocation attribute.

Parameters:

location - The new keyStoresLocation value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getKeyStoresLocation()

getIdentityKeyStoreFileName

java.lang.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

Default Value:

null

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setIdentityKeyStoreFileName

void setIdentityKeyStoreFileName(java.lang.String keystore)
                          throws javax.management.InvalidAttributeValueException

Sets the value of the identityKeyStoreFileName attribute.

Parameters:

keystore - The new identityKeyStoreFileName value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getIdentityKeyStoreFileName()

getIdentityKeyStorePassPhrase

java.lang.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:

getIdentityKeyStorePassPhraseEncrypted()

setIdentityKeyStorePassPhrase

void setIdentityKeyStorePassPhrase(java.lang.String passPhrase)
                            throws javax.management.InvalidAttributeValueException

Sets the value of the CustomIdentityKeyStorePassPhrase attribute.

Parameters:

passPhrase - The new customIdentityKeyStorePassPhrase value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getIdentityKeyStorePassPhrase(), setIdentityKeyStorePassPhraseEncrypted(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

Default Value:

null

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setIdentityKeyStorePassPhraseEncrypted

void setIdentityKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)

Sets the encrypted value of the IdentityKeyStorePassPhrase attribute.

Parameters:

passPhraseEncrypted - The new encrypted identityKeyStorePassPhrase value

See Also:

getIdentityKeyStorePassPhraseEncrypted()

getPrivateKeyAlias

java.lang.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

Default Value:

null

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setPrivateKeyAlias

void setPrivateKeyAlias(java.lang.String alias)
                 throws javax.management.InvalidAttributeValueException

Sets the value of the PrivateKeyAlias attribute.

Parameters:

alias - The new privateKeyAlias value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getPrivateKeyAlias()

getPrivateKeyPassPhrase

java.lang.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(java.lang.String passPhrase)
                      throws javax.management.InvalidAttributeValueException

Sets the value of the PrivateKeyPassPhrase attribute.

Parameters:

passPhrase - The new privateKeyPassPhrase value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getPrivateKeyPassPhrase(), 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

Default Value:

null

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setPrivateKeyPassPhraseEncrypted

void setPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)

Sets the value of the privateKeyPassPhrase attribute.

Parameters:

phraseEncrypted - The new encrypted serverPrivateKeyPassPhrase value

See Also:

setPrivateKeyPassPhraseEncrypted(byte[])

getTrustKeyStoreFileName

java.lang.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

Default Value:

null

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setTrustKeyStoreFileName

void setTrustKeyStoreFileName(java.lang.String keystore)
                       throws javax.management.InvalidAttributeValueException

Sets the value of the TrustKeyStoreFilename attribute.

Parameters:

keystore - The new trustKeyStoreFileName value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getTrustKeyStoreFileName()

getTrustKeyStorePassPhrase

java.lang.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:

getTrustKeyStorePassPhraseEncrypted()

setTrustKeyStorePassPhrase

void setTrustKeyStorePassPhrase(java.lang.String passPhrase)
                         throws javax.management.InvalidAttributeValueException

Sets the value of the TrustKeyStorePassPhrase attribute.

Parameters:

passPhrase - The new trustKeyStorePassPhrase value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getTrustKeyStorePassPhrase(), 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

Default Value:

null

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setTrustKeyStorePassPhraseEncrypted

void setTrustKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)

Sets the encrypted value of the TrustKeyStorePassPhrase attribute.

Parameters:

passPhraseEncrypted - The new encrypted trustKeyStorePassPhrase value

See Also:

getTrustKeyStorePassPhraseEncrypted()

setSSLProtocolVersion

void setSSLProtocolVersion(java.lang.String SSLProtocolVersion)
                    throws javax.management.InvalidAttributeValueException

Sets the value of the SSLProtocolVersion attribute.

Parameters:

SSLProtocolVersion - The protocol version of the SSL connection for this local access point

Throws:

javax.management.InvalidAttributeValueException

See Also:

getSSLProtocolVersion()

Default Value:

"TLSv1.2"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

"TLSv1.0","TLSv1.1","TLSv1.2"

getSSLProtocolVersion

java.lang.String getSSLProtocolVersion()

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

Value Restrictions:

• TLSv1.0
• TLSv1.1
• TLSv1.2

Returns:

The SSLProtocolVersion value for this local access point

Default Value:

"TLSv1.2"

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

"TLSv1.0","TLSv1.1","TLSv1.2"