Package org.pac4j.http.client.direct

Class IpClient

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

This class is the client to authenticate users directly based on their IP address.

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
    IpClient()
    Constructor for IpClient.
    IpClient(org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)
    Constructor for IpClient.
    IpClient(org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
    Constructor for IpClient.

  • 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

    • IpClient

      public IpClient()

      Constructor for IpClient.

    • IpClient

      public IpClient(org.pac4j.core.credentials.authenticator.Authenticator tokenAuthenticator)

      Constructor for IpClient.

      Parameters:
      tokenAuthenticator - a Authenticator object

    • IpClient

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

      Constructor for IpClient.

      Parameters:
      tokenAuthenticator - 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