Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06

weblogic.security.providers.saml.registry
Interface SAMLAssertingPartyRegistryMBean

All Superinterfaces:
ExportMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean, SAMLPartnerRegistryMBean
All Known Subinterfaces:
SAMLIdentityAsserterV2MBean

public interface SAMLAssertingPartyRegistryMBean
extends SAMLPartnerRegistryMBean

The SAMLAssertingPartyRegistry is used manage a registry of SAML 1.1 Asserting 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.


Method Summary
 void addAssertingParty(weblogic.security.providers.saml.registry.SAMLAssertingParty assertingParty)
          Adds a new SAMLAssertingParty to the registry.
 boolean assertingPartyExists(String partnerId)
          Determines whether or not a asserting party exists for the given partnerId.
 weblogic.security.providers.saml.registry.SAMLAssertingParty getAssertingParty(String partnerId)
          Gets the SAMLAssertingParty corresponding to a partnerId.
 String getName()
          The name of this configuration.
 String listAssertingParties(String partnerIdWildcard, int maxToReturn)
          Lists the registered partnerIds that match a wild card.
 weblogic.security.providers.saml.registry.SAMLAssertingParty newAssertingParty()
          Returns a new SAMLAssertingParty object.
 void removeAssertingParty(String partnerId)
          Removes a SAMLAssertingParty from the registry.
 void updateAssertingParty(weblogic.security.providers.saml.registry.SAMLAssertingParty assertingParty)
          Updates a SAMLAssertingParty in the registry.
 
Methods inherited from interface weblogic.security.providers.saml.registry.SAMLPartnerRegistryMBean
certificateExists, copyToDER, copyToPEM, getCertificate, getSupportedExportConstraints, getSupportedExportFormats, getSupportedImportConstraints, getSupportedImportFormats, listCertificates, registerCertificate, unregisterCertificate
 
Methods inherited from interface weblogic.management.security.ProviderMBean
getDescription, getRealm, getVersion
 
Methods inherited from interface weblogic.management.security.ImportMBean
importData
 
Methods inherited from interface weblogic.management.security.ExportMBean
exportData
 
Methods inherited from interface weblogic.management.utils.NameListerMBean
getCurrentName
 
Methods inherited from interface weblogic.management.utils.ListerMBean
advance, close, haveCurrent
 

Method Detail

listAssertingParties

String listAssertingParties(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

assertingPartyExists

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

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

Parameters:
partnerId - - The partnerId of the asserting party.
Throws:
weblogic.management.utils.InvalidParameterException

getAssertingParty

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

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

Parameters:
partnerId - - The partnerId of the asserting party to return.
Throws:
weblogic.management.utils.NotFoundException
weblogic.management.utils.InvalidParameterException

addAssertingParty

void addAssertingParty(weblogic.security.providers.saml.registry.SAMLAssertingParty assertingParty)
                       throws weblogic.management.utils.InvalidParameterException,
                              weblogic.management.utils.CreateException

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

Parameters:
assertingParty - - The new asserting party to add.
Throws:
weblogic.management.utils.InvalidParameterException
weblogic.management.utils.CreateException

updateAssertingParty

void updateAssertingParty(weblogic.security.providers.saml.registry.SAMLAssertingParty assertingParty)
                          throws weblogic.management.utils.NotFoundException,
                                 weblogic.management.utils.InvalidParameterException

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

Parameters:
assertingParty - - The asserting party to update.
Throws:
weblogic.management.utils.NotFoundException
weblogic.management.utils.InvalidParameterException

removeAssertingParty

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

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

Parameters:
partnerId - - The partnerId of the asserting party to remove.
Throws:
weblogic.management.utils.NotFoundException
weblogic.management.utils.InvalidParameterException

newAssertingParty

weblogic.security.providers.saml.registry.SAMLAssertingParty newAssertingParty()

Returns a new SAMLAssertingParty object. Caller can set the fields of this object and then call addAssertingParty() to add the new asserting party to the registry. <p> Asserting party objects obtained from this method should not be passed to updateAssertingParty() -- call getAssertingParty() to fetch an existing asserting 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:
"SAMLAssertingPartyRegistry"

Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06