com.bea.security.saml2.providers
Interface SAML2IdentityAsserterMBean

All Superinterfaces:

weblogic.management.security.authentication.AuthenticationProviderMBean, weblogic.management.security.ExportMBean, weblogic.management.security.authentication.IdentityAsserterMBean, weblogic.management.security.ImportMBean, weblogic.management.utils.ListerMBean, weblogic.management.utils.NameListerMBean, weblogic.management.security.ProviderMBean, SAML2IdPPartnerRegistryMBean, SAML2PartnerRegistryMBean, weblogic.management.security.authentication.ServletAuthenticationFilterMBean

public interface SAML2IdentityAsserterMBean
extends weblogic.management.security.authentication.IdentityAsserterMBean, SAML2IdPPartnerRegistryMBean, weblogic.management.security.ImportMBean, weblogic.management.security.ExportMBean, weblogic.management.security.authentication.ServletAuthenticationFilterMBean

This MBean represents configuration information for the SAML 2.0 Identity Assertion provider.

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 run time. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

getProviderClassName

String getProviderClassName()

The Java class used to load the SAML 2.0 Identity Assertion provider.

Default Value:

"com.bea.security.saml2.providers.SAML2IdentityAsserterProviderImpl"

getDescription

String getDescription()

A short description of the SAML 2.0 Identity Assertion provider.

Specified by:

getDescription in interface weblogic.management.security.ProviderMBean

Default Value:

"BEA SAML 2.0 Identity Assertion Provider. Supports Security Assertion Markup Language v2.0."

getVersion

String getVersion()

The version number of the SAML 2.0 Identity Assertion provider.

Specified by:

getVersion in interface weblogic.management.security.ProviderMBean

Default Value:

"1.0"

getSupportedImportFormats

String[] getSupportedImportFormats()

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.

Specified by:

getSupportedImportFormats in interface weblogic.management.security.ImportMBean

Default Value:

"SAML2"

getSupportedImportConstraints

String[] getSupportedImportConstraints()

The security data that you want to be imported into this Identity Assertion provider's data store. A SAML 2.0 Identity Assertion provider can import all partners(Partner=all), enabled partners(Partner=enabled) or only disabled partners(Partner=disabled).

Specified by:

getSupportedImportConstraints in interface weblogic.management.security.ImportMBean

Default Value:

"Partner"

getSupportedExportFormats

String[] getSupportedExportFormats()

The format of the file to export. The list of supported export formats is determined by this Identity Asserter provider.

Specified by:

getSupportedExportFormats in interface weblogic.management.security.ExportMBean

Default Value:

"SAML2"

getSupportedExportConstraints

String[] getSupportedExportConstraints()

The security data that you want to be exported from this Identity Assertion provider's data store. A SAML 2.0 Identity Assertion provider can export all partners(Partner=all), enabled partners(Partner=enabled), or only disabled partners(Partner=disabled). The password placed in the exported file can be encrypted or plain text(Passwords=cleartext).

Specified by:

getSupportedExportConstraints in interface weblogic.management.security.ExportMBean

Default Value:

"Partner","Passwords"

getSupportedTypes

String[] getSupportedTypes()

The token types supported by this SAML 2.0 Identity Assertion provider.

Specified by:

getSupportedTypes in interface weblogic.management.security.authentication.IdentityAsserterMBean

Default Value:

weblogic.security.spi.IdentityAsserterV2.SAML2_ASSERTION_TYPE,weblogic.security.spi.IdentityAsserterV2.SAML2_ASSERTION_DOM_TYPE

getActiveTypes

String[] getActiveTypes()

The token types active for this SAML 2.0 Identity Assertion provider.

Specified by:

getActiveTypes in interface weblogic.management.security.authentication.IdentityAsserterMBean

Default Value:

weblogic.security.spi.IdentityAsserterV2.SAML2_ASSERTION_TYPE,weblogic.security.spi.IdentityAsserterV2.SAML2_ASSERTION_DOM_TYPE

getBase64DecodingRequired

boolean getBase64DecodingRequired()

Returns whether the assertions that are passed to the SAML 2.0 Identity Assertion provider are base64 decoded first. If false, the server does not base64 decode the assertion before passing it to the SAML 2.0 Identity Assertion provider. Base64 decoding is not required for SAML 2.0 Identity Assertion providers.

Specified by:

getBase64DecodingRequired in interface weblogic.management.security.authentication.IdentityAsserterMBean

Default Value:

false

getNameMapperClassName

String getNameMapperClassName()

The custom Java class that overrides the default SAML 2.0 assertion name mapper class, which maps identity information contained in assertions to local Subjects.

Changes take effect after you redeploy the module or restart the server.

Default Value:

""

setNameMapperClassName

void setNameMapperClassName(String newValue)
                            throws InvalidAttributeValueException

The custom Java class that overrides the default SAML 2.0 assertion name mapper class, which maps identity information contained in assertions to local Subjects.

Parameters:

newValue - - new value for attribute NameMapperClassName

Throws:

InvalidAttributeValueException

Changes take effect after you redeploy the module or restart the server.

Default Value:

""

getReplicatedCacheEnabled

boolean getReplicatedCacheEnabled()

Specifies whether the replicated cache is used.

Default Value:

false

setReplicatedCacheEnabled

void setReplicatedCacheEnabled(boolean newValue)
                               throws InvalidAttributeValueException

Specifies whether the replicated cache is used.

Parameters:

newValue - - new value for attribute ReplicatedCacheEnabled

Throws:

InvalidAttributeValueException

Default Value:

false

getName

String getName()

Description copied from interface: weblogic.management.security.ProviderMBean

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:

getName in interface weblogic.management.security.ProviderMBean

Specified by:

getName in interface SAML2IdPPartnerRegistryMBean

Specified by:

getName in interface SAML2PartnerRegistryMBean

Default Value:

"SAML2IdentityAsserter"