weblogic.security.providers.saml
Interface SAMLIdentityAsserterMBean

All Superinterfaces:

AuthenticationProviderMBean, CertRegManagerMBean, ExportMBean, IdentityAsserterMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean, ServletAuthenticationFilterMBean

public interface SAMLIdentityAsserterMBean
extends IdentityAsserterMBean, CertRegManagerMBean, ServletAuthenticationFilterMBean

This MBean represents configuration information for the SAML 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 runtime.

getProviderClassName

String getProviderClassName()

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

Default Value:

"weblogic.security.providers.saml.SAMLIdentityAsserterProviderImpl"

getDescription

String getDescription()

A short description of this SAML Identity Assertion provider.

Specified by:

getDescription in interface ProviderMBean

Default Value:

"WebLogic SAML Identity Assertion Provider. Supports Security Assertion Markup Language v1.1."

getVersion

String getVersion()

The version number of this SAML Identity Assertion provider.

Specified by:

getVersion in interface ProviderMBean

Default Value:

"1.0"

getSupportedTypes

String[] getSupportedTypes()

The token types supported by this SAML Identity Assertion provider.

Specified by:

getSupportedTypes in interface IdentityAsserterMBean

Default Value:

weblogic.security.spi.IdentityAsserterV2.SAML_ASSERTION_TYPE,weblogic.security.spi.IdentityAsserterV2.SAML_ASSERTION_B64_TYPE,weblogic.security.spi.IdentityAsserterV2.SAML_ASSERTION_DOM_TYPE

getActiveTypes

String[] getActiveTypes()

The token types active for this SAML Identity Assertion provider.

Specified by:

getActiveTypes in interface IdentityAsserterMBean

Default Value:

weblogic.security.spi.IdentityAsserterV2.SAML_ASSERTION_TYPE,weblogic.security.spi.IdentityAsserterV2.SAML_ASSERTION_B64_TYPE,weblogic.security.spi.IdentityAsserterV2.SAML_ASSERTION_DOM_TYPE

getBase64DecodingRequired

boolean getBase64DecodingRequired()

Base64 decoding is not required for the WebLogic SAML Identity Assertion provider.

Specified by:

getBase64DecodingRequired in interface IdentityAsserterMBean

Default Value:

false

getAssertionConsumerURIs

String[] getAssertionConsumerURIs()

Consumer URIs to listen on.

Default Value:

weblogic.security.providers.saml.SAMLIdentityAsserterImpl.defaultAssertionConsumerURIs()

setAssertionConsumerURIs

void setAssertionConsumerURIs(String[] newValue)
                              throws InvalidAttributeValueException

Consumer URIs to listen on.

Parameters:

newValue - - new value for attribute AssertionConsumerURIs

Throws:

InvalidAttributeValueException

Default Value:

weblogic.security.providers.saml.SAMLIdentityAsserterImpl.defaultAssertionConsumerURIs()

isPostEnabled

boolean isPostEnabled()

Enable POST profile.

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

Default Value:

false

setPostEnabled

void setPostEnabled(boolean newValue)
                    throws InvalidAttributeValueException

Enable POST profile.

Parameters:

newValue - - new value for attribute PostEnabled

Throws:

InvalidAttributeValueException

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

Default Value:

false

isArtifactEnabled

boolean isArtifactEnabled()

Enable ARTIFACT profile.

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

Default Value:

false

setArtifactEnabled

void setArtifactEnabled(boolean newValue)
                        throws InvalidAttributeValueException

Enable ARTIFACT profile.

Parameters:

newValue - - new value for attribute ArtifactEnabled

Throws:

InvalidAttributeValueException

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

Default Value:

false

getMinimumParserPoolSize

int getMinimumParserPoolSize()

The minimum number of parsers to maintain in the parser pool.

Default Value:

5

Minimum Value:

0

setMinimumParserPoolSize

void setMinimumParserPoolSize(int newValue)
                              throws InvalidAttributeValueException

The minimum number of parsers to maintain in the parser pool.

Parameters:

newValue - - new value for attribute MinimumParserPoolSize

Throws:

InvalidAttributeValueException

Default Value:

