weblogic.security.providers.utils
Interface CertRegManagerMBean

All Superinterfaces:

ExportMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean

All Known Subinterfaces:

CertificateRegistryMBean, SAMLIdentityAsserterMBean

public interface CertRegManagerMBean
extends ProviderMBean, ImportMBean, ExportMBean, NameListerMBean

The CertRegManager is used manage a certificate registry that is stored in the embedded LDAP server. This is utility code that is shared by the CertificateRegistry and SAML.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

getSupportedImportFormats

String[] getSupportedImportFormats()

A certificate registry imports trusted CAs from a JKS keystore.

Specified by:

getSupportedImportFormats in interface ImportMBean

Default Value:

"JKS KeyStore"

getSupportedImportConstraints

String[] getSupportedImportConstraints()

A certificate registry always imports all the certificates in a keystore (identities and trusted CAs) thus does not support export constraints.

Specified by:

getSupportedImportConstraints in interface ImportMBean

Default Value:

""

getSupportedExportFormats

String[] getSupportedExportFormats()

A certificate registry exports trusted CAs to a JKS keystore. The keystore must not already exist.

Specified by:

getSupportedExportFormats in interface ExportMBean

Default Value:

"JKS KeyStore"

getSupportedExportConstraints

String[] getSupportedExportConstraints()

A certificate registry always exports all the certificates in the registry thus does not support export constraints.

Specified by:

getSupportedExportConstraints in interface ExportMBean

Default Value:

""

registerCertificate

void registerCertificate(String alias,
                         String certificateFile)
                         throws AlreadyExistsException,
                                InvalidParameterException

Registers an end certificate in the registry under an alias.

Throws InvalidParameterException if the alias or certificateFile is empty or null or if the file does not exist or cannot be read.

Parameters:

alias - - The alias to register the certificate under. It must not be empty or null. Aliases are case-insensitive.

certificateFile - - The pathname (relative to the directory the admin server is booted from) of a PEM or DER file containing the certificate to be registered.

Throws:

weblogic.management.utils.AlreadyExistsException

weblogic.management.utils.InvalidParameterException

unregisterCertificate

void unregisterCertificate(String alias)
                           throws NotFoundException,
                                  InvalidParameterException

Unregisters an end certificate from the registry.

Throws InvalidParameterException if alias is empty or null.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

listAliases

String listAliases(String aliasWildcard,
                   int maxToReturn)
                   throws InvalidCursorException,
                          InvalidParameterException

Lists the registered aliases that match a wild card.

Returns a String containing a cursor that may be passed into the NameListerMBean methods to read the list. The getCurrentName method returns the current alias on the list.

Parameters:

aliasWildcard - - A wild card used to select aliases. It supports three formats: "*" matches all aliases. "foo*" matches all aliases starting with the string "foo". "foo" matches the alias "foo" only. The matches are case-insensitive.

maxToReturn - - The maximum number of aliases this method may return. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort the results. Set this parameter to zero to return all matching aliases.

Throws:

weblogic.management.utils.InvalidCursorException

weblogic.management.utils.InvalidParameterException

getCertificate

X509Certificate getCertificate(String alias)
                               throws NotFoundException,
                                      InvalidParameterException

Retrieves a certificate from the registry.

Throws NotFoundException if alias does not exist in the registry.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

aliasExists

boolean aliasExists(String alias)
                    throws InvalidParameterException

Determines whether or not an alias exists in the registry.

Throws InvalidParameterException if alias is empty or null.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

Throws:

weblogic.management.utils.InvalidParameterException

copyToPEM

void copyToPEM(String alias,
               String certificateFile)
               throws NotFoundException,
                      InvalidParameterException

writes a certificate in the registry to a file in PEM base64 encoded format.

Throws InvalidParameterException if alias or certificateFile is empty or null or if the file cannot be written to.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

certificateFile - - The pathname (relative to the directory the admin server is booted from) of the file to write the certificate to.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

copyToDER

void copyToDER(String alias,
               String certificateFile)
               throws NotFoundException,
                      InvalidParameterException

writes a certificate in the registry to a file in DER binary format.

Throws InvalidParameterException if alias or certificateFile is empty or null or if the file cannot be written to.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

certificateFile - - The pathname (relative to the directory the admin server is booted from) of the file to write the certificate to.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

getName

String getName()

Description copied from interface: ProviderMBean

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

Specified by:

getName in interface ProviderMBean

Default Value:

"CertRegManager"