org.apereo.cas.consent.ConsentEngine Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cas-server-support-consent-api Show documentation
There is a newer version: 7.1.0
Show newest version
package org.apereo.cas.consent;

import org.apereo.cas.authentication.Authentication;
import org.apereo.cas.authentication.principal.Service;
import org.apereo.cas.services.RegisteredService;

import java.io.Serializable;
import java.time.temporal.ChronoUnit;
import java.util.List;
import java.util.Map;

/**
 * This is {@link ConsentEngine}.
 *
 * @author Misagh Moayyed
 * @since 5.1.0
 */
public interface ConsentEngine extends Serializable {

    /**
     * Default implementation bean name.
     */
    String BEAN_NAME = "consentEngine";

    /**
     * Store consent decision.
     *
     * @param service           the service
     * @param registeredService the registered service
     * @param authentication    the authentication
     * @param reminder          the reminder
     * @param reminderTimeUnit  the reminder time unit
     * @param options           the options
     * @return the stored decision
     * @throws Throwable the throwable
     */
    ConsentDecision storeConsentDecision(Service service,
                                         RegisteredService registeredService,
                                         Authentication authentication,
                                         long reminder,
                                         ChronoUnit reminderTimeUnit,
                                         ConsentReminderOptions options) throws Throwable;

    /**
     * Find consent decision consent decision.
     *
     * @param service           the service
     * @param registeredService the registered service
     * @param authentication    the authentication
     * @return the consent decision
     */
    ConsentDecision findConsentDecision(Service service,
                                        RegisteredService registeredService,
                                        Authentication authentication);

    /**
     * Gets consentable attributes.
     *
     * @param authentication    the authentication
     * @param service           the service
     * @param registeredService the registered service
     * @return the consentable attributes
     * @throws Throwable the throwable
     */
    Map> resolveConsentableAttributesFrom(Authentication authentication,
                                                               Service service,
                                                               RegisteredService registeredService) throws Throwable;

    /**
     * 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.
     *
     * @param decision the decision
     * @return the consentable attributes
     */
    Map> resolveConsentableAttributesFrom(ConsentDecision decision);

    /**
     * Is consent required?
     *
     * @param service           the service
     * @param registeredService the registered service
     * @param authentication    the authentication
     * @return true /false
     * @throws Throwable the throwable
     */
    ConsentQueryResult isConsentRequiredFor(Service service, RegisteredService registeredService, Authentication authentication) throws Throwable;

    /**
     * Gets consent repository.
     *
     * @return the consent repository
     */
    ConsentRepository getConsentRepository();
}