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.
DEFAULT_EMPTY_BYTE_ARRAY
DEFAULT_ORDER, MAX_ORDER, MIN_ORDER
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.
|
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preDeregister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
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.
void setPrimaryAddresses(java.lang.String[] args) throws javax.management.InvalidAttributeValueException
Sets the value of the PrimaryAddresses attribute.
args
- The new primaryAddresses valuejavax.management.InvalidAttributeValueException
getPrimaryAddresses()
boolean addPrimaryAddress(java.lang.String address) throws javax.management.InvalidAttributeValueException
Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object
address
- The feature to be added to the PrimaryAddress attributejavax.management.InvalidAttributeValueException
boolean removePrimaryAddress(java.lang.String address) throws javax.management.InvalidAttributeValueException
address
- javax.management.InvalidAttributeValueException
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.
void setFailoverAddresses(java.lang.String[] args) throws javax.management.InvalidAttributeValueException
Sets the value of the FailoverAddresses attribute.
args
- The new failoverAddresses valuejavax.management.InvalidAttributeValueException
getFailoverAddresses()
boolean addFailoverAddress(java.lang.String address) throws javax.management.InvalidAttributeValueException
Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object
address
- The feature to be added to the FailoverAddress attributejavax.management.InvalidAttributeValueException
boolean removeFailoverAddress(java.lang.String address) throws javax.management.InvalidAttributeValueException
address
- javax.management.InvalidAttributeValueException
int getMinimumPoolSize()
The minimum number of connections to be added to this Jolt connection pool when WebLogic Server starts.
void setMinimumPoolSize(int size) throws javax.management.InvalidAttributeValueException
Sets the value of the MinimumPoolSize attribute.
size
- The new minimumPoolSize valuejavax.management.InvalidAttributeValueException
getMinimumPoolSize()
int getMaximumPoolSize()
The maximum number of connections that can be made from this Jolt connection pool.
void setMaximumPoolSize(int size) throws javax.management.InvalidAttributeValueException
Sets the value of the MaximumPoolSize attribute.
size
- The new maximumPoolSize valuejavax.management.InvalidAttributeValueException
getMaximumPoolSize()
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
.)
void setUserName(java.lang.String name) throws javax.management.InvalidAttributeValueException
Sets the value of the UserName attribute.
name
- The new userName valuejavax.management.InvalidAttributeValueException
getUserName()
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:
UserPasswordEncrypted
attribute.When you set the value of this attribute, WebLogic Server does the following:
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
.
getUserPasswordEncrypted()
void setUserPassword(java.lang.String password) throws javax.management.InvalidAttributeValueException
Sets the value of the UserPassword attribute.
password
- The new userPassword valuejavax.management.InvalidAttributeValueException
getUserPassword()
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.
void setUserPasswordEncrypted(byte[] bytes) throws javax.management.InvalidAttributeValueException
Encrypts the user password and sets the value of the UserPasswordEncrypted attribute.
bytes
- The new userPassword value as a byte arrayjavax.management.InvalidAttributeValueException
getUserPasswordEncrypted()
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:
ApplicationPasswordEncrypted
attribute.When you set the value of this attribute, WebLogic Server does the following:
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
.
getApplicationPasswordEncrypted()
void setApplicationPassword(java.lang.String password) throws javax.management.InvalidAttributeValueException
Sets the value of the ApplicationPassword attribute.
password
- The new applicationPassword valuejavax.management.InvalidAttributeValueException
getApplicationPassword()
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.
void setApplicationPasswordEncrypted(byte[] bytes) throws javax.management.InvalidAttributeValueException
Encrypts the password and sets the value of the ApplicationPasswordEncrypted attribute.
bytes
- The new applicationPassword value as a byte arrayjavax.management.InvalidAttributeValueException
getApplicationPasswordEncrypted()
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
).
void setUserRole(java.lang.String role) throws javax.management.InvalidAttributeValueException
Sets the value of the UserRole attribute.
role
- The new userRole valuejavax.management.InvalidAttributeValueException
getUserRole()
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.
void setSecurityContextEnabled(boolean on) throws javax.management.InvalidAttributeValueException
Sets the value of the SecurityContextEnabled attribute.
on
- The new securityContextEnabled valuejavax.management.InvalidAttributeValueException
isSecurityContextEnabled()
int getRecvTimeout()
The number of seconds the client waits to receive a response before timing out.
void setRecvTimeout(int secs) throws javax.management.InvalidAttributeValueException
Sets the value of the RecvTimeout attribute.
secs
- The new recvTimeout valuejavax.management.InvalidAttributeValueException
getRecvTimeout()
java.lang.String getKeyStoreName()
The path and file name of the keystore containing the private key used in SSL mutual authentication.
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.
keyStoreName
- The new keyStoreName valuejavax.management.InvalidAttributeValueException
getKeyStoreName()
java.lang.String getTrustStoreName()
The path and file name of the keystore containing the trust certificates.
void setTrustStoreName(java.lang.String keyStoreName) throws javax.management.InvalidAttributeValueException
Sets the path and file name of the keystore containing the trust certificates.
keyStoreName
- The new trustStoreName valuejavax.management.InvalidAttributeValueException
getTrustStoreName()
java.lang.String getKeyPassPhrase()
The encrypted identity passphrase.
When you get the value of this attribute, WebLogic Server does the following:
KeyPassPhraseEncrypted
attribute.When you set the value of this attribute, WebLogic Server does the following:
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
.
getKeyPassPhraseEncrypted()
void setKeyPassPhrase(java.lang.String passPhrase) throws javax.management.InvalidAttributeValueException
Sets the value of the KeyPassPhrase attribute.
passPhrase
- The new keyPassPhrase valuejavax.management.InvalidAttributeValueException
getKeyPassPhrase()
,
setKeyPassPhraseEncrypted(byte[])
byte[] getKeyPassPhraseEncrypted()
Returns encrypted identity pass phrase.
void setKeyPassPhraseEncrypted(byte[] passPhraseEncrypted)
Sets the encrypted value of the keyPassPhrase attribute.
passPhraseEncrypted
- The new encrypted keyPassPhrase valuegetKeyPassPhraseEncrypted()
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:
KeyStorePassPhraseEncrypted
attribute.When you set the value of this attribute, WebLogic Server does the following:
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
.
getKeyStorePassPhraseEncrypted()
void setKeyStorePassPhrase(java.lang.String passPhrase) throws javax.management.InvalidAttributeValueException
Sets the value of the KeyStorePassPhrase attribute.
passPhrase
- The new keyStorePassPhrase valuejavax.management.InvalidAttributeValueException
getKeyStorePassPhrase()
,
setKeyStorePassPhraseEncrypted(byte[])
byte[] getKeyStorePassPhraseEncrypted()
Returns encrypted pass phrase defined when creating the keystore.
void setKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)
Sets the encrypted value of the keyStorePassPhrase attribute.
passPhraseEncrypted
- The new encrypted keyStorePassPhrase valuegetKeyStorePassPhraseEncrypted()
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:
TrustStorePassPhraseEncrypted
attribute.When you set the value of this attribute, WebLogic Server does the following:
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
.
getTrustStorePassPhraseEncrypted()
void setTrustStorePassPhrase(java.lang.String passPhrase) throws javax.management.InvalidAttributeValueException
Sets the value of the TrustStorePassPhrase attribute.
passPhrase
- The new trustStorePassPhrase valuejavax.management.InvalidAttributeValueException
getTrustStorePassPhrase()
,
setTrustStorePassPhraseEncrypted(byte[])
byte[] getTrustStorePassPhraseEncrypted()
Returns encrypted pass phrase defined when creating the keystore.
void setTrustStorePassPhraseEncrypted(byte[] passPhraseEncrypted)
Sets the encrypted value of the TrustStorePassPhrase attribute.
passPhraseEncrypted
- The new encrypted trustStorePassPhrase valuegetTrustStorePassPhraseEncrypted()