JoltConnectionPoolMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This bean defines a Jolt connection pool.

   
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.JoltConnectionPoolMBean
Factory Methods
Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


      Targets

      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.

             
      Privileges Read/Write
      TypeTargetMBean[]
      Relationship type: Reference.


      Attributes

      This section describes the following attributes:


      ApplicationPassword

      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.

      For more information, see:

                 
      Privileges Read/Write
      Security rolesRead access is granted only to the following roles:
      • Deployer
      Typejava.lang.String
      Encryptedtrue

      ApplicationPasswordEncrypted

      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.

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue

      CachingDisabled

      Private property that disables caching in proxies.

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      DeploymentOrder

      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.

             
      Privileges Read/Write
      Typeint
      Default Value1000
      Minimum value0
      Maximum value2147483647

      FailoverAddresses

      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.

             
      Privileges Read/Write
      Typeclass java.lang.String[]

      KeyPassPhrase

      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.

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String
      Encryptedtrue

      KeyPassPhraseEncrypted

      Returns encrypted identity pass phrase.

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue

      KeyStoreName

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

             
      Privileges Read/Write
      Typejava.lang.String

      KeyStorePassPhrase

      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.

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String
      Encryptedtrue

      KeyStorePassPhraseEncrypted

      Returns encrypted pass phrase defined when creating the keystore.

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue

      MaximumPoolSize

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

             
      Privileges Read/Write
      Typeint
      Default Value1
      Minimum value1
      Maximum value2147483647

      MBeanInfo

      Returns the MBean info for this MBean.

      Deprecated.

             
      Privileges Read only
      Typejavax.management.MBeanInfo
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      MinimumPoolSize

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

             
      Privileges Read/Write
      Typeint
      Default Value0
      Minimum value0
      Maximum value2147483647

      Name

      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

             
      Privileges Read/Write
      Typejava.lang.String

      Notes

      Optional information that you can include to describe this configuration.

      WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. 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.

             
      Privileges Read/Write
      Typejava.lang.String

      ObjectName

      Returns the ObjectName under which this MBean is registered in the MBean server.

      Deprecated.

             
      Privileges Read only
      Typeweblogic.management.WebLogicObjectName
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      PrimaryAddresses

      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.

             
      Privileges Read/Write
      Typeclass java.lang.String[]

      RecvTimeout

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

             
      Privileges Read/Write
      Typeint
      Default Value0
      Minimum value0
      Maximum value2147483647

      Registered

      Returns false if the the MBean represented by this object has been unregistered.

      Deprecated.

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SecurityContextEnabled

      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.

             
      Privileges Read/Write
      Typeboolean
      Secure valuetrue

      TrustStoreName

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

             
      Privileges Read/Write
      Typejava.lang.String

      TrustStorePassPhrase

      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.

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String
      Encryptedtrue

      TrustStorePassPhraseEncrypted

      Returns encrypted pass phrase defined when creating the keystore.

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue

      Type

      Returns the type of the MBean.

             
      Privileges Read only
      Typejava.lang.String
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      UserName

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

             
      Privileges Read/Write
      Typejava.lang.String

      UserPassword

      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.

      For more information, see:

                 
      Privileges Read/Write
      Security rolesRead access is granted only to the following roles:
      • Deployer
      Typejava.lang.String
      Encryptedtrue

      UserPasswordEncrypted

      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.

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue

      UserRole

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

             
      Privileges Read/Write
      Typejava.lang.String


      Operations

      This section describes the following operations:


      addFailoverAddress

      Adds a feature to the FailoverAddress attribute of the JoltConnectionPoolMBean object

         
      Operation Name"addFailoverAddress"
      ParametersObject [] {  address }

      where:

      • address is an object of type java.lang.String that specifies:

        The feature to be added to the FailoverAddress attribute

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException

      addPrimaryAddress

      Adds a feature to the PrimaryAddress attribute of the JoltConnectionPoolMBean object

         
      Operation Name"addPrimaryAddress"
      ParametersObject [] {  address }

      where:

      • address is an object of type java.lang.String that specifies:

        The feature to be added to the PrimaryAddress attribute

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException

      addTarget

      You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

         
      Operation Name"addTarget"
      ParametersObject [] {  target }

      where:

      • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

        The feature to be added to the Target attribute

      SignatureString [] { "weblogic.management.configuration.TargetMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      freezeCurrentValue

      If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

      Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

      Note:

      To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

      Deprecated. 9.0.0.0

         
      Operation Name"freezeCurrentValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException
      • javax.management.MBeanException

      isSet

      Returns true if the specified attribute has been set explicitly in this MBean instance.

         
      Operation Name"isSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to check

      SignatureString [] { "java.lang.String" }
      Returns boolean

      removeFailoverAddress

         
      Operation Name"removeFailoverAddress"
      ParametersObject [] {  address }

      where:

      • address is an object of type java.lang.String that specifies:

        address

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException

      removePrimaryAddress

         
      Operation Name"removePrimaryAddress"
      ParametersObject [] {  address }

      where:

      • address is an object of type java.lang.String that specifies:

        address

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException

      removeTarget

      Removes the value of the addTarget attribute.

      For more information, see:

         
      Operation Name"removeTarget"
      ParametersObject [] {  target }

      where:

      • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

        target

      SignatureString [] { "weblogic.management.configuration.TargetMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      restoreDefaultValue

      If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

      Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

      Deprecated. 9.0.0.0

         
      Operation Name"restoreDefaultValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException

      unSet

      Restore the given property to its default value.

         
      Operation Name"unSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to restore

      SignatureString [] { "java.lang.String" }
      Returns void