Package org.apereo.cas.consent

Interface ConsentDecisionBuilder

  • All Superinterfaces:
    java.io.Serializable
    public interface ConsentDecisionBuilder
extends java.io.Serializable
    This is ConsentDecisionBuilder.
    Since:
    5.2.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ConsentDecision build​(org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService, java.lang.String principalId, java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)
      Build consent decision consent decision.
      boolean doesAttributeReleaseRequireConsent​(ConsentDecision decision, java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)
      Is consent decision valid for attributes?
      java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> getConsentableAttributesFrom​(ConsentDecision decision)
      Gets consentable attributes from the consent decision.
      ConsentDecision update​(ConsentDecision consent, java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)
      Update consent decision.

    • Method Detail

      • update

        ConsentDecision update​(ConsentDecision consent,
                       java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)
        Update consent decision.
        Parameters:
        consent - the consent
        attributes - the attributes
        Returns:
        the consent decision

      • build

        ConsentDecision build​(org.apereo.cas.authentication.principal.Service service,
                      org.apereo.cas.services.RegisteredService registeredService,
                      java.lang.String principalId,
                      java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)
        Build consent decision consent decision.
        Parameters:
        service - the service
        registeredService - the registered service
        principalId - the principal id
        attributes - the attributes
        Returns:
        the consent decision

      • doesAttributeReleaseRequireConsent

        boolean doesAttributeReleaseRequireConsent​(ConsentDecision decision,
                                           java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)
        Is consent decision valid for attributes?
        Parameters:
        decision - the decision
        attributes - the attributes
        Returns:
        true /false

      • getConsentableAttributesFrom

        java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> getConsentableAttributesFrom​(ConsentDecision decision)
        Gets consentable attributes from the consent decision. The operation is allowed to change attributes and/or unpack attributes from encoded strings, etc.
        Parameters:
        decision - the decision
        Returns:
        the consentable attributes