View This Jolt Connection Pool Collection
/management/weblogic/{version}/serverConfig/joltConnectionPools
View this jolt connection pool collection.
Request
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.
-
Monitor: basic
Type:
basic
Description:A user in the Monitor security role.
-
Operator: basic
Type:
basic
Description:A user in the Operator security role.
Response
- application/json
200 Response
Returns a list of jolt connection pool entities.
object
-
applicationPassword(optional):
string(password)
The application password for this Jolt connection pool. (This is required only when the security level in the Tuxedo domain is
USER_AUTH
,ACL
orMANDATORY_ACL
).As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the
ApplicationPasswordEncrypted
attribute.Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
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
Constraints
- secure default : null
-
deploymentOrder(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:1000
A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.
For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.
Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
failoverAddresses(optional):
array Items
Title:
Items
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.
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
keyPassPhrase(optional):
string(password)
The encrypted identity passphrase.
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the
KeyPassPhraseEncrypted
attribute.Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
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
-
keyStoreName(optional):
string
The path and file name of the keystore containing the private key used in SSL mutual authentication.
-
keyStorePassPhrase(optional):
string(password)
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:
Retrieves the value of the
KeyStorePassPhraseEncrypted
attribute.Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
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
-
maximumPoolSize(optional):
integer(int32)
Minimum Value:
1
Maximum Value:2147483647
Default Value:1
The maximum number of connections that can be made from this Jolt connection pool.
-
minimumPoolSize(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:0
The minimum number of connections to be added to this Jolt connection pool when WebLogic Server starts.
-
name(optional):
string
Read Only:
true
The user-specified name of this MBean instance.
This name is included as one of the key properties in the MBean's
javax.management.ObjectName
Name=user-specified-name
Constraints
- legal null
-
notes(optional):
string
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration file (
config.xml
) as XML PCDATA. All left angle brackets (<) are converted to the xml entity<. Carriage returns/line feeds are preserved.)>
Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
-
primaryAddresses(optional):
array Items
Title:
Items
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. -
recvTimeout(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:0
The number of seconds the client waits to receive a response before timing out.
-
securityContextEnabled(optional):
boolean
Default Value:
false
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 callsimpersonate_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.
Constraints
- secure default : true
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
targets(optional):
array Target References
Title:
Target References
Contains the array of target references.You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
-
trustStoreName(optional):
string
The path and file name of the keystore containing the trust certificates.
-
trustStorePassPhrase(optional):
string(password)
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:
Retrieves the value of the
TrustStorePassPhraseEncrypted
attribute.Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
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
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
-
userName(optional):
string
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
.) -
userPassword(optional):
string(password)
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:
Retrieves the value of the
UserPasswordEncrypted
attribute.Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
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
-
userRole(optional):
string
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
, orMANDATORY_ACL
).
array
Items
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.
array
Items
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.
array
Target References
You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
-
Array of:
object Target Reference
Title:
Target Reference
Contains the target reference.
object
Target Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity