Package weblogic.management.runtime

Interface DomainKeystoresDomainRuntimeMBean

All Superinterfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface DomainKeystoresDomainRuntimeMBean
extends RuntimeMBean

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

Method Summary

Modifier and Type	Method	Description
void	addProvisionedIdentityCertificate(java.lang.String toAlias, java.lang.String fromFileName, java.lang.String fromFileType, java.lang.String fromFilePassphrase, java.lang.String fromAlias, java.lang.String fromAliasPassphrase)	Add a provisioned identity certificate to the domain.
void	addProvisionedIdentityCertificateAndKey(java.lang.String toAlias, java.lang.String certificateFileName, java.lang.String certificateFileType, java.lang.String privateKeyFileName, java.lang.String privateKeyFileType, java.lang.String privateKeyPassphrase)	Add a provisioned identity certificate and PKCS#8 private key from separate files.
void	addProvisionedTrustCertificate(java.lang.String toAlias, java.lang.String fromFileName, java.lang.String fromFileType, java.lang.String fromFilePassphrase, java.lang.String fromAlias)	Add one provisioned trust anchor to the domain.
void	addProvisionedTrustCertificates(java.lang.String aliasBase, java.lang.String fromFileName, java.lang.String fromFileType)	Add every X.509 certificate in a PEM bundle to the Provisioned Trust keystore.
void	exportDomainTrustCertificates(java.lang.String toFileName, java.lang.String toFileType, java.lang.String toFilePassphrase)	Export only the Domain Trust keystore.
void	exportProvisionedTrustCertificates(java.lang.String toFileName, java.lang.String toFileType, java.lang.String toFilePassphrase)	Export only the Provisioned Trust keystore.
void	exportTrustedCertificates(java.lang.String toFileName, java.lang.String toFileType, java.lang.String toFilePassphrase)	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.
X509CertificateInfoVBean[]	listDomainCaKeystore()	List the domain certificate authority's keystore.
X509CertificateInfoVBean[]	listDomainTrustKeystore()	List the domain certificate authority certificates trusted by the domain.
X509CertificateInfoVBean[]	listProvisionedIdentityKeystore()	List the provisioned identity certificates for the domain.
X509CertificateInfoVBean[]	listProvisionedTrustKeystore()	List the provisioned trust anchors for the domain.
void	removeProvisionedIdentityCertificate(java.lang.String alias)	Remove a provisioned identity certificate from the domain.
void	removeProvisionedTrustCertificate(java.lang.String alias)	Remove a provisioned trust anchor from the domain.

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

listDomainCaKeystore

X509CertificateInfoVBean[] listDomainCaKeystore()
                                         throws ManagementException

List the domain certificate authority's keystore.

Throws:

ManagementException

Access limited to the following security roles:

Operator

listDomainTrustKeystore

X509CertificateInfoVBean[] listDomainTrustKeystore()
                                            throws ManagementException

List the domain certificate authority certificates trusted by the domain.

Throws:

ManagementException

Access limited to the following security roles:

Operator

listProvisionedIdentityKeystore

X509CertificateInfoVBean[] listProvisionedIdentityKeystore()
                                                    throws ManagementException

List the provisioned identity certificates for the domain.

Throws:

ManagementException

Access limited to the following security roles:

Operator

addProvisionedIdentityCertificate

void addProvisionedIdentityCertificate(java.lang.String toAlias,
                                       java.lang.String fromFileName,
                                       java.lang.String fromFileType,
                                       java.lang.String fromFilePassphrase,
                                       java.lang.String fromAlias,
                                       java.lang.String fromAliasPassphrase)
                                throws ManagementException

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

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

Parameters:

toAlias - The alias to use for the new provisioned identity certificate

fromFileName - The name of the input file

fromFileType - The type of the input file

fromFilePassphrase - The passphrase for the input file (if needed)

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

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

Throws:

ManagementException

addProvisionedIdentityCertificateAndKey

void addProvisionedIdentityCertificateAndKey(java.lang.String toAlias,
                                             java.lang.String certificateFileName,
                                             java.lang.String certificateFileType,
                                             java.lang.String privateKeyFileName,
                                             java.lang.String privateKeyFileType,
                                             java.lang.String privateKeyPassphrase)
                                      throws ManagementException

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.

Parameters:

toAlias - The alias to use for the new provisioned identity certificate

certificateFileName - The name of the certificate or certificate-chain file

certificateFileType - The certificate file type, PEM or DER

privateKeyFileName - The name of the PKCS#8 private-key file

privateKeyFileType - The private-key file type, PEM or DER

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

Throws:

ManagementException

removeProvisionedIdentityCertificate

void removeProvisionedIdentityCertificate(java.lang.String alias)
                                   throws ManagementException

Remove a provisioned identity certificate from the domain.

Parameters:

alias - The alias of the provisioned identity certificate to remove

Throws:

ManagementException

listProvisionedTrustKeystore

X509CertificateInfoVBean[] listProvisionedTrustKeystore()
                                                 throws ManagementException

List the provisioned trust anchors for the domain.

Throws:

ManagementException

Access limited to the following security roles:

Operator

addProvisionedTrustCertificate

void addProvisionedTrustCertificate(java.lang.String toAlias,
                                    java.lang.String fromFileName,
                                    java.lang.String fromFileType,
                                    java.lang.String fromFilePassphrase,
                                    java.lang.String fromAlias)
                             throws ManagementException

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.

Parameters:

toAlias - The alias to use for the new provisioned trust anchor

fromFileName - The name of the input file

fromFileType - The type of the input file

fromFilePassphrase - The passphrase for the input file (if needed)

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

Throws:

ManagementException

addProvisionedTrustCertificates

void addProvisionedTrustCertificates(java.lang.String aliasBase,
                                     java.lang.String fromFileName,
                                     java.lang.String fromFileType)
                              throws ManagementException

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 provisioned-<base>-1, provisioned-<base>-2, and so on in file order. Duplicate aliases or certificates cause the entire operation to fail.

Parameters:

aliasBase - The base used to generate one-based provisioned aliases

fromFileName - The name of the PEM bundle

fromFileType - The input file type; only PEM is supported

Throws:

ManagementException

removeProvisionedTrustCertificate

void removeProvisionedTrustCertificate(java.lang.String alias)
                                throws ManagementException

Remove a provisioned trust anchor from the domain.

Parameters:

alias - The alias of the provisioned trust anchor to remove

Throws:

ManagementException

exportTrustedCertificates

void exportTrustedCertificates(java.lang.String toFileName,
                               java.lang.String toFileType,
                               java.lang.String toFilePassphrase)
                        throws ManagementException

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.

Parameters:

toFileName - The name of the output file

toFileType - The type of the output file

toFilePassphrase - The passphrase for the output file (if needed)

Throws:

ManagementException

exportDomainTrustCertificates

void exportDomainTrustCertificates(java.lang.String toFileName,
                                   java.lang.String toFileType,
                                   java.lang.String toFilePassphrase)
                            throws ManagementException

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.

Parameters:

toFileName - The name of the output file

toFileType - The type of the output file

toFilePassphrase - The passphrase for the output file (if needed)

Throws:

ManagementException

exportProvisionedTrustCertificates

void exportProvisionedTrustCertificates(java.lang.String toFileName,
                                        java.lang.String toFileType,
                                        java.lang.String toFilePassphrase)
                                 throws ManagementException

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.

Parameters:

toFileName - The name of the output file

toFileType - The type of the output file

toFilePassphrase - The passphrase for the output file (if needed)

Throws:

ManagementException