ScopeEvaluator (OpenAM Server Only 7.3.2 Documentation)

All Superinterfaces:

org.forgerock.oauth2.core.plugins.OAuth2Plugin

All Known Subinterfaces:

ScopeValidator
```
@Supported
public interface ScopeEvaluator
extends org.forgerock.oauth2.core.plugins.OAuth2Plugin
```
A plugin or (extension point) that evaluates and returns an OAuth2 access token's scope information.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`evaluateScope(AccessToken accessToken)`	Gets the specified access token's information related to a scope.

- Method Detail
  - evaluateScope
```
@Supported
Map<String,Object> evaluateScope(AccessToken accessToken)
                                throws org.forgerock.oauth2.core.exceptions.ServerException
```
    Gets the specified access token's information related to a scope. For example it can provide a mechanism to associate scopes with profile attribute values, such as if one of the scopes is mail the plugin can provide the resource owner's email address in the returned information returned.
    
    Parameters:
    
    accessToken - The access token.
    
    Returns:
    
    A Map<String, Object> of the access token's information.
    
    Throws:
    
    org.forgerock.oauth2.core.exceptions.ServerException - If the script evaluation fails or any internal server error occurs.