weblogic.security.providers.pk
Interface GroupCertRegManagerMBean

All Superinterfaces:

ExportMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean

All Known Subinterfaces:

CertificateRegistryMBean

public interface GroupCertRegManagerMBean
extends ProviderMBean, ImportMBean, ExportMBean, NameListerMBean

The GroupCertRegManager is used to manage a certificate trust group in the certificate registry that is stored in the embedded LDAP server.

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.

registerCertificate

void registerCertificate(String[] trustGroups,
                         String alias,
                         String certificateFile)
                         throws weblogic.management.utils.ErrorCollectionException,
                                weblogic.management.utils.InvalidParameterException

Registers an end certificate from a file in to a list of trust group under an alias.

Throws ErrorCollectionException containing any errors when register the certificate to a trust group.However, the certificate is registered to other trust group.

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

Parameters:

trustGroups - - The trust groups to register the certificate under. It must not be empty or null. Trust groups are case-insensitive.

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.ErrorCollectionException

weblogic.management.utils.InvalidParameterException

addCertificateToTrustGroups

void addCertificateToTrustGroups(String[] trustGroups,
                                 String alias)
                                 throws weblogic.management.utils.NotFoundException,
                                        weblogic.management.utils.ErrorCollectionException,
                                        weblogic.management.utils.InvalidParameterException

Add an already registered end certificate to list of trust groups.

Throws ErrorCollectionException containing any errors when register the certificate to a single trust group.

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

Throws NotFoundException when the given alias does not exist in the registry.

Parameters:

trustGroups - - The trust groups to register the certificate under. It must not be empty or null. Trust groups are case-insensitive.

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

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.ErrorCollectionException

weblogic.management.utils.InvalidParameterException

unregisterCertificate

void unregisterCertificate(String[] trustGroups,
                           String alias)
                           throws weblogic.management.utils.ErrorCollectionException,
                                  weblogic.management.utils.InvalidParameterException

Unregisters an end certificate from trust groups.

Throws InvalidParameterException if alias is empty or null or the given trust groups is empty or null.

Throws ErrorCollectionException if the alias does not found in any of the trust group given. However, the certificate is unregistered from other trust groups.

Parameters:

trustGroups - - The trust group to register the certificate under. It must not be empty or null. Trust Groups are case-insensitive.

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

Throws:

weblogic.management.utils.ErrorCollectionException

weblogic.management.utils.InvalidParameterException

removeCertificate

void removeCertificate(String alias)
                       throws weblogic.management.utils.NotFoundException,
                              weblogic.management.utils.InvalidParameterException

Remove an end certificate from the registry which means it is also unregistered from trust groups (if any).

Throws InvalidParameterException if alias is empty or null.

Throws NotFoundException if the alias does not found 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

createTrustGroup

void createTrustGroup(String TrustGroup)
                      throws weblogic.management.utils.AlreadyExistsException,
                             weblogic.management.utils.InvalidParameterException

Create an empty trust group in the registry.

Throws AlreadyExistsException if the trust group already registered to the registry.

Throws InvalidParameterException if the trust group is empty or null.

Parameters:

TrustGroup - - The trust group to register the certificate under. It must not be empty or null. Trust groups are case-insensitive.

Throws:

weblogic.management.utils.AlreadyExistsException

weblogic.management.utils.InvalidParameterException

removeTrustGroup

void removeTrustGroup(String trustGroup)
                      throws weblogic.management.utils.NotFoundException,
                             weblogic.management.utils.InvalidParameterException

Remove an trust group from the registry.

Throws NotFoundException if the trust group does not exist in the registry.

Throws InvalidParameterException if the trust group is empty or null.

Parameters:

trustGroup - - The trust group to unregister the certificate under. It must not be empty or null. Trust groups are case-insensitive.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

listTrustGroups

String listTrustGroups(String trustGroupWildcard,
                       int maxToReturn)
                       throws weblogic.management.utils.InvalidCursorException,
                              weblogic.management.utils.InvalidParameterException

Lists the registered trust groups 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 trust group on the list.

Throws InvalidCursorException.

Throws InvalidParameterException if the trust group is empty or null.

Parameters:

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

maxToReturn - - The maximum number of trust groups 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 trust groups.

Throws:

weblogic.management.utils.InvalidCursorException

weblogic.management.utils.InvalidParameterException

listAliasesByTrustGroup

String listAliasesByTrustGroup(String trustGroup,
                               String aliasWildcard,
                               int maxToReturn)
                               throws weblogic.management.utils.InvalidCursorException,
                                      weblogic.management.utils.InvalidParameterException

