weblogic.security.providers.saml.registry
Interface SAMLRelyingPartyRegistryMBean

All Superinterfaces:

ExportMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean, SAMLPartnerRegistryMBean

All Known Subinterfaces:

SAMLCredentialMapperV2MBean

public interface SAMLRelyingPartyRegistryMBean
extends SAMLPartnerRegistryMBean

The SAMLRelyingPartyRegistry is used manage a registry of SAML 1.1 Relying Parties and associated trusted certificates.

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.

listRelyingParties

String listRelyingParties(String partnerIdWildcard,
                          int maxToReturn)
                          throws weblogic.management.utils.InvalidCursorException,
                                 weblogic.management.utils.InvalidParameterException

Lists the registered partnerIds 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:

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

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

relyingPartyExists

boolean relyingPartyExists(String partnerId)
                           throws weblogic.management.utils.InvalidParameterException

Determines whether or not a relying party exists for the given partnerId. <p> Returns true if the relying party is found, false if not. <p> Throws InvalidParameterException if partnerId is empty or null.

Parameters:

partnerId - - The partnerId of the relying party.

Throws:

weblogic.management.utils.InvalidParameterException

getRelyingParty

weblogic.security.providers.saml.registry.SAMLRelyingParty getRelyingParty(String partnerId)
                                                                           throws weblogic.management.utils.NotFoundException,
                                                                                  weblogic.management.utils.InvalidParameterException

Gets the SAMLRelyingParty corresponding to a partnerId. <p> Throws NotFoundException if the relying party is not found. Throws InvalidParameterException if partnerId is empty or null.

Parameters:

partnerId - - The partnerId of the relying party to return.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

addRelyingParty

void addRelyingParty(weblogic.security.providers.saml.registry.SAMLRelyingParty relyingParty)
                     throws weblogic.management.utils.InvalidParameterException,
                            weblogic.management.utils.CreateException

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

Parameters:

relyingParty - - The new relying party to add.

Throws:

weblogic.management.utils.InvalidParameterException

weblogic.management.utils.CreateException

updateRelyingParty

void updateRelyingParty(weblogic.security.providers.saml.registry.SAMLRelyingParty relyingParty)
                        throws weblogic.management.utils.NotFoundException,
                               weblogic.management.utils.InvalidParameterException

Updates a SAMLRelyingParty in the registry. <p> Throws NotFoundException if the relying party does not exist. Throws InvalidParameterException if the partner object fails validation.

Parameters:

relyingParty - - The relying party to update.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

removeRelyingParty

void removeRelyingParty(String partnerId)
                        throws weblogic.management.utils.NotFoundException,
                               weblogic.management.utils.InvalidParameterException

Removes a SAMLRelyingParty from the registry. <p> Throws NotFoundException if the relying party does not exist. Throws InvalidParameterException if the partnerId is empty or null.

Parameters:

partnerId - - The partnerId of the relying party to remove.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

newRelyingParty

weblogic.security.providers.saml.registry.SAMLRelyingParty newRelyingParty()

Returns a new SAMLRelyingParty object. Caller can set the fields of this object and then call addRelyingParty() to add the new relying party to the registry. <p> Relying party objects obtained from this method should not be passed to updateRelyingParty() -- call getRelyingParty() to fetch an existing relying party for update.

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 SAMLPartnerRegistryMBean

Default Value:

"SAMLRelyingPartyRegistry"