public class IndirectBasicAuthClient extends IndirectClient<UsernamePasswordCredentials,CommonProfile>
This class is the client to authenticate users through HTTP basic auth. It was previously named: BasicAuthClient
.
For authentication, the user is redirected to the callback url. If the user is not authenticated by basic auth, a
specific exception : HttpAction
is returned which must be handled by the application to force
authentication.
ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, urlResolver
logger
Constructor and Description |
---|
IndirectBasicAuthClient() |
IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator) |
IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator,
ProfileCreator profileCreator) |
IndirectBasicAuthClient(String realmName,
Authenticator usernamePasswordAuthenticator) |
Modifier and Type | Method and Description |
---|---|
protected void |
clientInit(WebContext context)
Initialize the client.
|
String |
getRealmName() |
protected UsernamePasswordCredentials |
retrieveCredentials(WebContext context)
Retrieve the credentials.
|
void |
setRealmName(String realmName) |
String |
toString() |
computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver
addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setName, setProfileCreator
init, reinit
public IndirectBasicAuthClient()
public IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator)
public IndirectBasicAuthClient(String realmName, Authenticator usernamePasswordAuthenticator)
public IndirectBasicAuthClient(Authenticator usernamePasswordAuthenticator, ProfileCreator profileCreator)
protected void clientInit(WebContext context)
IndirectClient
clientInit
in class IndirectClient<UsernamePasswordCredentials,CommonProfile>
context
- the web contextprotected UsernamePasswordCredentials retrieveCredentials(WebContext context) throws HttpAction
BaseClient
retrieveCredentials
in class BaseClient<UsernamePasswordCredentials,CommonProfile>
context
- the web contextHttpAction
- whether an additional HTTP action is requiredpublic String getRealmName()
public void setRealmName(String realmName)
public String toString()
toString
in class IndirectClient<UsernamePasswordCredentials,CommonProfile>
Copyright © 2017. All rights reserved.