|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JoltConnectionPoolMBean
This bean defines a Jolt connection pool.
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 | |
---|---|
abstract boolean |
addFailoverAddress(String address) Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object |
abstract boolean |
addPrimaryAddress(String address) Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object |
abstract String |
getApplicationPassword() The application password for this Jolt connection pool. |
abstract byte[] |
getApplicationPasswordEncrypted() The encrypted application password for this connection pool. |
abstract 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. |
abstract String |
getKeyPassPhrase() The encrypted identity passphrase. |
abstract byte[] |
getKeyPassPhraseEncrypted() Returns encrypted identity pass phrase. |
abstract String |
getKeyStoreName() The path and file name of the keystore containing the private key used in SSL mutual authentication. |
abstract String |
getKeyStorePassPhrase() The encrypted identity keystore's passphrase. |
abstract byte[] |
getKeyStorePassPhraseEncrypted() Returns encrypted pass phrase defined when creating the keystore. |
abstract int |
getMaximumPoolSize() The maximum number of connections that can be made from this Jolt connection pool. |
abstract int |
getMinimumPoolSize() The minimum number of connections to be added to this Jolt connection pool when WebLogic Server starts. |
abstract String[] |
getPrimaryAddresses() The list of addresses for the primary Jolt Server Listeners (JSLs) on the Tuxedo system. |
abstract int |
getRecvTimeout() The number of seconds the client waits to receive a response before timing out. |
abstract String |
getTrustStoreName() The path and file name of the keystore containing the trust certificates. |
abstract String |
getTrustStorePassPhrase() The encrypted trust keystore's passphrase. |
abstract byte[] |
getTrustStorePassPhraseEncrypted() Returns encrypted pass phrase defined when creating the keystore. |
abstract String |
getUserName() A user name that applications specify to connect to this Jolt connection pool. |
abstract String |
getUserPassword() The user password for this Jolt connection pool. |
abstract byte[] |
getUserPasswordEncrypted() The user password for this connection pool. |
abstract String |
getUserRole() The Tuxedo user role for this Jolt connection pool. |
abstract 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. |
abstract boolean |
removeFailoverAddress(String address) |
abstract boolean |
removePrimaryAddress(String address) |
abstract void |
setApplicationPassword(String password) Sets the value of the ApplicationPassword attribute. |
abstract void |
setApplicationPasswordEncrypted(byte[] bytes) Encrypts the password and sets the value of the ApplicationPasswordEncrypted attribute. |
abstract void |
setFailoverAddresses(String[] args) Sets the value of the FailoverAddresses attribute. |
abstract void |
setKeyPassPhrase(String passPhrase) Sets the value of the KeyPassPhrase attribute. |
abstract void |
setKeyPassPhraseEncrypted(byte[] passPhraseEncrypted) Sets the encrypted value of the keyPassPhrase attribute. |
abstract void |
setKeyStoreName(String keyStoreName) Sets the path and file name of the keystore containing the private key used in SSL mutual authentication. |
abstract void |
setKeyStorePassPhrase(String passPhrase) Sets the value of the KeyStorePassPhrase attribute. |
abstract void |
setKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted) Sets the encrypted value of the keyStorePassPhrase attribute. |
abstract void |
setMaximumPoolSize(int size) Sets the value of the MaximumPoolSize attribute. |
abstract void |
setMinimumPoolSize(int size) Sets the value of the MinimumPoolSize attribute. |
abstract void |
setPrimaryAddresses(String[] args) Sets the value of the PrimaryAddresses attribute. |
abstract void |
setRecvTimeout(int secs) Sets the value of the RecvTimeout attribute. |
abstract void |
setSecurityContextEnabled(boolean on) Sets the value of the SecurityContextEnabled attribute. |
abstract void |
setTrustStoreName(String keyStoreName) Sets the path and file name of the keystore containing the trust certificates. |
abstract void |
setTrustStorePassPhrase(String passPhrase) Sets the value of the TrustStorePassPhrase attribute. |
abstract void |
setTrustStorePassPhraseEncrypted(byte[] passPhraseEncrypted) Sets the encrypted value of the TrustStorePassPhrase attribute. |
abstract void |
setUserName(String name) Sets the value of the UserName attribute. |
abstract void |
setUserPassword(String password) Sets the value of the UserPassword attribute. |
abstract void |
setUserPasswordEncrypted(byte[] bytes) Encrypts the user password and sets the value of the UserPasswordEncrypted attribute. |
abstract 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, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, 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 |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Method Detail |
---|
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(String[] args) throws InvalidAttributeValueException
Sets the value of the PrimaryAddresses attribute.
args
- The new primaryAddresses valueInvalidAttributeValueException
JoltConnectionPoolMBean.getPrimaryAddresses()
boolean addPrimaryAddress(String address) throws InvalidAttributeValueException
Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object
address
- The feature to be added to the PrimaryAddress attributeInvalidAttributeValueException
boolean removePrimaryAddress(String address) throws InvalidAttributeValueException
address
-InvalidAttributeValueException
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(String[] args) throws InvalidAttributeValueException
Sets the value of the FailoverAddresses attribute.
args
- The new failoverAddresses valueInvalidAttributeValueException
JoltConnectionPoolMBean.getFailoverAddresses()
boolean addFailoverAddress(String address) throws InvalidAttributeValueException
Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object
address
- The feature to be added to the FailoverAddress attributeInvalidAttributeValueException
boolean removeFailoverAddress(String address) throws InvalidAttributeValueException
address
-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 InvalidAttributeValueException
Sets the value of the MinimumPoolSize attribute.
size
- The new minimumPoolSize valueInvalidAttributeValueException
JoltConnectionPoolMBean.getMinimumPoolSize()
int getMaximumPoolSize()
The maximum number of connections that can be made from this Jolt connection pool.
void setMaximumPoolSize(int size) throws InvalidAttributeValueException
Sets the value of the MaximumPoolSize attribute.
size
- The new maximumPoolSize valueInvalidAttributeValueException
JoltConnectionPoolMBean.getMaximumPoolSize()
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(String name) throws InvalidAttributeValueException
Sets the value of the UserName attribute.
name
- The new userName valueInvalidAttributeValueException
JoltConnectionPoolMBean.getUserName()
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
.
JoltConnectionPoolMBean.getUserPasswordEncrypted()
void setUserPassword(String password) throws InvalidAttributeValueException
Sets the value of the UserPassword attribute.
password
- The new userPassword valueInvalidAttributeValueException
JoltConnectionPoolMBean.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 InvalidAttributeValueException
Encrypts the user password and sets the value of the UserPasswordEncrypted attribute.
bytes
- The new userPassword value as a byte arrayInvalidAttributeValueException
JoltConnectionPoolMBean.getUserPasswordEncrypted()
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
.
JoltConnectionPoolMBean.getApplicationPasswordEncrypted()
void setApplicationPassword(String password) throws InvalidAttributeValueException
Sets the value of the ApplicationPassword attribute.
password
- The new applicationPassword valueInvalidAttributeValueException
JoltConnectionPoolMBean.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 InvalidAttributeValueException
Encrypts the password and sets the value of the ApplicationPasswordEncrypted attribute.
bytes
- The new applicationPassword value as a byte arrayInvalidAttributeValueException
JoltConnectionPoolMBean.getApplicationPasswordEncrypted()
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(String role) throws InvalidAttributeValueException
Sets the value of the UserRole attribute.
role
- The new userRole valueInvalidAttributeValueException
JoltConnectionPoolMBean.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 InvalidAttributeValueException
Sets the value of the SecurityContextEnabled attribute.
on
- The new securityContextEnabled valueInvalidAttributeValueException
JoltConnectionPoolMBean.isSecurityContextEnabled()
int getRecvTimeout()
The number of seconds the client waits to receive a response before timing out.
void setRecvTimeout(int secs) throws InvalidAttributeValueException
Sets the value of the RecvTimeout attribute.
secs
- The new recvTimeout valueInvalidAttributeValueException
JoltConnectionPoolMBean.getRecvTimeout()
String getKeyStoreName()
The path and file name of the keystore containing the private key used in SSL mutual authentication.
void setKeyStoreName(String keyStoreName) throws InvalidAttributeValueException
Sets the path and file name of the keystore containing the private key used in SSL mutual authentication.
keyStoreName
- The new keyStoreName valueInvalidAttributeValueException
JoltConnectionPoolMBean.getKeyStoreName()
String getTrustStoreName()
The path and file name of the keystore containing the trust certificates.
void setTrustStoreName(String keyStoreName) throws InvalidAttributeValueException
Sets the path and file name of the keystore containing the trust certificates.
keyStoreName
- The new trustStoreName valueInvalidAttributeValueException
JoltConnectionPoolMBean.getTrustStoreName()
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
.
JoltConnectionPoolMBean.getKeyPassPhraseEncrypted()
void setKeyPassPhrase(String passPhrase) throws InvalidAttributeValueException
Sets the value of the KeyPassPhrase attribute.
passPhrase
- The new keyPassPhrase valueInvalidAttributeValueException
JoltConnectionPoolMBean.getKeyPassPhrase()
, JoltConnectionPoolMBean.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 valueJoltConnectionPoolMBean.getKeyPassPhraseEncrypted()
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
.
JoltConnectionPoolMBean.getKeyStorePassPhraseEncrypted()
void setKeyStorePassPhrase(String passPhrase) throws InvalidAttributeValueException
Sets the value of the KeyStorePassPhrase attribute.
passPhrase
- The new keyStorePassPhrase valueInvalidAttributeValueException
JoltConnectionPoolMBean.getKeyStorePassPhrase()
, JoltConnectionPoolMBean.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 valueJoltConnectionPoolMBean.getKeyStorePassPhraseEncrypted()
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
.
JoltConnectionPoolMBean.getTrustStorePassPhraseEncrypted()
void setTrustStorePassPhrase(String passPhrase) throws InvalidAttributeValueException
Sets the value of the TrustStorePassPhrase attribute.
passPhrase
- The new trustStorePassPhrase valueInvalidAttributeValueException
JoltConnectionPoolMBean.getTrustStorePassPhrase()
, JoltConnectionPoolMBean.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 valueJoltConnectionPoolMBean.getTrustStorePassPhraseEncrypted()
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |