Package net.shibboleth.idp.consent.flow.impl

Class ConsentFlowDescriptor

  • All Implemented Interfaces:
    Predicate<org.opensaml.profile.context.ProfileRequestContext>, net.shibboleth.idp.profile.FlowDescriptor, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent
    Direct Known Subclasses:
    AttributeReleaseFlowDescriptor
    public class ConsentFlowDescriptor
extends net.shibboleth.idp.profile.interceptor.ProfileInterceptorFlowDescriptor
    Descriptor for a consent flow. A consent flow models a sequence of actions which retrieves consent from storage as well as extracts consent from user input.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean compareValues
      Whether consent equality includes comparing consent values.
      private int expandedMaxStoredRecords
      Expanded maximum number of records stored in the storage service.
      private long expandedStorageThreshold
      Value size at which expanded maximum takes effect.
      private Duration lifetime
      Time to expire consent storage records.
      private int maxStoredRecords
      Maximum number of records stored in the storage service.

      • Fields inherited from class net.shibboleth.idp.profile.interceptor.ProfileInterceptorFlowDescriptor

        FLOW_ID_PREFIX

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean compareValues()
      Whether consent equality includes comparing consent values.
      int getExpandedNumberOfStoredRecords()
      Get the maximum number of records to keep in the storage service if the expanded size threshold is met.
      long getExpandedStorageThreshold()
      Get the storage value size at which the expanded maximum record size kicks in.
      Duration getLifetime()
      Time to expire consent storage records.
      int getMaximumNumberOfStoredRecords()
      Get the maximum number of records to keep in the storage service if the expanded size threshold is not met.
      void setCompareValues​(boolean flag)
      Set whether consent equality includes comparing consent values.
      void setExpandedNumberOfStoredRecords​(int maximum)
      Set the maximum number of records to keep in the storage service if the expanded size threshold is met.
      void setExpandedStorageThreshold​(long size)
      Set the storage value size at which the expanded maximum record size kicks in.
      void setLifetime​(Duration consentLifetime)
      Set time to expire consent storage records.
      void setMaximumNumberOfStoredRecords​(int maximum)
      Set the maximum number of records to keep in the storage service if the expanded size threshold is not met.

      • Methods inherited from class net.shibboleth.idp.profile.interceptor.ProfileInterceptorFlowDescriptor

        equals, getStorageService, hashCode, isNonBrowserSupported, setActivationCondition, setNonBrowserSupported, setStorageService, test, toString

      • Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

        setId

      • Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

        doInitialize, getId

      • Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

        destroy, doDestroy, initialize, isDestroyed, isInitialized

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

        destroy, isDestroyed

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiableComponent

        setId

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

        getId

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

        initialize, isInitialized

    • Field Detail

      • compareValues

        private boolean compareValues
        Whether consent equality includes comparing consent values.

      • lifetime

        @Nonnull
private Duration lifetime
        Time to expire consent storage records. Default value: 1 year.

      • maxStoredRecords

        private int maxStoredRecords
        Maximum number of records stored in the storage service.

      • expandedMaxStoredRecords

        private int expandedMaxStoredRecords
        Expanded maximum number of records stored in the storage service.

      • expandedStorageThreshold

        private long expandedStorageThreshold
        Value size at which expanded maximum takes effect. Default value : 1024 * 1024

    • Constructor Detail

      • ConsentFlowDescriptor

        public ConsentFlowDescriptor()
        Constructor.

    • Method Detail

      • compareValues

        public boolean compareValues()
        Whether consent equality includes comparing consent values.
        Returns:
        true if consent equality includes comparing consent values

      • getLifetime

        @Nonnull
public Duration getLifetime()
        Time to expire consent storage records.
        Returns:
        time to expire consent storage records

      • getMaximumNumberOfStoredRecords

        public int getMaximumNumberOfStoredRecords()
        Get the maximum number of records to keep in the storage service if the expanded size threshold is not met.
        Returns:
        the maximum number of records, or <=0 for no limit

      • getExpandedNumberOfStoredRecords

        public int getExpandedNumberOfStoredRecords()
        Get the maximum number of records to keep in the storage service if the expanded size threshold is met.
        Returns:
        the maximum number of records, or <=0 for no limit

      • getExpandedStorageThreshold

        public long getExpandedStorageThreshold()
        Get the storage value size at which the expanded maximum record size kicks in.
        Returns:
        storage value size to enable expanded record maximum

      • setCompareValues

        public void setCompareValues​(boolean flag)
        Set whether consent equality includes comparing consent values.
        Parameters:
        flag - true if consent equality includes comparing consent values

      • setLifetime

        public void setLifetime​(@Nonnull
                        Duration consentLifetime)
        Set time to expire consent storage records.
        Parameters:
        consentLifetime - time to expire consent storage records

      • setMaximumNumberOfStoredRecords

        public void setMaximumNumberOfStoredRecords​(int maximum)
        Set the maximum number of records to keep in the storage service if the expanded size threshold is not met.
        Parameters:
        maximum - the maximum number of records, or <=0 for no limit

      • setExpandedNumberOfStoredRecords

        public void setExpandedNumberOfStoredRecords​(int maximum)
        Set the maximum number of records to keep in the storage service if the expanded size threshold is met.
        Parameters:
        maximum - the maximum number of records, or <=0 for no limit

      • setExpandedStorageThreshold

        public void setExpandedStorageThreshold​(long size)
        Set the storage value size at which the expanded maximum record size kicks in.

        Defaults to 1024^2

        Parameters:
        size - size threshold