Overview | Package | Class | Use | Tree | Deprecated | Index | Help
|  | Oracle
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## weblogic.security.providers.saml
Interface SAMLIdentityAssertionNameMapper

    public interface SAMLIdentityAssertionNameMapper

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

To specify an instance of this interface to be used by the SAML Identity Asserter, set the `NameMapperClassName` attribute.

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

Method Summary
`String` | `getGroupAttrName()` Returns the SAML AttributeName that should be used to extract group information from assertions.
`String` | `getGroupAttrNamespace()` Returns the SAML AttributeNamespace that should be used to extract group information from assertions.
`Collection` | `mapGroupInfo(SAMLNameMapperInfo info, ContextHandler handler)` Maps a `SAMLNameMapperInfo` to a `Collection` of group names.
`String` | `mapNameInfo(SAMLNameMapperInfo info, ContextHandler handler)` Maps a `SAMLNameMapperInfo` to a user name.

Method Detail

### mapNameInfo

    String mapNameInfo(SAMLNameMapperInfo info,
                       ContextHandler handler)

  Maps a `SAMLNameMapperInfo` to a user name.

  Parameters:
    `info` - The `SAMLNameMapperInfo` containing user and group information from a SAML assertion.
    `handler` - The ContextHandler passed to the SAML Identity Asserter.
  Returns:
    A `String` contained the mapped username

### mapGroupInfo

    Collection mapGroupInfo(SAMLNameMapperInfo info,
                            ContextHandler handler)

  Maps a `SAMLNameMapperInfo` to a `Collection` of group names.

  Parameters:
    `info` - The `SAMLNameMapperInfo` containing user and group information from a SAML assertion.
    `handler` - The ContextHandler passed to the SAML Identity Asserter.
  Returns:
    A `Collection` containing the mapped group names, or null if groups were not mapped.

### getGroupAttrName

    String getGroupAttrName()

  Returns the SAML AttributeName that should be used to extract group information from assertions. The SAML Identity Asserter will use this value to identify the Attribute containing group information and populate a `SAMLNameMapperInfo` with its values.

  Returns:
    The AttributeName.

### getGroupAttrNamespace

    String getGroupAttrNamespace()

  Returns the SAML AttributeNamespace that should be used to extract group information from assertions. The SAML Identity Asserter will use this value to identify the Attribute containing group information and populate a `SAMLNameMapperInfo` with its values.

  Returns:
    The AttributeNamespace.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Documentation is available at http://edocs.bea.com/wls/docs103 Copyright 1996,2008, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD