org.pac4j.http.credentials.authenticator

Class RestAuthenticator

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.profile.definition.ProfileDefinitionAware<RestProfile>

org.pac4j.http.credentials.authenticator.RestAuthenticator

All Implemented Interfaces:

Authenticator<UsernamePasswordCredentials>

public class RestAuthenticator
extends ProfileDefinitionAware<RestProfile>
implements Authenticator<UsernamePasswordCredentials>

Authenticates against a REST API. The username/password are passed as a basic auth via a POST request, the JSON response is a user profile.

Since:

2.1.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
RestAuthenticator()
RestAuthenticator(String url)

Method Summary

Modifier and Type	Method and Description
protected void	buildProfile(UsernamePasswordCredentials credentials, String body)
protected String	callRestApi(String username, String password) Return the body from the REST API, passing the username/pasword auth.
com.fasterxml.jackson.databind.ObjectMapper	getMapper()
String	getUrl()
protected void	internalInit(WebContext context) Internal initialization of the object.
void	setMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
void	setUrl(String url)
String	toString()
void	validate(UsernamePasswordCredentials credentials, WebContext context) Validate the credentials.

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinitionAware

defaultProfileDefinition, getProfileDefinition, setProfileDefinition

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

init, reinit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RestAuthenticator

public RestAuthenticator()

RestAuthenticator

public RestAuthenticator(String url)

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableWebObject

Parameters:

context - the web context

validate

public void validate(UsernamePasswordCredentials credentials,
                     WebContext context)
              throws HttpAction,
                     CredentialsException

Description copied from interface: Authenticator

Validate the credentials. It should throw a CredentialsException in case of failure.

Specified by:

validate in interface Authenticator<UsernamePasswordCredentials>

Parameters:

credentials - the given credentials

context - the web context

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid

buildProfile

protected void buildProfile(UsernamePasswordCredentials credentials,
                            String body)
                     throws HttpAction,
                            CredentialsException

Throws:

HttpAction

CredentialsException

callRestApi

protected String callRestApi(String username,
                             String password)
                      throws HttpAction,
                             CredentialsException

Return the body from the REST API, passing the username/pasword auth. To be overridden using another HTTP client if necessary.

Parameters:

username - the username

password - the password

Returns:

the response body

Throws:

HttpAction - whether an extra HTTP action is required

CredentialsException - whether an authentication error occurs

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

setMapper

public void setMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

toString

public String toString()

Overrides:

toString in class Object