weblogic.security.providers.saml.registry
Interface SAMLPartnerRegistryMBean

All Superinterfaces:

ExportMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean

All Known Subinterfaces:

SAMLAssertingPartyRegistryMBean, SAMLCredentialMapperV2MBean, SAMLIdentityAsserterV2MBean, SAMLRelyingPartyRegistryMBean

public interface SAMLPartnerRegistryMBean
extends ProviderMBean, ImportMBean, ExportMBean, NameListerMBean

The SAMLPartnerRegistry is used manage a registry of SAML partners and associated trusted certificates 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.

getSupportedImportFormats

String[] getSupportedImportFormats()

A SAML Partner Registry can import partner information and certificates from an XML document.

Specified by:

getSupportedImportFormats in interface ImportMBean

Default Value:

"XML Partner Registry","JKS KeyStore"

getSupportedImportConstraints

String[] getSupportedImportConstraints()

A SAML Partner Registry can import all partners, no partners, only enabled partners, only disabled partners or a list of partners. It can import all certificates, no certificates, only certificates referenced by partners, or a list of certificates. The import mode can be rename, replace or fail for conflict resolution.

Specified by:

getSupportedImportConstraints in interface ImportMBean

Default Value:

"Partners","Certificates","ImportMode"

getSupportedExportFormats

String[] getSupportedExportFormats()

A SAML Partner Registry may be exported as an XML document.

Specified by:

getSupportedExportFormats in interface ExportMBean

Default Value:

"XML Partner Registry","JKS KeyStore","LDIF Template"

getSupportedExportConstraints

String[] getSupportedExportConstraints()

A SAML Partner Registry can export all partners, no partners, only enabled partners, only disabled partners or a list of partners. It can export all certificates, no certificates, only certificates referenced by partners, or a list of certificates.

Specified by:

getSupportedExportConstraints in interface ExportMBean

Default Value:

"Partners","Certificates","Passwords"

registerCertificate

void registerCertificate(String alias,
                         String certificateFile)
                         throws weblogic.management.utils.AlreadyExistsException,
                                weblogic.management.utils.InvalidParameterException

Registers an end certificate in the registry under an alias. <p> Throws AlreadyExistsException if the alias is already in the registry or if another certificate with the same subject dn, or issuer dn + serial number, or subject key identifier is already in the registry. <p> 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 weblogic.management.utils.NotFoundException,
                                  weblogic.management.utils.InvalidParameterException

Unregisters an end certificate from the registry. <p> Throws NotFoundException if alias does not exist in the registry. <p> 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

listCertificates

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

Lists the registered certificate aliases that match a wild card. <p> It follows the NameListerMBean cursor pattern. The results are not sorted. <p> 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. <p> Throws InvalidParameterException if aliasWildcard is empty or null or if maxToReturn is less than zero.

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 weblogic.management.utils.NotFoundException,
                                      weblogic.management.utils.InvalidParameterException

Retrieves a certificate from the registry. <p> Returns the certificate. <p> Throws NotFoundException if alias does not exist in the registry. <p> 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

certificateExists

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

Determines whether or not a certificate has been registered under the given alias. <p> Returns true if a certificate is registered under that alias, false if not. <p> 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 weblogic.management.utils.NotFoundException,
                      weblogic.management.utils.InvalidParameterException

Writes a certificate in the registry to a file in PEM base64 encoded format. <p> Throws NotFoundException if the alias does not exist in the registry. <p> 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 weblogic.management.utils.NotFoundException,
                      weblogic.management.utils.InvalidParameterException

Writes a certificate in the registry to a file in DER binary format. <p> Throws NotFoundException if the alias does not exist in the registry. <p> 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:

"SAMLPartnerRegistry"