CertificateManagementMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Provides configuration for the WebLogic Certificate Management Service.

       
Since14.1.2.0.0
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.CertificateManagementMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:

    Related MBeans

    This section describes attributes that provide access to other MBeans.

      CertificateIssuerPlugins

      Returns the CertificateIssuerPlugins for this Domain.

                 
      Factory MethodscreateCertificateIssuerPlugin (java.lang.String name)

      destroyCertificateIssuerPlugin (CertificateIssuerPluginMBean certificateIssuerPluginMBean)

      Factory methods do not return objects.

      See Using factory methods.
      Lookup OperationlookupCertificateIssuerPlugin(String name)

      Returns a javax.management.ObjectName for the instance of CertificateIssuerPluginMBean named name.

      Privileges Read only
      TypeCertificateIssuerPluginMBean[]
      Relationship type: Containment.

      ConfigurationProperties

      Specifies the list of properties that are associated with this container object.

                 
      Factory MethodscreateConfigurationProperty (java.lang.String name)

      destroyConfigurationProperty (ConfigurationPropertyMBean wsc)

      Factory methods do not return objects.

      See Using factory methods.
      Lookup OperationlookupConfigurationProperty(String name)

      Returns a javax.management.ObjectName for the instance of ConfigurationPropertyMBean named name.

      Privileges Read only
      TypeConfigurationPropertyMBean[]
      Relationship type: Containment.

      Attributes

      This section describes the following attributes:

      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.

      CertificateAuthorityValidityPeriod

      Returns the validity period (certificate lifetime) that the Domain Certificates Issuer should set when generating a new Certificate Authority certificate. The validity period is expressed in days.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeint
      Default Value365
      Minimum value45
      Maximum value1825

      CertificateCheckInterval

      Returns the certificate check interval -- how often the Certificate Management Service should check for/refresh expiring certificates (in days).

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeint
      Default Value1
      Minimum value1
      Maximum value7

      CertificateRefreshWindow

      Returns the certificate refresh window. The Certificate Management Service will refresh an expiring certificate when its remaining lifetime is less than this number of days.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeint
      Default Value10
      Minimum value5
      Maximum value30

      CertificateValidityPeriod

      Returns the validity period (certificate lifetime) that the Domain Certificates Issuer should set when generating a new certificate. The validity period is expressed in days.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeint
      Default Value90
      Minimum value15
      Maximum value365

      DynamicallyCreated

      Return whether the MBean was created dynamically or is persisted to config.xml

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

      Enabled

      Returns true or false to indicate whether the Certificate Management Service is enabled or not.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeboolean

      Id

      Return the unique id of this MBean instance

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

      IncludeRootCertificateInChain

      Whether the Domain Certificates Issuer should include the self-signed root CA in the certificate chain for a generated certificate.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      JavaStandardTrustEnabled

      Whether or not the domain should trust the Java Standard Trust certificates, in addition to the Domain Certificate Authority certificate(s) and any Provisioned Trust certificates. Java Standard Trust is a collection of well-known, trusted root certificate authorities distributed (and updated) as part of the JDK.

      For more information, see:

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeboolean

      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.

      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 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 &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
      Security rolesWrite access is granted only to the following roles:
      • Deployer
      • Operator
      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

      ProvisionedCertificatesIssuerEnabled

      Returns true or false to indicate whether the Provisioned Certificates Issuer is enabled or not.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeboolean

      Registered

      Returns false if 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.

      SinglePurposeCertificatesEnabled

      Returns the single purpose certificates enabled value: whether the Domain Certificates Issuer should generate separate, single-purpose certificates for different purposes (server authentication, client authentication, signing and encryption), or generate one certificate that supports all those purposes.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typeboolean
      Secure valuetrue

      SubjectAlternativeNames

      A space- or comma-separated list of words representing the Subject Alternative Names that the Domain Certificates Issuer should include when generating a server certificate.

      Each word must be one of the subject name constants defined by the CertificateConfigurationConstants interface. When generating a certificate, the Certificate Management Service replaces each constant with the corresponding value(s) obtained from the target server's configuration or the host it's running on.

      The certificate's CN attribute will be included as a Subject Alternative Name even if it is not explicitly configured here.

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typejava.lang.String
      Default Valuehostname, address, loopback, listen_address_all, virtual_host_all

      SubjectCommonName

      The name the Domain Certificates Issuer should use for the CN attribute of a certificate's Subject: either the local hostname (hostname) or the server's listen address (listen_address).

      If no listen address is configured for the server, hostname will be used instead, regardless of the value set here.

      The CN value will also be added as a Subject Alternative Name (even if it is not explicitly configured as a Subject Alternative Name).

             
      Available Since Release 14.1.2.0.0
      Privileges Read/Write
      Typejava.lang.String
      Default Valuehostname
      Legal Values
      • hostname
      • listen_address

      Tags

      Return all tags on this Configuration MBean

             
      Available Since Release 12.2.1.0.0
      Privileges Read/Write
      Typeclass java.lang.String[]

      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.

      Operations

      This section describes the following operations:

      addTag

      Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

         
      Operation Name"addTag"
      ParametersObject [] {  tag }

      where:

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

        tag to be added to the MBean
      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      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:

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

      getInheritedProperties

      Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

         
      Operation Name"getInheritedProperties"
      ParametersObject [] {  propertyNames }

      where:

      • propertyNames is an object of type [Ljava.lang.String; that specifies:

        properties to check
      SignatureString [] { "[Ljava.lang.String;" }
      Returns class

      isInherited

      Check if the value of a property is inherited from template mbean or not.

         
      Operation Name"isInherited"
      ParametersObject [] {  propertyName }

      where:

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

        the name of the property
      SignatureString [] { "java.lang.String" }
      Returns boolean

      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

      removeTag

      Remove a tag from this Configuration MBean

         
      Operation Name"removeTag"
      ParametersObject [] {  tag }

      where:

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

        tag to be removed from the MBean
      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      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:

      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