This MBean represents configuration information for the SAML Identity Assertion V2 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:weblogic.security.providers.saml.SAMLIdentityAsserterV2MBean
|
||
| 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 SAML Identity Assertion V2 provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | SAML.Assertion SAML.Assertion64 SAML.Assertion.DOM |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Base64 decoding is not required for the WebLogic SAML Identity Assertion V2 provider.
| 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 this SAML Identity Assertion V2 provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | WebLogic SAML Identity Assertion Provider. Supports Security Assertion Markup Language v1.1. |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The minimum number of parsers to maintain in the parser pool.
| Privileges | Read/Write |
| Type | int |
| Default Value | 5 |
| Minimum value | 0 |
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | SAMLIdentityAsserterV2 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The 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 name of the Java class used to load the SAML Identity Assertion V2 provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | weblogic.security.providers.saml.SAMLIdentityAsserterV2ProviderImpl |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | Partners Certificates Passwords |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A SAML Partner Registry may be exported as an XML document.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | XML Partner Registry JKS KeyStore LDIF Template |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | Partners Certificates ImportMode |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A SAML Partner Registry can import partner information and certificates from an XML document.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | XML Partner Registry JKS KeyStore |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The token types supported by this SAML Identity Assertion V2 provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | SAML.Assertion SAML.Assertion64 SAML.Assertion.DOM |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The version number of this SAML Identity Assertion V2 provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | 2.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 SAMLAssertingParty 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 | "addAssertingParty" |
| Parameters | Object [] { assertingParty }
where:
|
| Signature | String [] {
"weblogic.security.providers.saml.registry.SAMLAssertingParty" } |
| 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 |
|
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.
| Operation Name | "assertingPartyExists" |
| Parameters | Object [] { partnerId }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
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.
| Operation Name | "certificateExists" |
| Parameters | Object [] { alias }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| 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 |
|
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.
| Operation Name | "copyToDER" |
| Parameters | Object [] { alias, certificateFile }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "copyToPEM" |
| Parameters | Object [] { alias, certificateFile }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| 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 |
|
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.
| Operation Name | "getAssertingParty" |
| Parameters | Object [] { partnerId }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | SAMLAssertingParty |
| Exceptions |
|
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.
| Operation Name | "getCertificate" |
| Parameters | Object [] { alias }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | X509Certificate
|
| 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 |
|
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 |
|
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 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.
| Operation Name | "listAssertingParties" |
| Parameters | Object [] { partnerIdWildcard, maxToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
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.
| Operation Name | "listCertificates" |
| Parameters | Object [] { aliasWildcard, maxToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
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.
| Operation Name | "newAssertingParty" |
| Parameters | null |
| Signature | null |
| Returns | SAMLAssertingParty |
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.
| Operation Name | "registerCertificate" |
| Parameters | Object [] { alias, certificateFile }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "removeAssertingParty" |
| Parameters | Object [] { partnerId }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "unregisterCertificate" |
| Parameters | Object [] { alias }
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 a SAMLAssertingParty in the registry. <p> Throws NotFoundException if the asserting party does not exist. Throws InvalidParameterException if the partner object fails validation.
| Operation Name | "updateAssertingParty" |
| Parameters | Object [] { assertingParty }
where:
|
| Signature | String [] {
"weblogic.security.providers.saml.registry.SAMLAssertingParty" } |
| 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
|