Package org.pac4j.http.client.direct

Class DirectFormClient

  • All Implemented Interfaces:
    org.pac4j.core.client.Client
    public class DirectFormClient
extends org.pac4j.core.client.DirectClient
    This class is the client to authenticate users, based on form HTTP parameters.
    Since:
    1.8.6
    Author:
    Jerome Leleu

    • Field Summary

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

        logger, saveProfileInSession

    • Constructor Summary

      Constructors 
      Constructor Description
      DirectFormClient()  
      DirectFormClient​(java.lang.String usernameParameter, java.lang.String passwordParameter, org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)  
      DirectFormClient​(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)  
      DirectFormClient​(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getPasswordParameter()  
      java.lang.String getUsernameParameter()  
      protected void internalInit​(boolean forceReinit)  
      void setPasswordParameter​(java.lang.String passwordParameter)  
      void setUsernameParameter​(java.lang.String usernameParameter)  
      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

      • DirectFormClient

        public DirectFormClient()

      • DirectFormClient

        public DirectFormClient​(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)

      • DirectFormClient

        public DirectFormClient​(java.lang.String usernameParameter,
                        java.lang.String passwordParameter,
                        org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)

      • DirectFormClient

        public DirectFormClient​(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator,
                        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

      • getUsernameParameter

        public java.lang.String getUsernameParameter()

      • setUsernameParameter

        public void setUsernameParameter​(java.lang.String usernameParameter)

      • getPasswordParameter

        public java.lang.String getPasswordParameter()

      • setPasswordParameter

        public void setPasswordParameter​(java.lang.String passwordParameter)

      • toString

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