com.bea.security.saml2.providers
Interface SAML2IdPPartnerRegistryMBean

All Superinterfaces:

ListerMBean, NameListerMBean, ProviderMBean, SAML2PartnerRegistryMBean

All Known Subinterfaces:

SAML2IdentityAsserterMBean

public interface SAML2IdPPartnerRegistryMBean
extends SAML2PartnerRegistryMBean

The SAMLIdPPartnerRegistry is used manage a registry of SAML 2.0 Identity Provider partners.

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.

listIdPPartners

String listIdPPartners(String partnerNameWildcard,
                       int maxToReturn)
                       throws weblogic.management.utils.InvalidCursorException,
                              weblogic.management.utils.InvalidParameterException

Lists the registered partner names 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 partnerIdWildcard is empty or null or if maxToReturn is less than zero.

Parameters:

partnerNameWildcard - - A wild card used to select partner names. It supports three formats: "*" matches all partner naes. "foo*" matches all partner namess starting with the string "foo". "foo" matches the partner name "foo" only. The matches are case-insensitive.

maxToReturn - - The maximum number of partner namess 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

idPPartnerExists

boolean idPPartnerExists(String partnerName)
                         throws weblogic.management.utils.InvalidParameterException

Determines whether or not an IdP partner exists for the given partner name. <p> Returns true if the partner is found, false if not. <p> Throws InvalidParameterException if partnerName is empty or null.

Parameters:

partnerName - - The partnerName of the IdP partner.

Throws:

weblogic.management.utils.InvalidParameterException

getIdPPartner

com.bea.security.saml2.providers.registry.IdPPartner getIdPPartner(String partnerName)
                                                                   throws weblogic.management.utils.NotFoundException,
                                                                          weblogic.management.utils.InvalidParameterException

Gets the IdPPartner corresponding to a partner name. <p> Throws NotFoundException if the partner is not found. Throws InvalidParameterException if partnerName is empty or null.

Parameters:

partnerName - - The partnerName of the partner to return.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

addIdPPartner

void addIdPPartner(com.bea.security.saml2.providers.registry.IdPPartner partner)
                   throws weblogic.management.utils.InvalidParameterException,
                          weblogic.management.utils.AlreadyExistsException,
                          weblogic.management.utils.CreateException

Adds a new IdPPartner to the registry. <p> Throws InvalidParameterException if the partner object fails validation. Throws CreateException if an error occurs during creation of the object.

Parameters:

partner - - The new partner to add.

Throws:

weblogic.management.utils.InvalidParameterException

weblogic.management.utils.AlreadyExistsException

weblogic.management.utils.CreateException

updateIdPPartner

void updateIdPPartner(com.bea.security.saml2.providers.registry.IdPPartner partner)
                      throws weblogic.management.utils.NotFoundException,
                             weblogic.management.utils.InvalidParameterException

Updates an IdPPartner in the registry. <p> Throws NotFoundException if the partner does not exist. Throws InvalidParameterException if the partner object fails validation.

Parameters:

partner - - The asserting party to update.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

removeIdPPartner

void removeIdPPartner(String partnerName)
                      throws weblogic.management.utils.NotFoundException,
                             weblogic.management.utils.InvalidParameterException

Removes an IdPPartner from the registry. <p> Throws NotFoundException if the partner does not exist. Throws InvalidParameterException if the partnerName is empty or null.

Parameters:

partnerName - - The partnerName of the partner to remove.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

newWebSSOIdPPartner

com.bea.security.saml2.providers.registry.WebSSOIdPPartner newWebSSOIdPPartner()

Returns a new Web SSO profile IdP partner object. Caller can set the fields of this object and then call addIdPPartner() to add the new partner to the registry. <p> Partner objects obtained from this method should not be passed to updateIdPPartner() -- call getIdPPartner() to fetch an existing asserting party for update.

newWSSIdPPartner

com.bea.security.saml2.providers.registry.WSSIdPPartner newWSSIdPPartner()

Returns a new WSS token profile IdP partner object. Caller can set the fields of this object and then call addIdPPartner() to add the new partner to the registry. <p> Partner objects obtained from this method should not be passed to updateIdPPartner() -- call getIdPPartner() to fetch an existing asserting party for update.

newEndpoint

com.bea.security.saml2.providers.registry.Endpoint newEndpoint()

Returns a new Endpoint object.

newIndexedEndpoint

com.bea.security.saml2.providers.registry.IndexedEndpoint newIndexedEndpoint()

Returns a new IndexedEndpoint object.

consumeIdPPartnerMetadata

com.bea.security.saml2.providers.registry.MetadataPartner consumeIdPPartnerMetadata(String fileName)
                                                                                    throws weblogic.management.utils.CreateException,
                                                                                           weblogic.management.utils.InvalidParameterException

Returns an imported IdP partner object. Caller can set the fields of this object and then call addIdPPartner() to add the new partner to the registry.

Parameters:

fileName - - The file name containing the partner meta-data to consume.

Throws:

weblogic.management.utils.CreateException

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

Specified by:

getName in interface SAML2PartnerRegistryMBean

Default Value:

"SAML2IdPPartnerRegistry"