DomainKeystoresDomainRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean is used to manage a domain's Domain Keystores.

       
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.runtime.DomainKeystoresDomainRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
    Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:


    Attributes

    This section describes the following attributes:


    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    Name

    The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

           
    Privileges Read only
    Typejava.lang.String

    ObjectName

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

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Registered

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

    Deprecated.

           
    Privileges Read only
    Typeboolean

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String


    Operations

    This section describes the following operations:


    addProvisionedIdentityCertificate

    Add a provisioned identity certificate to the domain. JKS and PKCS12 inputs use {@code fromAlias} and {@code fromAliasPassphrase}. A PEM input contains one PKCS#8 private key, the matching leaf certificate, and an optional certificate chain; {@code fromAlias} and {@code fromAliasPassphrase} are ignored for PEM input and {@code fromFilePassphrase} decrypts an encrypted PKCS#8 key.

    Remote callers must use an encrypted management transport such as T3S or HTTPS.

       
    Operation Name"addProvisionedIdentityCertificate"
    ParametersObject [] {  toAlias, fromFileName, fromFileType, fromFilePassphrase, fromAlias, fromAliasPassphrase }

    where:

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

      The alias to use for the new provisioned identity certificate

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

      The name of the input file

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

      The type of the input file

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

      The passphrase for the input file (if needed)

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

      The alias of the entry in the input file (if needed)

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

      The passphrase for the entry in the input file (if needed)

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    addProvisionedIdentityCertificateAndKey

    Add a provisioned identity certificate and PKCS#8 private key from separate files. Supported combinations are PEM certificate chain with a PEM private key, DER leaf certificate with a DER private key, and PEM certificate chain with a DER private key. The private key may be unencrypted or encrypted.

    Remote callers must use an encrypted management transport such as T3S or HTTPS.

       
    Operation Name"addProvisionedIdentityCertificateAndKey"
    ParametersObject [] {  toAlias, certificateFileName, certificateFileType, privateKeyFileName, privateKeyFileType, privateKeyPassphrase }

    where:

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

      The alias to use for the new provisioned identity certificate

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

      The name of the certificate or certificate-chain file

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

      The certificate file type, PEM or DER

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

      The name of the PKCS#8 private-key file

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

      The private-key file type, PEM or DER

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

      The private-key passphrase, or null/empty for an unencrypted key

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    addProvisionedTrustCertificate

    Add one provisioned trust anchor to the domain. For PEM input, only the first certificate is imported when the file contains additional certificates. Use addProvisionedTrustCertificates(String, String, String) to import every certificate in a PEM bundle. DER input contains one X.509 certificate.

    Remote callers must use an encrypted management transport such as T3S or HTTPS.

       
    Operation Name"addProvisionedTrustCertificate"
    ParametersObject [] {  toAlias, fromFileName, fromFileType, fromFilePassphrase, fromAlias }

    where:

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

      The alias to use for the new provisioned trust anchor

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

      The name of the input file

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

      The type of the input file

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

      The passphrase for the input file (if needed)

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

      The alias of the entry in the input file (if needed)

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    addProvisionedTrustCertificates

    Add every X.509 certificate in a PEM bundle to the Provisioned Trust keystore. The complete bundle is validated before it is persisted. Generated aliases are {@code provisioned-<base>-1}, {@code provisioned-<base>-2}, and so on in file order. Duplicate aliases or certificates cause the entire operation to fail.

       
    Operation Name"addProvisionedTrustCertificates"
    ParametersObject [] {  aliasBase, fromFileName, fromFileType }

    where:

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

      The base used to generate one-based provisioned aliases

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

      The name of the PEM bundle

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

      The input file type; only PEM is supported

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    exportDomainTrustCertificates

    Export only the Domain Trust keystore. Supported output types are PEM, JKS, and PKCS12. DER export is not supported.

    Remote callers must use an encrypted management transport such as T3S or HTTPS.

       
    Operation Name"exportDomainTrustCertificates"
    ParametersObject [] {  toFileName, toFileType, toFilePassphrase }

    where:

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

      The name of the output file

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

      The type of the output file

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

      The passphrase for the output file (if needed)

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    exportProvisionedTrustCertificates

    Export only the Provisioned Trust keystore. Supported output types are PEM, JKS, and PKCS12. DER export is not supported.

    Remote callers must use an encrypted management transport such as T3S or HTTPS.

       
    Operation Name"exportProvisionedTrustCertificates"
    ParametersObject [] {  toFileName, toFileType, toFilePassphrase }

    where:

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

      The name of the output file

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

      The type of the output file

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

      The passphrase for the output file (if needed)

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    exportTrustedCertificates

    Export the certificates trusted by the domain; that is, the contents of the "Domain Trust" keystore combined with the contents of the "Provisioned Trust" keystore.

       
    Operation Name"exportTrustedCertificates"
    ParametersObject [] {  toFileName, toFileType, toFilePassphrase }

    where:

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

      The name of the output file

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

      The type of the output file

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

      The passphrase for the output file (if needed)

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    listDomainCaKeystore

    List the domain certificate authority's keystore.

           
    Operation Name"listDomainCaKeystore"
    Parametersnull
    Signaturenull
    Returns class
    Exceptions
    • weblogic.management.ManagementException
    Security roles Only the following roles can invoke this operation:
    • Operator

    listDomainTrustKeystore

    List the domain certificate authority certificates trusted by the domain.

           
    Operation Name"listDomainTrustKeystore"
    Parametersnull
    Signaturenull
    Returns class
    Exceptions
    • weblogic.management.ManagementException
    Security roles Only the following roles can invoke this operation:
    • Operator

    listProvisionedIdentityKeystore

    List the provisioned identity certificates for the domain.

           
    Operation Name"listProvisionedIdentityKeystore"
    Parametersnull
    Signaturenull
    Returns class
    Exceptions
    • weblogic.management.ManagementException
    Security roles Only the following roles can invoke this operation:
    • Operator

    listProvisionedTrustKeystore

    List the provisioned trust anchors for the domain.

           
    Operation Name"listProvisionedTrustKeystore"
    Parametersnull
    Signaturenull
    Returns class
    Exceptions
    • weblogic.management.ManagementException
    Security roles Only the following roles can invoke this operation:
    • Operator

    removeProvisionedIdentityCertificate

    Remove a provisioned identity certificate from the domain.

       
    Operation Name"removeProvisionedIdentityCertificate"
    ParametersObject [] {  alias }

    where:

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

      The alias of the provisioned identity certificate to remove

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    removeProvisionedTrustCertificate

    Remove a provisioned trust anchor from the domain.

       
    Operation Name"removeProvisionedTrustCertificate"
    ParametersObject [] {  alias }

    where:

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

      The alias of the provisioned trust anchor to remove

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException