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

## com.bea.security.saml2.providers
Class SAML2NameMapperInfo

    java.lang.Object
      com.bea.security.saml2.providers.SAML2NameMapperInfo

    public class SAML2NameMapperInfo

extends Object

The `SAML2NameMapperInfo` is used to represent user name and group information contained in SAML 2.0 assertions.

Field Summary
`static String` | `ATTR_NAME_FORMAT_BASIC` SAML 2.0 URN for "Basic" attribute name format.
`static String` | `BEA_GROUP_ATTR_NAME` BEA SAML AttributeName value indicating a groups attribute
`static String` | `BEA_GROUP_ATTR_NAMEFORMAT`
`static String` | `BEA_GROUP_ATTR_NAMESPACE`
`static String` | `NAME_FORMAT_ENTITY` SAML 2.0 URN for "Entity" name format.
`static String` | `NAME_FORMAT_KERBEROS` SAML 2.0 URN for "Kerberos" name format.
`static String` | `NAME_FORMAT_PERSISTENT` SAML 2.0 URN for "Psersistent" name format.
`static String` | `NAME_FORMAT_TRANSIENT` SAML 2.0 URN for "Transient" name format.
`static String` | `NAME_FORMAT_UNSPECIFIED` SAML 2.0 URN for "Unspecified" name format.

Constructor Summary
`SAML2NameMapperInfo()` Default no-args constructor
`SAML2NameMapperInfo(String name, Collection groups)` Construct `SAML2NameMapperInfo` with the specified user name and groups.
`SAML2NameMapperInfo(String nameQualifier, String name, Collection groups)` Construct `SAML2NameMapperInfo` with the specified name qualifier, user name, and groups.
`SAML2NameMapperInfo(String nameQualifier, String nameFormat, String name, Collection groups)` Construct `SAML2NameMapperInfo` with the specified name qualifier, name format, user name, and groups.
`SAML2NameMapperInfo(String nameQualifier, String nameFormat, String name, String groupAttrName, String groupAttrNamespace, Collection groups)` Construct `SAML2NameMapperInfo` with the specified name qualifier, name format, user name, group attribute name, group attribute namespace, and groups.

