Package org.forgerock.openig.openam

Class PolicyDecisionContext

java.lang.Object

org.forgerock.services.context.AbstractContext

org.forgerock.openig.openam.PolicyDecisionContext

All Implemented Interfaces:

Context

public class PolicyDecisionContext
extends AbstractContext

A PolicyDecisionContext convey policy decision information to downstream filters and handlers.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Context's name.

Fields inherited from class org.forgerock.services.context.AbstractContext

data

Method Summary

Modifier and Type	Method	Description
Map<String,Boolean>	getActions()	Returns the unmodifiable map of actions provided in the policy decision (can be empty, but never null).
Map<String,List<String>>	getAdvices()	Returns the unmodifiable map of advices provided in the policy decision (can be empty, but never null).
Map<String,List<String>>	getAttributes()	Returns the unmodifiable map of attributes provided in the policy decision (can be empty, but never null).
JsonValue	getJsonActions()	Returns the unmodifiable actions entry in the policy decision (never null).
JsonValue	getJsonAdvices()	Returns the unmodifiable advices entry in the policy decision (never null).
JsonValue	getJsonAttributes()	Returns the unmodifiable attributes entry in the policy decision (never null).
String	getResource()	Returns the resource entry in the policy decision (never null).

Methods inherited from class org.forgerock.services.context.AbstractContext

as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

Context's name.

See Also:

• Constant Field Values

Method Details

getAttributes

public Map<String,List<String>> getAttributes()

Returns the unmodifiable map of attributes provided in the policy decision (can be empty, but never null).

Returns:

the map of attributes provided in the policy decision

getJsonAttributes

public JsonValue getJsonAttributes()

Returns the unmodifiable attributes entry in the policy decision (never null).

The returned JsonValue wraps a Map<String, List<String>> just like:

     {
         "dn": [ "uid=bjensen,dc=example,dc=com" ],
         "emails": [ "bjensen@example.com", "jensen@acme.org" ]
     }
     
 

Returns:

the unmodifiable attributes entry in the policy decision (never null).

getAdvices

public Map<String,List<String>> getAdvices()

Returns the unmodifiable map of advices provided in the policy decision (can be empty, but never null).

Returns:

the map of advices provided in the policy decision

getJsonAdvices

public JsonValue getJsonAdvices()

Returns the unmodifiable advices entry in the policy decision (never null).

The returned JsonValue wraps a Map<String, List<String>> just like:

     {
         "AuthLevelConditionAdvice": [ "3" ]
     }
     
 

Returns:

the unmodifiable advices entry in the policy decision (never null).

getActions

public Map<String,Boolean> getActions()

Returns the unmodifiable map of actions provided in the policy decision (can be empty, but never null).

Returns:

the map of actions provided in the policy decision

getJsonActions

public JsonValue getJsonActions()

Returns the unmodifiable actions entry in the policy decision (never null).

The returned JsonValue wraps a Map<String, Boolean> just like:

     
      {
          "POST": true
      }
     
 

Returns:

the unmodifiable actions entry in the policy decision (never null).

getResource

public String getResource()

Returns the resource entry in the policy decision (never null).

Returns:

the resource entry in the policy decision (never null).