Package org.pac4j.http.client.direct

Class 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​(java.lang.String parameterName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)  
      ParameterClient​(java.lang.String parameterName, org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getParameterName()  
      protected void internalInit​(boolean forceReinit)  
      boolean isSupportGetRequest()  
      boolean isSupportPostRequest()  
      void setParameterName​(java.lang.String parameterName)  
      void setSupportGetRequest​(boolean supportGetRequest)  
      void setSupportPostRequest​(boolean supportPostRequest)  
      java.lang.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 Detail

      • ParameterClient

        public ParameterClient()

      • ParameterClient

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

      • ParameterClient

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

    • Method Detail

      • internalInit

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

      • getParameterName

        public java.lang.String getParameterName()

      • setParameterName

        public void setParameterName​(java.lang.String parameterName)

      • isSupportGetRequest

        public boolean isSupportGetRequest()

      • setSupportGetRequest

        public void setSupportGetRequest​(boolean supportGetRequest)

      • isSupportPostRequest

        public boolean isSupportPostRequest()

      • setSupportPostRequest

        public void setSupportPostRequest​(boolean supportPostRequest)

      • toString

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