Package weblogic.management.configuration

Interface JoltConnectionPoolMBean

All Superinterfaces:

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

public interface JoltConnectionPoolMBean
extends DeploymentMBean

This bean defines a Jolt connection pool.

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Fields inherited from interface weblogic.management.configuration.DeploymentMBean

DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Method Summary

Modifier and Type	Method	Description
boolean	addFailoverAddress(java.lang.String address)	Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object
boolean	addPrimaryAddress(java.lang.String address)	Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object
java.lang.String	getApplicationPassword()	The application password for this Jolt connection pool.
byte[]	getApplicationPasswordEncrypted()	The encrypted application password for this connection pool.
java.lang.String[]	getFailoverAddresses()	The list of Jolt Server Listeners (JSLs) addresses that is used if the connection pool cannot estabilish connections to the Primary Addresses, or if the primary connections fail.
java.lang.String	getKeyPassPhrase()	The encrypted identity passphrase.
byte[]	getKeyPassPhraseEncrypted()	Returns encrypted identity pass phrase.
java.lang.String	getKeyStoreName()	The path and file name of the keystore containing the private key used in SSL mutual authentication.
java.lang.String	getKeyStorePassPhrase()	The encrypted identity keystore's passphrase.
byte[]	getKeyStorePassPhraseEncrypted()	Returns encrypted pass phrase defined when creating the keystore.
int	getMaximumPoolSize()	The maximum number of connections that can be made from this Jolt connection pool.
int	getMinimumPoolSize()	The minimum number of connections to be added to this Jolt connection pool when WebLogic Server starts.
java.lang.String[]	getPrimaryAddresses()	The list of addresses for the primary Jolt Server Listeners (JSLs) on the Tuxedo system.
int	getRecvTimeout()	The number of seconds the client waits to receive a response before timing out.
java.lang.String	getTrustStoreName()	The path and file name of the keystore containing the trust certificates.
java.lang.String	getTrustStorePassPhrase()	The encrypted trust keystore's passphrase.
byte[]	getTrustStorePassPhraseEncrypted()	Returns encrypted pass phrase defined when creating the keystore.
java.lang.String	getUserName()	A user name that applications specify to connect to this Jolt connection pool.
java.lang.String	getUserPassword()	The user password for this Jolt connection pool.
byte[]	getUserPasswordEncrypted()	The user password for this connection pool.
java.lang.String	getUserRole()	The Tuxedo user role for this Jolt connection pool.
boolean	isSecurityContextEnabled()	Indicates whether this Jolt connection pool passes the connection pool's security context (user name, password and other information) from the WebLogic Server user to the Tuxedo domain.
boolean	removeFailoverAddress(java.lang.String address)
boolean	removePrimaryAddress(java.lang.String address)
void	setApplicationPassword(java.lang.String password)	Sets the value of the ApplicationPassword attribute.
void	setApplicationPasswordEncrypted(byte[] bytes)	Encrypts the password and sets the value of the ApplicationPasswordEncrypted attribute.
void	setFailoverAddresses(java.lang.String[] args)	Sets the value of the FailoverAddresses attribute.
void	setKeyPassPhrase(java.lang.String passPhrase)	Sets the value of the KeyPassPhrase attribute.
void	setKeyPassPhraseEncrypted(byte[] passPhraseEncrypted)	Sets the encrypted value of the keyPassPhrase attribute.
void	setKeyStoreName(java.lang.String keyStoreName)	Sets the path and file name of the keystore containing the private key used in SSL mutual authentication.
void	setKeyStorePassPhrase(java.lang.String passPhrase)	Sets the value of the KeyStorePassPhrase attribute.
void	setKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)	Sets the encrypted value of the keyStorePassPhrase attribute.
void	setMaximumPoolSize(int size)	Sets the value of the MaximumPoolSize attribute.
void	setMinimumPoolSize(int size)	Sets the value of the MinimumPoolSize attribute.
void	setPrimaryAddresses(java.lang.String[] args)	Sets the value of the PrimaryAddresses attribute.
void	setRecvTimeout(int secs)	Sets the value of the RecvTimeout attribute.
void	setSecurityContextEnabled(boolean on)	Sets the value of the SecurityContextEnabled attribute.
void	setTrustStoreName(java.lang.String keyStoreName)	Sets the path and file name of the keystore containing the trust certificates.
void	setTrustStorePassPhrase(java.lang.String passPhrase)	Sets the value of the TrustStorePassPhrase attribute.
void	setTrustStorePassPhraseEncrypted(byte[] passPhraseEncrypted)	Sets the encrypted value of the TrustStorePassPhrase attribute.
void	setUserName(java.lang.String name)	Sets the value of the UserName attribute.
void	setUserPassword(java.lang.String password)	Sets the value of the UserPassword attribute.
void	setUserPasswordEncrypted(byte[] bytes)	Encrypts the user password and sets the value of the UserPasswordEncrypted attribute.
void	setUserRole(java.lang.String role)	Sets the value of the UserRole attribute.

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.management.configuration.DeploymentMBean

addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets

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

getPrimaryAddresses

java.lang.String[] getPrimaryAddresses()

The list of addresses for the primary Jolt Server Listeners (JSLs) on the Tuxedo system.

The format of each address is: //hostname:port. Multiple addresses should be separated by commas.

Returns:

The primaryAddresses value

setPrimaryAddresses

void setPrimaryAddresses(java.lang.String[] args)
                  throws javax.management.InvalidAttributeValueException

Sets the value of the PrimaryAddresses attribute.

Parameters:

args - The new primaryAddresses value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getPrimaryAddresses()

addPrimaryAddress

boolean addPrimaryAddress(java.lang.String address)
                   throws javax.management.InvalidAttributeValueException

Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object

Parameters:

address - The feature to be added to the PrimaryAddress attribute

Throws:

javax.management.InvalidAttributeValueException

removePrimaryAddress

boolean removePrimaryAddress(java.lang.String address)
                      throws javax.management.InvalidAttributeValueException

Parameters:

address -

Throws:

javax.management.InvalidAttributeValueException

getFailoverAddresses

java.lang.String[] getFailoverAddresses()

The list of Jolt Server Listeners (JSLs) addresses that is used if the connection pool cannot estabilish connections to the Primary Addresses, or if the primary connections fail.

The format of each address is: //hostname:port. Multiple addresses should be separated by commas.

These JSLs need not reside on the same host as the primary JSLs.

Returns:

The failoverAddresses value

setFailoverAddresses

void setFailoverAddresses(java.lang.String[] args)
                   throws javax.management.InvalidAttributeValueException

Sets the value of the FailoverAddresses attribute.

Parameters:

args - The new failoverAddresses value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getFailoverAddresses()

addFailoverAddress

boolean addFailoverAddress(java.lang.String address)
                    throws javax.management.InvalidAttributeValueException

Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object

Parameters:

address - The feature to be added to the FailoverAddress attribute

Throws:

javax.management.InvalidAttributeValueException

removeFailoverAddress

boolean removeFailoverAddress(java.lang.String address)
                       throws javax.management.InvalidAttributeValueException

Parameters:

address -

Throws:

javax.management.InvalidAttributeValueException

getMinimumPoolSize

int getMinimumPoolSize()

The minimum number of connections to be added to this Jolt connection pool when WebLogic Server starts.

Returns:

The minimumPoolSize value

Default Value:

0

setMinimumPoolSize

void setMinimumPoolSize(int size)
                 throws javax.management.InvalidAttributeValueException

Sets the value of the MinimumPoolSize attribute.

Parameters:

size - The new minimumPoolSize value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getMinimumPoolSize()

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getMaximumPoolSize

int getMaximumPoolSize()

The maximum number of connections that can be made from this Jolt connection pool.

Returns:

The maximumPoolSize value

Default Value:

1

setMaximumPoolSize

void setMaximumPoolSize(int size)
                 throws javax.management.InvalidAttributeValueException

Sets the value of the MaximumPoolSize attribute.

Parameters:

size - The new maximumPoolSize value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getMaximumPoolSize()

Default Value:

1

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getUserName

java.lang.String getUserName()

A user name that applications specify to connect to this Jolt connection pool. If Security Context is enabled, this name must be the name of an authorized Tuxedo user. (Specifying a Tuxedo user name is required if the Tuxedo authentication level is USER_AUTH.)

Returns:

The userName value

setUserName

void setUserName(java.lang.String name)
          throws javax.management.InvalidAttributeValueException

Sets the value of the UserName attribute.

Parameters:

name - The new userName value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getUserName()

getUserPassword

java.lang.String getUserPassword()

The user password for this Jolt connection pool.

As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

1. Retrieves the value of the UserPasswordEncrypted 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 UserPasswordEncrypted attribute to the encrypted value.

Using this attribute (UserPassword) 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 UserPasswordEncrypted.

