org.apereo.cas.consent

Interface ConsentEngine

All Superinterfaces:

java.io.Serializable

public interface ConsentEngine
extends java.io.Serializable

This is ConsentEngine.

Since:

5.1.0

Method Summary

Modifier and Type	Method and Description
ConsentDecision	findConsentDecision(org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.Authentication authentication) Find consent decision consent decision.
org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,ConsentDecision>	isConsentRequiredFor(org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.Authentication authentication) Is consent required?
java.util.Map<java.lang.String,java.lang.Object>	resolveConsentableAttributesFrom(org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService) Gets consentable attributes.
java.util.Map<java.lang.String,java.lang.Object>	resolveConsentableAttributesFrom(ConsentDecision decision) Gets consentable attributes from an existing consent decision.
ConsentDecision	storeConsentDecision(org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.Authentication authentication, long reminder, java.time.temporal.ChronoUnit reminderTimeUnit, ConsentOptions options) Store consent decision.

Method Detail

storeConsentDecision

ConsentDecision storeConsentDecision(org.apereo.cas.authentication.principal.Service service,
                                     org.apereo.cas.services.RegisteredService registeredService,
                                     org.apereo.cas.authentication.Authentication authentication,
                                     long reminder,
                                     java.time.temporal.ChronoUnit reminderTimeUnit,
                                     ConsentOptions options)

Store consent decision.

Parameters:

service - the service

registeredService - the registered service

authentication - the authentication

reminder - the reminder

reminderTimeUnit - the reminder time unit

options - the options

Returns:

the stored decision

findConsentDecision

ConsentDecision findConsentDecision(org.apereo.cas.authentication.principal.Service service,
                                    org.apereo.cas.services.RegisteredService registeredService,
                                    org.apereo.cas.authentication.Authentication authentication)

Find consent decision consent decision.

Parameters:

service - the service

registeredService - the registered service

authentication - the authentication

Returns:

the consent decision

resolveConsentableAttributesFrom

java.util.Map<java.lang.String,java.lang.Object> resolveConsentableAttributesFrom(org.apereo.cas.authentication.Authentication authentication,
                                                                                  org.apereo.cas.authentication.principal.Service service,
                                                                                  org.apereo.cas.services.RegisteredService registeredService)

Gets consentable attributes.

Parameters:

authentication - the authentication

service - the service

registeredService - the registered service

Returns:

the consentable attributes

resolveConsentableAttributesFrom

java.util.Map<java.lang.String,java.lang.Object> resolveConsentableAttributesFrom(ConsentDecision decision)

Gets consentable attributes from an existing consent decision. Typically decisions are signed and encoded, so this op will need to ensure the correct attribute names and values in the existing decision record are produced.

Parameters:

decision - the decision

Returns:

the consentable attributes

isConsentRequiredFor

org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,ConsentDecision> isConsentRequiredFor(org.apereo.cas.authentication.principal.Service service,
                                                                                            org.apereo.cas.services.RegisteredService registeredService,
                                                                                            org.apereo.cas.authentication.Authentication authentication)

Is consent required?

Parameters:

service - the service

registeredService - the registered service

authentication - the authentication

Returns:

true /false