RestAuthenticator (pac4j for HTTP protocol 4.3.1 API)

java.lang.Object
- org.pac4j.core.util.InitializableObject
- - 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 Description

RestAuthenticator()

RestAuthenticator(String url)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`
`void`	`setMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)`
`void`	`setUrl(String url)`
`String`	`toString()`
`void`	`validate(UsernamePasswordCredentials credentials, WebContext context)`

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinitionAware
defaultProfileDefinition, getProfileDefinition, setProfileDefinition

Methods inherited from class org.pac4j.core.util.InitializableObject
init, isInitialized

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()
```
Specified by:

internalInit in class InitializableObject

validate

public void validate(UsernamePasswordCredentials credentials,
                     WebContext context)

Specified by:: validate in interface Authenticator<UsernamePasswordCredentials>

buildProfile

protected void buildProfile(UsernamePasswordCredentials credentials,
                            String body)

callRestApi
```
protected String callRestApi(String username,
                             String password)
```
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

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