Package org.pac4j.http.client.direct

Class ParameterClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.DirectClient
org.pac4j.http.client.direct.ParameterClient
All Implemented Interfaces:
org.pac4j.core.client.Client
public class ParameterClient extends org.pac4j.core.client.DirectClient

This class is the client to authenticate users directly based on a provided parameter (in a GET and/or POST request).

Since:
1.8.0
Author:
Jerome Leleu

  • Field Summary

    Fields inherited from class org.pac4j.core.client.BaseClient

    logger, saveProfileInSession

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParameterClient()
     
    ParameterClient(String parameterName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)
     
    ParameterClient(String parameterName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParameterName()
     
    protected void
    internalInit(boolean forceReinit)
     
    boolean
    isSupportGetRequest()
     
    boolean
    isSupportPostRequest()
     
    void
    setParameterName(String parameterName)
     
    void
    setSupportGetRequest(boolean supportGetRequest)
     
    void
    setSupportPostRequest(boolean supportPostRequest)
     
    String
    toString()
     

    Methods inherited from class org.pac4j.core.client.DirectClient

    afterInternalInit, beforeInternalInit, getCredentials, getLogoutAction, getRedirectionAction

    Methods inherited from class org.pac4j.core.client.BaseClient

    addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession

    Methods inherited from class org.pac4j.core.util.InitializableObject

    getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ParameterClient

      public ParameterClient()

    • ParameterClient

      public ParameterClient(String parameterName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)

    • ParameterClient

      public ParameterClient(String parameterName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)

  • Method Details

    • internalInit

      protected void internalInit(boolean forceReinit)
      Specified by:
      internalInit in class org.pac4j.core.util.InitializableObject

    • getParameterName

      public String getParameterName()

    • setParameterName

      public void setParameterName(String parameterName)

    • isSupportGetRequest

      public boolean isSupportGetRequest()

    • setSupportGetRequest

      public void setSupportGetRequest(boolean supportGetRequest)

    • isSupportPostRequest

      public boolean isSupportPostRequest()

    • setSupportPostRequest

      public void setSupportPostRequest(boolean supportPostRequest)

    • toString

      public String toString()
      Overrides:
      toString in class org.pac4j.core.client.DirectClient