Method Summary
`String` | `getGroupAttrName()`
`String` | `getGroupAttrNamespace()`
`Collection` | `getGroups()`
`String` | `getName()`
`String` | `getNameFormat()`
`String` | `getNameQualifier()`
`void` | `setGroupAttrName(String groupAttrName)`
`void` | `setGroupAttrNamespace(String groupAttrNamespace)`
`void` | `setGroups(Collection groups)`
`void` | `setName(String name)`
`void` | `setNameFormat(String nameFormat)`
`void` | `setNameQualifier(String nameQualifier)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### NAME_FORMAT_UNSPECIFIED

    public static final String NAME_FORMAT_UNSPECIFIED

  SAML 2.0 URN for "Unspecified" name format.

  See Also:
    Constant Field Values

### NAME_FORMAT_KERBEROS

    public static final String NAME_FORMAT_KERBEROS

  SAML 2.0 URN for "Kerberos" name format.

  See Also:
    Constant Field Values

### NAME_FORMAT_ENTITY

    public static final String NAME_FORMAT_ENTITY

  SAML 2.0 URN for "Entity" name format.

  See Also:
    Constant Field Values

### NAME_FORMAT_PERSISTENT

    public static final String NAME_FORMAT_PERSISTENT

  SAML 2.0 URN for "Psersistent" name format.

  See Also:
    Constant Field Values

### NAME_FORMAT_TRANSIENT

    public static final String NAME_FORMAT_TRANSIENT

  SAML 2.0 URN for "Transient" name format.

  See Also:
    Constant Field Values

### ATTR_NAME_FORMAT_BASIC

    public static final String ATTR_NAME_FORMAT_BASIC

  SAML 2.0 URN for "Basic" attribute name format.

  See Also:
    Constant Field Values

### BEA_GROUP_ATTR_NAMESPACE

    public static final String BEA_GROUP_ATTR_NAMESPACE

See Also:
  Constant Field Values

### BEA_GROUP_ATTR_NAME

    public static final String BEA_GROUP_ATTR_NAME

  BEA SAML AttributeName value indicating a groups attribute

  See Also:
    Constant Field Values

### BEA_GROUP_ATTR_NAMEFORMAT

    public static final String BEA_GROUP_ATTR_NAMEFORMAT

See Also:
  Constant Field Values

Constructor Detail

### SAML2NameMapperInfo

    public SAML2NameMapperInfo()

  Default no-args constructor

### SAML2NameMapperInfo

    public SAML2NameMapperInfo(String name,
                               Collection groups)

  Construct `SAML2NameMapperInfo` with the specified user name and groups.

  Parameters:
    `name` - The username.
    `groups` - A `Collection` of group names.

### SAML2NameMapperInfo

    public SAML2NameMapperInfo(String nameQualifier,
                               String name,
                               Collection groups)

  Construct `SAML2NameMapperInfo` with the specified name qualifier, user name, and groups.

  Parameters:
    `nameQualifier` - The NameQualifier to use.
    `name` - The username.
    `groups` - A `Collection` of group names.

### SAML2NameMapperInfo

    public SAML2NameMapperInfo(String nameQualifier,
                               String nameFormat,
                               String name,
                               Collection groups)

  Construct `SAML2NameMapperInfo` with the specified name qualifier, name format, user name, and groups.

  Parameters:
    `nameQualifier` - The NameQualifier to use.
    `nameFormat` - The NameFormat to use.
    `name` - The username.
    `groups` - A `Collection` of group names.

### SAML2NameMapperInfo

    public SAML2NameMapperInfo(String nameQualifier,
                               String nameFormat,
                               String name,
                               String groupAttrName,
                               String groupAttrNamespace,
                               Collection groups)

  Construct `SAML2NameMapperInfo` with the specified name qualifier, name format, user name, group attribute name, group attribute namespace, and groups.

  Parameters:
    `nameQualifier` - The NameQualifier to use.
    `nameFormat` - The NameFormat to use.
    `name` - The username.
    `groupAttrName` - The group AttributeName to use.
    `groupAttrNamespace` - The group AttributeNamespace to use.
    `groups` - A `Collection` of group names.

Method Detail

### getGroupAttrName

    public String getGroupAttrName()

  Returns:
    Returns the groupAttrName. Default value is `BEA_GROUP_ATTR_NAME`.

### setGroupAttrName

    public void setGroupAttrName(String groupAttrName)

  Parameters:
    `groupAttrName` - The groupAttrName to set.

### getGroupAttrNamespace

    public String getGroupAttrNamespace()

  Returns:
    Returns the groupAttrNamespace. Default value is `BEA_GROUP_ATTR_NAMESPACE`.

### setGroupAttrNamespace

    public void setGroupAttrNamespace(String groupAttrNamespace)

  Parameters:
    `groupAttrNamespace` - The groupAttrNamespace to set.

### getGroups

    public Collection getGroups()

  Returns:
    Returns the groups.

### setGroups

    public void setGroups(Collection groups)

  Parameters:
    `groups` - The groups to set.

### getName

    public String getName()

  Returns:
    Returns the name.

### setName

    public void setName(String name)

  Parameters:
    `name` - The name to set.

### getNameFormat

    public String getNameFormat()

  Returns:
    Returns the nameFormat. Default value is `NAME_FORMAT_UNSPECIFIED`.

### setNameFormat

    public void setNameFormat(String nameFormat)

  Parameters:
    `nameFormat` - The nameFormat to set.

### getNameQualifier

    public String getNameQualifier()

  Returns:
    Returns the nameQualifier.

### setNameQualifier

    public void setNameQualifier(String nameQualifier)

  Parameters:
    `nameQualifier` - The nameQualifier to set.

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