Class ParameterStore

  • All Implemented Interfaces:
    Serializable

    public final class ParameterStore
    extends Object
    implements Serializable
    Serializable session payload containing captured form login parameters, indexed by pac4j client name.
    Since:
    8.6.0
    See Also:
    Serialized Form
    • Constructor Detail

      • ParameterStore

        public ParameterStore()
    • Method Detail

      • getPassthroughParameter

        public Set<ParameterValue> getPassthroughParameter​(org.pac4j.core.client.Client client)
        Returns the captured values for a client.
        Parameters:
        client - the client, or null when none is selected
        Returns:
        the stored values, or an empty set when no values exist
      • addPassthroughParameter

        public void addPassthroughParameter​(org.pac4j.core.client.Client client,
                                            ParameterValue param)
        Records a captured value, deduplicating identical name/value pairs.
        Parameters:
        client - the client that will receive the value
        param - the captured target name and value
      • isEmpty

        public boolean isEmpty()
        Indicates whether no client has captured parameters.
        Returns:
        whether the store is empty
      • getPassthroughParameters

        public Map<String,​Set<ParameterValue>> getPassthroughParameters()
        Values per client; insertion order is retained within each client's values.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object