SAML2CredentialNameMapper (Oracle WebLogic Server 10.3.1 API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 API Reference
11g Release 1 (10.3.1)

Part Number E13941-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.bea.security.saml2.providers
Interface SAML2CredentialNameMapper

public interface SAML2CredentialNameMapper

Interface used to perform the mapping of user and group information to SAML 2.0 assertions.

To specify an instance of this interface to be used by the SAML 2.0 Credential Mapping provider, set the NameMapperClassName attribute when configuring that provider.

Classes implementing this interface must have a public no-arg constructor and must be in the system classpath.

Method Summary
`SAML2NameMapperInfo`	`mapName(String name, ContextHandler handler)` Maps a `String` name to a set of values used to construct a SAML `NameIdentifier` element for a SAML 2.0 assertion.
`SAML2NameMapperInfo`	`mapSubject(Subject subject, ContextHandler handler)` Maps a `Subject` to a set of values used to construct a SAML `NameIdentifier` element for a SAML 2.0 assertion.
`void`	`setNameQualifier(String nameQualifier)` Called by the SAML 2.0 Credential Mapping provider to inform a `SAML2CredentialNameMapper` of the currently configured SAML NameQualifier value.

Method Detail

setNameQualifier

void setNameQualifier(String nameQualifier)

Called by the SAML 2.0 Credential Mapping provider to inform a SAML2CredentialNameMapper of the currently configured SAML NameQualifier value.

Parameters:: nameQualifier - The currently configured Name Qualifier.

mapSubject

SAML2NameMapperInfo mapSubject(Subject subject,
                               ContextHandler handler)

Maps a Subject to a set of values used to construct a SAML NameIdentifier element for a SAML 2.0 assertion. The returned SAML2NameMapperInfo may optionally include a Collection of group names, which will be used to construct a SAML AttributeStatement containing a WLSGroups attribute.

Parameters:: subject - The Subject that should be mapped.; handler - The ContextHandler passed to the SAML 2.0 Credential Mapping provider.
Returns:: A SAML2NameMapperInfo containing user and group information, or null if no mapping is made.

mapName

SAML2NameMapperInfo mapName(String name,
                            ContextHandler handler)

Maps a String name to a set of values used to construct a SAML NameIdentifier element for a SAML 2.0 assertion. The returned SAML2NameMapperInfo may optionally include a Collection of group names, which will be used to construct a SAML AttributeStatement containing a WLSGroups attribute.

Parameters:: name - The String name that should be mapped.; handler - The ContextHandler passed to the SAML 2.0 Credential Mapping provider.
Returns:: A SAML2NameMapperInfo containing user and group information, or null if no mapping is made.