DefaultAccountMapper (OpenAM Project 16.0.0-SNAPSHOT API)

java.lang.Object
- com.sun.identity.saml2.plugins.DefaultAccountMapper

Direct Known Subclasses:

DefaultIDPAccountMapper, DefaultLibrarySPAccountMapper
```
public class DefaultAccountMapper
extends Object
```
This class DefaultAccountMapper is a base class that the DefaultSPAccountMapper and DefaultIDPAccountMapper shall extend from this class. This class implements the common interface methods that are required for the SP and IDP account mappers and also provide some utility classes that can be shared between these mappers.

Field Summary

Fields
Modifier and Type	Field	Description
`protected static ResourceBundle`	`bundle`
`protected static Debug`	`debug`
`protected static DataStoreProvider`	`dsProvider`
`protected static String`	`IDP`
`protected static KeyProvider`	`keyProvider`
`protected static SAML2MetaManager`	`metaManager`
`protected String`	`role`
`protected static String`	`SP`

Constructor Summary

Constructors
Constructor Description

DefaultAccountMapper()
Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`getAttribute(String realm, String entityID, String attributeName)`	Returns the attribute value configured in the given entity SP or IDP configuration.
`String`	`getIdentity(ManageNameIDRequest manageNameIDRequest, String hostEntityID, String realm)`	Returns the user's disntinguished name or the universal ID for the corresponding `SAML` `ManageNameIDRequest`.
`protected BaseConfigType`	`getSSOConfig(String realm, String entityID)`

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

Field Detail

debug
```
protected static Debug debug
```

bundle
```
protected static ResourceBundle bundle
```

dsProvider

protected static DataStoreProvider dsProvider

metaManager

protected static SAML2MetaManager metaManager

IDP
```
protected static final String IDP
```
See Also:

Constant Field Values

SP
```
protected static final String SP
```
See Also:

Constant Field Values

role
```
protected String role
```

keyProvider

protected static KeyProvider keyProvider

Constructor Detail
- DefaultAccountMapper
```
public DefaultAccountMapper()
```
  Default constructor

Method Detail
- getIdentity
```
public String getIdentity(ManageNameIDRequest manageNameIDRequest,
                          String hostEntityID,
                          String realm)
                   throws SAML2Exception
```
  Returns the user's disntinguished name or the universal ID for the corresponding SAML ManageNameIDRequest. This method will be invoked by the SAML framework for retrieving the user identity while processing the ManageIDRequest.
  
  Parameters:
  
  manageNameIDRequest - SAML ManageNameIDRequest that needs to be mapped to the user.
  
  hostEntityID - EntityID of the hosted provider.
  
  realm - realm or the organization name that may be used to find the user information.
  
  Returns:
  
  user's disntinguished name or the universal ID.
  
  Throws:
  
  SAML2Exception - if any failure.
- getAttribute
```
protected String getAttribute(String realm,
                              String entityID,
                              String attributeName)
```
  Returns the attribute value configured in the given entity SP or IDP configuration.
  
  Parameters:
  
  realm - realm name.
  
  entityID - hosted EntityID.
  
  attributeName - name of the attribute.
- getSSOConfig
```
protected final BaseConfigType getSSOConfig(String realm,
                                            String entityID)
                                     throws SAML2MetaException
```
  Throws:
  
  SAML2MetaException