Package org.forgerock.openig.openam

Class PolicyDecisionContext

  • All Implemented Interfaces:
    org.forgerock.services.context.Context
    public class PolicyDecisionContext
extends org.forgerock.services.context.AbstractContext
    A PolicyDecisionContext convey policy decision information to downstream filters and handlers.

    • Field Summary

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

        data

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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).
      org.forgerock.json.JsonValue getJsonAdvices()
      Returns the unmodifiable advices entry in the policy decision (never null).
      org.forgerock.json.JsonValue getJsonAttributes()
      Returns the unmodifiable attributes entry in the policy decision (never null).

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

        asContext, containsContext, containsContext, getContext, getContextName, getId, getParent, isRootContext, toJsonValue, toString

    • Method Detail

      • 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 org.forgerock.json.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 org.forgerock.json.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).