Package org.pac4j.http.client.direct
Class DirectDigestAuthClient
- java.lang.Object
-
- org.pac4j.core.util.InitializableObject
-
- org.pac4j.core.client.BaseClient<C>
-
- org.pac4j.core.client.DirectClient<DigestCredentials>
-
- org.pac4j.http.client.direct.DirectDigestAuthClient
-
- All Implemented Interfaces:
Client<DigestCredentials>
public class DirectDigestAuthClient extends DirectClient<DigestCredentials>
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
-
-
Constructor Summary
Constructors Constructor Description DirectDigestAuthClient()
DirectDigestAuthClient(Authenticator digestAuthenticator)
DirectDigestAuthClient(Authenticator digestAuthenticator, ProfileCreator profileCreator)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
clientInit()
String
getRealm()
protected Optional<DigestCredentials>
retrieveCredentials(WebContext context)
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 headervoid
setRealm(String realm)
String
toString()
-
Methods inherited from class org.pac4j.core.client.DirectClient
getCredentials, getLogoutAction, getRedirectionAction, internalInit
-
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, notifySessionRenewal, renewUserProfile, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated
-
Methods inherited from class org.pac4j.core.util.InitializableObject
init, isInitialized
-
-
-
-
Constructor Detail
-
DirectDigestAuthClient
public DirectDigestAuthClient()
-
DirectDigestAuthClient
public DirectDigestAuthClient(Authenticator digestAuthenticator)
-
DirectDigestAuthClient
public DirectDigestAuthClient(Authenticator digestAuthenticator, ProfileCreator profileCreator)
-
-
Method Detail
-
clientInit
protected void clientInit()
- Specified by:
clientInit
in classDirectClient<DigestCredentials>
-
retrieveCredentials
protected Optional<DigestCredentials> retrieveCredentials(WebContext context)
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- Overrides:
retrieveCredentials
in classBaseClient<DigestCredentials>
-
getRealm
public String getRealm()
-
setRealm
public void setRealm(String realm)
-
toString
public String toString()
- Overrides:
toString
in classBaseClient<DigestCredentials>
-
-