Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.configuration
Interface JoltConnectionPoolMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean

public interface JoltConnectionPoolMBean

extends DeploymentMBean

This bean defines a Jolt connection pool.

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

Field Summary

Fields inherited from interface weblogic.management.configuration.DeploymentMBean

DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

boolean	addFailoverAddress(String address) Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object
boolean	addPrimaryAddress(String address) Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object
String	getApplicationPassword() The application password for this Jolt connection pool.
byte[]	getApplicationPasswordEncrypted() The encrypted application password for this connection pool.
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.
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.
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.
String	getUserName() A user name that applications specify to connect to this Jolt connection pool.
String	getUserPassword() The user password for this Jolt connection pool.
byte[]	getUserPasswordEncrypted() The user password for this connection pool.
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(String address)
boolean	removePrimaryAddress(String address)
void	setApplicationPassword(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(String[] args) Sets the value of the FailoverAddresses 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(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	setUserName(String name) Sets the value of the UserName attribute.
void	setUserPassword(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(String role) Sets the value of the UserRole attribute.

Methods inherited from interface weblogic.management.configuration.DeploymentMBean

addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.management.WebLogicMBean

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

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.descriptor.DescriptorBean

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Method Detail

addFailoverAddress

public boolean addFailoverAddress(String address)
                           throws InvalidAttributeValueException

Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object

Parameters:

address - The feature to be added to the FailoverAddress attribute

Returns:

Throws:

InvalidAttributeValueException

addPrimaryAddress

public boolean addPrimaryAddress(String address)
                          throws InvalidAttributeValueException

Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object

Parameters:

address - The feature to be added to the PrimaryAddress attribute

Returns:

Throws:

InvalidAttributeValueException

getApplicationPassword

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

getApplicationPasswordEncrypted

public byte[] getApplicationPasswordEncrypted()

The encrypted application password for this connection pool.

To set this attribute, pass an unencrypted string to the MBean server's setAttribute method. WebLogic Server encrypts the value and sets the attribute to the encrypted value.

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.

See Also:

weblogic.management.EncryptionHelper

getFailoverAddresses

public 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

getMaximumPoolSize

public int getMaximumPoolSize()

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

Returns:

The maximumPoolSize value

Default value:

1

getMinimumPoolSize

public 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

getPrimaryAddresses

public 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

getRecvTimeout

public int getRecvTimeout()

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

Returns:

The recvTimeout value

Default value:

0

getUserName

public 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

getUserPassword

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

getUserPasswordEncrypted

public byte[] getUserPasswordEncrypted()

The user password for this connection pool.

To set this attribute, pass an unencrypted string to the MBean server's setAttribute method. WebLogic Server encrypts the value and sets the attribute to the encrypted value.

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.

See Also:

weblogic.management.EncryptionHelper

getUserRole

public 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

isSecurityContextEnabled

public 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

removeFailoverAddress

public boolean removeFailoverAddress(String address)
                              throws InvalidAttributeValueException

Parameters:

address -

Returns:

Throws:

InvalidAttributeValueException

removePrimaryAddress

public boolean removePrimaryAddress(String address)
                             throws InvalidAttributeValueException

Parameters:

address -

Returns:

Throws:

InvalidAttributeValueException

setApplicationPassword

public void setApplicationPassword(String password)
                            throws InvalidAttributeValueException

Sets the value of the ApplicationPassword attribute.

Parameters:

password - The new applicationPassword value

Throws:

InvalidAttributeValueException

See Also:

getApplicationPassword()

setApplicationPasswordEncrypted

public void setApplicationPasswordEncrypted(byte[] bytes)
                                     throws InvalidAttributeValueException

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

Parameters:

bytes - The new applicationPassword value as a byte array

Throws:

InvalidAttributeValueException

See Also:

getApplicationPasswordEncrypted()

setFailoverAddresses

public void setFailoverAddresses(String[] args)
                          throws InvalidAttributeValueException

Sets the value of the FailoverAddresses attribute.

Parameters:

args - The new failoverAddresses value

Throws:

InvalidAttributeValueException

See Also:

getFailoverAddresses()

setMaximumPoolSize

public void setMaximumPoolSize(int size)
                        throws InvalidAttributeValueException

Sets the value of the MaximumPoolSize attribute.

Parameters:

size - The new maximumPoolSize value

Throws:

InvalidAttributeValueException

See Also:

getMaximumPoolSize()

Default value:

1

Minimum value:

1

Maximum value:

java.lang.Integer.MAX_VALUE

setMinimumPoolSize

public void setMinimumPoolSize(int size)
                        throws InvalidAttributeValueException

Sets the value of the MinimumPoolSize attribute.

Parameters:

size - The new minimumPoolSize value

Throws:

InvalidAttributeValueException

See Also:

getMinimumPoolSize()

Default value:

0

Minimum value:

0

Maximum value:

java.lang.Integer.MAX_VALUE

setPrimaryAddresses

public void setPrimaryAddresses(String[] args)
                         throws InvalidAttributeValueException

Sets the value of the PrimaryAddresses attribute.

Parameters:

args - The new primaryAddresses value

Throws:

InvalidAttributeValueException

See Also:

getPrimaryAddresses()

setRecvTimeout

public void setRecvTimeout(int secs)
                    throws InvalidAttributeValueException

Sets the value of the RecvTimeout attribute.

Parameters:

secs - The new recvTimeout value

Throws:

InvalidAttributeValueException

See Also:

getRecvTimeout()

Default value:

0

Minimum value:

0

Maximum value:

java.lang.Integer.MAX_VALUE

setSecurityContextEnabled

public void setSecurityContextEnabled(boolean on)
                               throws InvalidAttributeValueException

Sets the value of the SecurityContextEnabled attribute.

Parameters:

on - The new securityContextEnabled value

Throws:

InvalidAttributeValueException

See Also:

isSecurityContextEnabled()

setUserName

public void setUserName(String name)
                 throws InvalidAttributeValueException

Sets the value of the UserName attribute.

Parameters:

name - The new userName value

Throws:

InvalidAttributeValueException

See Also:

getUserName()

setUserPassword

public void setUserPassword(String password)
                     throws InvalidAttributeValueException

Sets the value of the UserPassword attribute.

Parameters:

password - The new userPassword value

Throws:

InvalidAttributeValueException

See Also:

getUserPassword()

setUserPasswordEncrypted

public void setUserPasswordEncrypted(byte[] bytes)
                              throws InvalidAttributeValueException

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

Parameters:

bytes - The new userPassword value as a byte array

Throws:

InvalidAttributeValueException

See Also:

getUserPasswordEncrypted()

setUserRole

public void setUserRole(String role)
                 throws InvalidAttributeValueException

Sets the value of the UserRole attribute.

Parameters:

role - The new userRole value

Throws:

InvalidAttributeValueException

See Also:

getUserRole()