5

Minimum Value:

0

isRecipientCheckEnabled

boolean isRecipientCheckEnabled()

When true, the recipient of the SAML Response must match the URL in the HTTP Request

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

Default Value:

true

setRecipientCheckEnabled

void setRecipientCheckEnabled(boolean newValue)
                              throws InvalidAttributeValueException

When true, the recipient of the SAML Response must match the URL in the HTTP Request

Parameters:

newValue - - new value for attribute RecipientCheckEnabled

Throws:

InvalidAttributeValueException

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

Default Value:

true

getUsedAssertionCacheClassName

String getUsedAssertionCacheClassName()

The class that implements persistent storage for the POST profile used assertion cache.

The UsedAssertionCache class is used to enforce a one-use policy for POST profile assertions.

Default Value:

""

setUsedAssertionCacheClassName

void setUsedAssertionCacheClassName(String newValue)
                                    throws InvalidAttributeValueException

The class that implements persistent storage for the POST profile used assertion cache.

The UsedAssertionCache class is used to enforce a one-use policy for POST profile assertions.

Parameters:

newValue - - new value for attribute UsedAssertionCacheClassName

Throws:

InvalidAttributeValueException

Default Value:

""

getUsedAssertionCacheProperties

Properties getUsedAssertionCacheProperties()

Properties passed to the UsedAssertionCache class init() method. This may be useful if you have implemented a custom UsedAssertionCache class.

Default Value:

new java.util.Properties()

setUsedAssertionCacheProperties

void setUsedAssertionCacheProperties(Properties newValue)
                                     throws InvalidAttributeValueException

Properties passed to the UsedAssertionCache class init() method. This may be useful if you have implemented a custom UsedAssertionCache class.

Parameters:

newValue - - new value for attribute UsedAssertionCacheProperties

Throws:

InvalidAttributeValueException

Default Value:

new java.util.Properties()

isEnforceOneUsePolicy

boolean isEnforceOneUsePolicy()

Enforce a one-use policy for POST profile assertions.

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

Default Value:

false

setEnforceOneUsePolicy

void setEnforceOneUsePolicy(boolean newValue)
                            throws InvalidAttributeValueException

Enforce a one-use policy for POST profile assertions.

Parameters:

newValue - - new value for attribute EnforceOneUsePolicy

Throws:

InvalidAttributeValueException

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

Default Value:

false

getNameMapperClassName

String getNameMapperClassName()

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.

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

Default Value:

""

setNameMapperClassName

void setNameMapperClassName(String newValue)
                            throws InvalidAttributeValueException

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.

Parameters:

newValue - - new value for attribute NameMapperClassName

Throws:

InvalidAttributeValueException

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

Default Value:

""

getAssertionConfiguration

Properties getAssertionConfiguration()

Configuration for assertions generated by this SAML authority.

Assertions are configured in key=value format. You may find it convenient to write your assertion configuration in a text editor and paste it into the Assertion Configuration field.

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

Default Value:

new java.util.Properties()

setAssertionConfiguration

void setAssertionConfiguration(Properties newValue)
                               throws InvalidAttributeValueException

Configuration for assertions generated by this SAML authority.

Assertions are configured in key=value format. You may find it convenient to write your assertion configuration in a text editor and paste it into the Assertion Configuration field.

Parameters:

newValue - - new value for attribute AssertionConfiguration

Throws:

InvalidAttributeValueException

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

Default Value:

new java.util.Properties()

getSourceSiteRedirects

Properties getSourceSiteRedirects()

An optional set of URIs from which unauthenticated users will be redirected to the configured ITS URL.

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

Default Value:

new java.util.Properties()

setSourceSiteRedirects

void setSourceSiteRedirects(Properties newValue)
                            throws InvalidAttributeValueException

An optional set of URIs from which unauthenticated users will be redirected to the configured ITS URL.

Parameters:

newValue - - new value for attribute SourceSiteRedirects

Throws:

InvalidAttributeValueException

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

Default Value:

new java.util.Properties()

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 CertRegManagerMBean

Specified by:

getName in interface ProviderMBean

Default Value:

"SAMLIdentityAsserter"