Package org.pac4j.http.client.direct

Class DirectDigestAuthClient

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

This class is the client to authenticate users directly through HTTP digest auth.

Add the commons-codec dependency to use this class.

Since:
1.9.0
Author:
Mircea Carasel

  • Field Summary

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

    logger, saveProfileInSession

  • Constructor Summary

    Constructors
    Constructor
    Description
    DirectDigestAuthClient()
    Constructor for DirectDigestAuthClient.
    DirectDigestAuthClient(org.pac4j.core.credentials.authenticator.Authenticator digestAuthenticator)
    Constructor for DirectDigestAuthClient.
    DirectDigestAuthClient(org.pac4j.core.credentials.authenticator.Authenticator digestAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)
    Constructor for DirectDigestAuthClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<org.pac4j.core.credentials.Credentials>
    getCredentials(org.pac4j.core.context.CallContext ctx)
    Per RFC 2617 If a server receives a request for an access-protected object, and an acceptable Authorization header is not sent, the server responds with a "401 Unauthorized" status code, and a WWW-Authenticate header
    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, 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

    • DirectDigestAuthClient

      public DirectDigestAuthClient()

      Constructor for DirectDigestAuthClient.

    • DirectDigestAuthClient

      public DirectDigestAuthClient(org.pac4j.core.credentials.authenticator.Authenticator digestAuthenticator)

      Constructor for DirectDigestAuthClient.

      Parameters:
      digestAuthenticator - a Authenticator object

    • DirectDigestAuthClient

      public DirectDigestAuthClient(org.pac4j.core.credentials.authenticator.Authenticator digestAuthenticator, org.pac4j.core.profile.creator.ProfileCreator profileCreator)

      Constructor for DirectDigestAuthClient.

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

    • getCredentials

      public Optional<org.pac4j.core.credentials.Credentials> getCredentials(org.pac4j.core.context.CallContext ctx)
      Per RFC 2617 If a server receives a request for an access-protected object, and an acceptable Authorization header is not sent, the server responds with a "401 Unauthorized" status code, and a WWW-Authenticate header
      Specified by:
      getCredentials in interface org.pac4j.core.client.Client
      Overrides:
      getCredentials in class org.pac4j.core.client.BaseClient