Class DirectFormClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.DirectClient
org.pac4j.http.client.direct.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
    Constructor for DirectFormClient.
    DirectFormClient(String usernameParameter, String passwordParameter, org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)
    Constructor for DirectFormClient.
    DirectFormClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator)
    Constructor for DirectFormClient.
    DirectFormClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
    Constructor for DirectFormClient.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    internalInit(boolean forceReinit)

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

    afterInternalInit, beforeInternalInit, getLogoutAction, getRedirectionAction, processLogout

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

    addAuthorizationGenerator, addAuthorizationGenerators, checkCredentials, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, toString, validateCredentials

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

    getInitialized, 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

    • DirectFormClient

      public DirectFormClient()

      Constructor for DirectFormClient.

    • DirectFormClient

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

      Constructor for DirectFormClient.

      Parameters:
      usernamePasswordAuthenticator - a Authenticator object
    • DirectFormClient

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

      Constructor for DirectFormClient.

      Parameters:
      usernameParameter - a String object
      passwordParameter - a String object
      usernamePasswordAuthenticator - a Authenticator object
    • DirectFormClient

      public DirectFormClient(org.pac4j.core.credentials.authenticator.Authenticator usernamePasswordAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)

      Constructor for DirectFormClient.

      Parameters:
      usernamePasswordAuthenticator - a Authenticator object
      profileCreator - a ProfileCreator object
  • Method Details

    • internalInit

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