CoherenceKeystoreParamsBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Information needed to access key material for Coherence Identity from the keystore.

       
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.coherence.descriptor.wl.CoherenceKeystoreParamsBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Attributes

    This section describes the following attributes:


    CoherenceClientAuth

    The client auth mode to use.

           
    Privileges Read/Write
    Typejava.lang.String
    Legal Values
    • none
    • required
    • wanted

    CoherenceIdentityAlias

    The string alias used to store and retrieve the Coherence Identity private key in the keystore. This private key is associated with the Coherence Identity digital certificate. If this alias is null, the Server SSL identity alias will be used.

           
    Privileges Read/Write
    Typejava.lang.String

    CoherenceKeyRefreshPeriod

    The period to use to attempt to refresh keys and certs. This is used in cases where keys or certs have a short lifetime and need to be refreshed at runtime.

    If this element is omitted or is set to a value less than or equal to zero, then keys and certs will not be refreshed.

    The value of this element must be in the following format: (\d)+((.)(\d)+)?(MS|ms|S|s|M|m|H|h|D|d)? where the first non-digits (from left to right) indicate the unit of time duration:

    If the value does not contain a unit, a unit of seconds is assumed. For example, the value of "2h" is 2 hours.

           
    Privileges Read/Write
    Typejava.lang.String

    CoherencePrivateKeyPassPhrase

    The passphrase used to retrieve the private key for the Coherence Identity specified in the server configured keystore. This passphrase is assigned to the private key when the private key is generated.

    Note that when you get the value of this attribute, WebLogic Server does the following:

    1. Retrieves the value of the CoherencePrivateKeyPassPhrase attribute.

    2. Decrypts the value and returns the unencrypted passphrase.

    For more information, see:

           
    Privileges Read/Write
    Typejava.lang.String
    Encryptedtrue

    CoherencePrivateKeyPassPhraseEncrypted

    The encrypted value of the passphrase.

           
    Privileges Read/Write
    Typebyte[]
    Encryptedtrue


    Operations

    This section describes the following operations:


      isSet

      Return true if the given property has been explicitly set in this bean.

         
      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
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if propertyName is not a recognized property

      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
      Exceptions
      • java.lang.IllegalArgumentException
        UnsupportedOperationException if called on a runtime implementation.