Returns:

The userPassword value

See Also:

getUserPasswordEncrypted()

Access limited to the following security roles:

Deployer

setUserPassword

void setUserPassword(java.lang.String password)
              throws javax.management.InvalidAttributeValueException

Sets the value of the UserPassword attribute.

Parameters:

password - The new userPassword value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getUserPassword()

getUserPasswordEncrypted

byte[] getUserPasswordEncrypted()

The user password for this connection pool.

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 userPassword value as an encrypted byte array.

Access limited to the following security roles:

Deployer

setUserPasswordEncrypted

void setUserPasswordEncrypted(byte[] bytes)
                       throws javax.management.InvalidAttributeValueException

Encrypts the user password and sets the value of the UserPasswordEncrypted attribute.

Parameters:

bytes - The new userPassword value as a byte array

Throws:

javax.management.InvalidAttributeValueException

See Also:

getUserPasswordEncrypted()

getApplicationPassword

java.lang.String getApplicationPassword()

The application password for this Jolt connection pool. (This is required only when the security level in the Tuxedo domain is USER_AUTH, ACL or MANDATORY_ACL).

As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

1. Retrieves the value of the ApplicationPasswordEncrypted 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 ApplicationPasswordEncrypted attribute to the encrypted value.

Using this attribute (ApplicationPassword) 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 ApplicationPasswordEncrypted.

Returns:

The applicationPassword value

See Also:

getApplicationPasswordEncrypted()

Access limited to the following security roles:

Deployer

setApplicationPassword

void setApplicationPassword(java.lang.String password)
                     throws javax.management.InvalidAttributeValueException

Sets the value of the ApplicationPassword attribute.

Parameters:

password - The new applicationPassword value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getApplicationPassword()

getApplicationPasswordEncrypted

byte[] getApplicationPasswordEncrypted()

The encrypted application password for this connection pool.

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 applicationPassword value as an encrypted byte[] array.

Access limited to the following security roles:

Deployer

setApplicationPasswordEncrypted

void setApplicationPasswordEncrypted(byte[] bytes)
                              throws javax.management.InvalidAttributeValueException

Encrypts the password and sets the value of the ApplicationPasswordEncrypted attribute.

Parameters:

bytes - The new applicationPassword value as a byte array

Throws:

javax.management.InvalidAttributeValueException

See Also:

getApplicationPasswordEncrypted()

getUserRole

java.lang.String getUserRole()

The Tuxedo user role for this Jolt connection pool. (This is required only when the security level in the Tuxedo domain is USER_AUTH, ACL, or MANDATORY_ACL).

Returns:

The userRole value

setUserRole

void setUserRole(java.lang.String role)
          throws javax.management.InvalidAttributeValueException

Sets the value of the UserRole attribute.

Parameters:

role - The new userRole value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getUserRole()

isSecurityContextEnabled

boolean isSecurityContextEnabled()

Indicates whether this Jolt connection pool passes the connection pool's security context (user name, password and other information) from the WebLogic Server user to the Tuxedo domain.

If you enable the connection pool to pass the security context, you must start the Jolt Service Handler (JSH) with the -a option. When the JSH gets a message with the caller's identity, it calls impersonate_user() to get the appkey for the user. JSH caches the appkey, so the next time the caller makes a request, the appkey is retrieved from the cache and the request is forwarded to the service. A cache is maintained by each JSH, which means that there will be a cache maintained for all the session pools connected to the same JSH.

You must enable Security Context if Tuxedo requires secured connections.

Returns:

The securityContextEnabled value

Default Value:

false

setSecurityContextEnabled

void setSecurityContextEnabled(boolean on)
                        throws javax.management.InvalidAttributeValueException

Sets the value of the SecurityContextEnabled attribute.

Parameters:

on - The new securityContextEnabled value

Throws:

javax.management.InvalidAttributeValueException

See Also:

isSecurityContextEnabled()

getRecvTimeout

int getRecvTimeout()

The number of seconds the client waits to receive a response before timing out.

Returns:

The recvTimeout value

Default Value:

0

setRecvTimeout

void setRecvTimeout(int secs)
             throws javax.management.InvalidAttributeValueException

Sets the value of the RecvTimeout attribute.

Parameters:

secs - The new recvTimeout value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getRecvTimeout()

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getKeyStoreName

java.lang.String getKeyStoreName()

The path and file name of the keystore containing the private key used in SSL mutual authentication.

Returns:

The keyStoreName value

setKeyStoreName

void setKeyStoreName(java.lang.String keyStoreName)
              throws javax.management.InvalidAttributeValueException

Sets the path and file name of the keystore containing the private key used in SSL mutual authentication.

Parameters:

keyStoreName - The new keyStoreName value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getKeyStoreName()

getTrustStoreName

java.lang.String getTrustStoreName()

The path and file name of the keystore containing the trust certificates.

Returns:

The trustStoreName value

setTrustStoreName

void setTrustStoreName(java.lang.String keyStoreName)
                throws javax.management.InvalidAttributeValueException

Sets the path and file name of the keystore containing the trust certificates.

Parameters:

keyStoreName - The new trustStoreName value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getTrustStoreName()

getKeyPassPhrase

java.lang.String getKeyPassPhrase()

The encrypted identity passphrase.

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

1. Retrieves the value of the KeyPassPhraseEncrypted 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 KeyPassPhraseEncrypted attribute to the encrypted value.

Using this attribute (KeyPassPhrase) 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 KeyPassPhraseEncrypted.

Returns:

The keyPassPhrase value

See Also:

getKeyPassPhraseEncrypted()

setKeyPassPhrase

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

Sets the value of the KeyPassPhrase attribute.

Parameters:

passPhrase - The new keyPassPhrase value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getKeyPassPhrase(), setKeyPassPhraseEncrypted(byte[])

getKeyPassPhraseEncrypted

byte[] getKeyPassPhraseEncrypted()

Returns encrypted identity pass phrase.

Returns:

The encrypted keyPassPhrase value

Default Value:

null

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

setKeyPassPhraseEncrypted

void setKeyPassPhraseEncrypted(byte[] passPhraseEncrypted)

Sets the encrypted value of the keyPassPhrase attribute.

Parameters:

passPhraseEncrypted - The new encrypted keyPassPhrase value

See Also:

getKeyPassPhraseEncrypted()

getKeyStorePassPhrase

java.lang.String getKeyStorePassPhrase()

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

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

1. Retrieves the value of the KeyStorePassPhraseEncrypted 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 KeyStorePassPhraseEncrypted attribute to the encrypted value.

Using this attribute (KeyStorePassPhrase) 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 KeyStorePassPhraseEncrypted.

Returns:

The keyStorePassPhrase value

See Also:

getKeyStorePassPhraseEncrypted()

setKeyStorePassPhrase

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

Sets the value of the KeyStorePassPhrase attribute.

Parameters:

passPhrase - The new keyStorePassPhrase value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getKeyStorePassPhrase(), setKeyStorePassPhraseEncrypted(byte[])

getKeyStorePassPhraseEncrypted

byte[] getKeyStorePassPhraseEncrypted()

Returns encrypted pass phrase defined when creating the keystore.

Returns:

The encrypted keyStorePassPhrase value

Default Value:

null

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

setKeyStorePassPhraseEncrypted

void setKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)

Sets the encrypted value of the keyStorePassPhrase attribute.

Parameters:

passPhraseEncrypted - The new encrypted keyStorePassPhrase value

See Also:

getKeyStorePassPhraseEncrypted()

getTrustStorePassPhrase

java.lang.String getTrustStorePassPhrase()

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

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

1. Retrieves the value of the TrustStorePassPhraseEncrypted 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 TrustStorePassPhraseEncrypted attribute to the encrypted value.

Using this attribute (TrustStorePassPhrase) 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 TrustStorePassPhraseEncrypted.

Returns:

The trustStorePassPhrase value

See Also:

getTrustStorePassPhraseEncrypted()

setTrustStorePassPhrase

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

Sets the value of the TrustStorePassPhrase attribute.

Parameters:

passPhrase - The new trustStorePassPhrase value

Throws:

javax.management.InvalidAttributeValueException

See Also:

getTrustStorePassPhrase(), setTrustStorePassPhraseEncrypted(byte[])

getTrustStorePassPhraseEncrypted

byte[] getTrustStorePassPhraseEncrypted()

Returns encrypted pass phrase defined when creating the keystore.

Returns:

The encrypted trustStorePassPhrase value

Default Value:

null

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

setTrustStorePassPhraseEncrypted

void setTrustStorePassPhraseEncrypted(byte[] passPhraseEncrypted)

Sets the encrypted value of the TrustStorePassPhrase attribute.

Parameters:

passPhraseEncrypted - The new encrypted trustStorePassPhrase value

See Also:

getTrustStorePassPhraseEncrypted()