This MBean represents configuration information for the SAML2 Identity Assertion provider.
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.
| Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:com.bea.security.saml2.providers.SAML2IdentityAsserterMBean
|
||
| Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
| Access Points Inherited from AuthenticationProviderMBean |
Because this MBean extends or implements AuthenticationProviderMBean, you can also access this MBean by retrieving AuthenticationProviderMBeans. The following attributes contain AuthenticationProviderMBeans and its subtypes:
|
This section describes attributes that provide access to other MBeans.
|
|
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
| Privileges | Read only |
| Type | RealmMBean |
| Relationship type: | Reference. |
This section describes the following attributes:
The token types active for this SAML2 Identity Assertion provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | SAML2.Assertion SAML2.Assertion.DOM |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Base64 decoding is not required for SAML2 Identity Assertion providers.
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A short description of the SAML2 Identity Assertion provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | SAML 2.0 Identity Assertion Provider. Supports Security Assertion Markup Language v2.0. |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | SAML2IdentityAsserter |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The qualified name of the Java class that maps SAML Assertion name information to local Subjects. When no mapper is supplied the default mapper implementation is used.
| Privileges | Read/Write |
| Type | java.lang.String |
| Default Value |
The Java class used to load the SAML2 Identity Assertion provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | com.bea.security.saml2.providers.SAML2IdentityAsserterProviderImpl |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Flag that indicates whether the replicated cache is used or not. To support cluster, this flag must be set to true.
| Privileges | Read/Write |
| Type | boolean |
The security data that you want to be exported from this Identity Assertion provider's data store. A SAML2 Identity Assertion provider can export all partners(Partner=all), enabled partners(Partner=enabled), or only disabled partners(Partner=disabled). The password inlined in the exported file can be encrypted or plain text(Passwords=cleartext).
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | Partner Passwords |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The format of the file to export. The list of supported export formats is determined by this Identity Asserter provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | SAML2 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The security data that you want to be imported into this Identity Assertion provider's data store. A SAML2 Identity Assertion Provider can import all partners(Partner=all), enabled partners(Partner=enabled) or only disabled partners(Partner=disabled).
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | Partner |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The format of the file to import. The list of supported import formats is determined by the Identity Asserter provider from which the security data were originally exported.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | SAML2 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The token types supported by this SAML2 Identity Assertion provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | SAML2.Assertion SAML2.Assertion.DOM |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The version number of the SAML2 Identity Assertion provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | 1.0 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
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.
| Operation Name | "addIdPPartner" |
| Parameters | Object [] { partner }
where:
|
| Signature | String [] {
"com.bea.security.saml2.providers.registry.IdPPartner" } |
| Returns |
void
|
| Exceptions |
|
Advances the list to the next element in the list.
| Operation Name | "advance" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.
| Operation Name | "close" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "consumeIdPPartnerMetadata" |
| Parameters | Object [] { fileName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | MetadataPartner |
| Exceptions |
|
Exports provider specific data in a specified format. When
errors occur, the MBean throws an ErrorCollectionException
containing a list of java.lang.Exceptions, where the
text of each exception describes the error.
| Operation Name | "exportData" |
| Parameters | Object [] { format, filename, constraints }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns |
void
|
| Exceptions |
|
The name of the current item in the list. Returns null if there is no current item.
| Operation Name | "getCurrentName" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
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.
| Operation Name | "getIdPPartner" |
| Parameters | Object [] { partnerName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | IdPPartner |
| Exceptions |
|
Returns true if there are more objects in the list, and false otherwise.
| Operation Name | "haveCurrent" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
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.
| Operation Name | "idPPartnerExists" |
| Parameters | Object [] { partnerName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
Imports provider specific data from a specified format. When
errors occur, the MBean throws an ErrorCollectionException
containing a list of java.lang.Exceptions, where the
text of each exception describes the error.
| Operation Name | "importData" |
| Parameters | Object [] { format, filename, constraints }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns |
void
|
| Exceptions |
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
| Operation Name | "isSet" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
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.
| Operation Name | "listIdPPartners" |
| Parameters | Object [] { partnerNameWildcard, maxToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Loads a certificate from file so that it may be applied to partner configurations. <p> Throws InvalidParameterException if the certificateFile parameter is empty or null, or if the file cannot be read or does not contain a valid certificate.
| Operation Name | "loadCertificate" |
| Parameters | Object [] { certificateFile }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | X509Certificate
|
| Exceptions |
|
Returns a new Endpoint object.
| Operation Name | "newEndpoint" |
| Parameters | null |
| Signature | null |
| Returns | Endpoint |
Returns a new IndexedEndpoint object.
| Operation Name | "newIndexedEndpoint" |
| Parameters | null |
| Signature | null |
| Returns | IndexedEndpoint |
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.
| Operation Name | "newWebSSOIdPPartner" |
| Parameters | null |
| Signature | null |
| Returns | WebSSOIdPPartner |
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.
| Operation Name | "newWSSIdPPartner" |
| Parameters | null |
| Signature | null |
| Returns | WSSIdPPartner |
Removes an IdPPartner from the registry. <p> Throws NotFoundException if the partner does not exist. Throws InvalidParameterException if the partnerName is empty or null.
| Operation Name | "removeIdPPartner" |
| Parameters | Object [] { partnerName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Restore the given property to its default value.
| Operation Name | "unSet" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Updates an IdPPartner in the registry. <p> Throws NotFoundException if the partner does not exist. Throws InvalidParameterException if the partner object fails validation.
| Operation Name | "updateIdPPartner" |
| Parameters | Object [] { partner }
where:
|
| Signature | String [] {
"com.bea.security.saml2.providers.registry.IdPPartner" } |
| Returns |
void
|
| Exceptions |
|
Returns the display name of an MBean.
Deprecated 9.0.0.0
| Operation Name | "wls_getDisplayName" |
| Parameters | null |
| Signature | null |
| Returns | String
|