Lists the registered aliases that match a wild card in a given trust group.

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.

Throws InvalidCursorException.

Throws InvalidParameterException if the trust group or wild card is empty or null.

Parameters:

trustGroup - - The trust group to list certificates under. It must not be empty or null. Trust groups are case-insensitive.

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

trustGroupExists

boolean trustGroupExists(String trustGroup)
                         throws weblogic.management.utils.InvalidParameterException

Determines whether or not a trust group exists in the registry.

Return true if the trust group exists in the registry otherwise return false.

Throws InvalidParameterException if the trust group is empty or null.

Parameters:

trustGroup - - The trustGroup is registered. It must not be empty or null. Trust groups are case-insensitive.

Throws:

weblogic.management.utils.InvalidParameterException

getCertificate

X509Certificate getCertificate(String trustGroup,
                               String alias)
                               throws weblogic.management.utils.NotFoundException,
                                      weblogic.management.utils.InvalidParameterException

Retrieves a certificate from the registry.

Throws NotFoundException if alias does not exist in the registry.

Throws InvalidParameterException if the alias or trust group is null or empty.

Parameters:

trustGroup - - The trustgroup to get certificate under. It must not be empty or null. Trust Groups are case-insensitive.

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

getTrustGroups

String[] getTrustGroups(String alias)
                        throws weblogic.management.utils.InvalidParameterException

Retrieves all the trust groups that has a given alias registered under.

Throws NotFoundException if alias does not exist in the registry.

Throws InvalidParameterException if the alias is null or empty.

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

aliasExists

boolean aliasExists(String trustGroup,
                    String alias)
                    throws weblogic.management.utils.InvalidParameterException

Determines whether or not an alias exists in a trust group.

Return true if the alias exists in the trust group otherwise return false.

Throws InvalidParameterException if the alias or trust group is empty or null.

Parameters:

trustGroup - - The trust group to the certificate is registered under. It must not be empty or null. Trustg roups are case-insensitive.

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

Throws:

weblogic.management.utils.InvalidParameterException

isAliasRegistered

boolean isAliasRegistered(String alias)
                          throws weblogic.management.utils.InvalidParameterException

Determines whether or not an alias was registered in the registry.

Return true if the alias exists in the registry otherwise return false.

Throws InvalidParameterException if the 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 trustGroup,
               String alias,
               String certificateFile)
               throws weblogic.management.utils.NotFoundException,
                      weblogic.management.utils.InvalidParameterException

writes a certificate in a trust group to a file in PEM base64 encoded format.

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

Throws NotFoundException if the certificate does not exist in the trust group

Parameters:

trustGroup - - The trust group to the certificate is registered under. It must not be empty or null. Trust groups are case-insensitive.

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 trustGroup,
               String alias,
               String certificateFile)
               throws weblogic.management.utils.NotFoundException,
                      weblogic.management.utils.InvalidParameterException

writes a certificate in a trust group to a file in DER binary format.

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

Throws NotFoundException if the certificate does not exist in the trust group

Parameters:

trustGroup - - The trust group to the certificate is registered under. It must not be empty or null. Trust Groups are case-insensitive.

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

copyToJKS

void copyToJKS(String trustGroup,
               String JKSFile)
               throws weblogic.management.utils.NotFoundException,
                      weblogic.management.utils.InvalidParameterException,
                      weblogic.management.utils.ErrorCollectionException

writes all certificates in a trust group to a JKS.

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

Throws NotFoundException if the trust group does not exist in the registry.

Throws ErrorCollectionException if errors happen when write any certificate to the JKS file.

Parameters:

trustGroup - - The trustgroup to the certificate was registered under. It must not be empty or null. Trust Groups are case-insensitive.

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

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

weblogic.management.utils.ErrorCollectionException

copyFromJKS

void copyFromJKS(String trustGroup,
                 String certificateFile)
                 throws weblogic.management.utils.NotFoundException,
                        weblogic.management.utils.InvalidParameterException,
                        weblogic.management.utils.ErrorCollectionException

Register all certificates contained in a JKS file to a trust group.

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

Throws NotFoundException if the trust group does not exist in the registry.

Throws ErrorCollectionException if errors happen when register any certificate to the group.

Parameters:

trustGroup - - The trust group to the certificate is registered under. It must not be empty or null. Trust Groups 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

weblogic.management.utils.ErrorCollectionException

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:

"GroupCertRegManager"