org.pac4j.http.client.direct

Class IpClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.DirectClient<C,CommonProfile>

org.pac4j.http.client.direct.DirectHttpClient<TokenCredentials>

org.pac4j.http.client.direct.IpClient

All Implemented Interfaces:

Cloneable, Client<TokenCredentials,CommonProfile>

public class IpClient
extends DirectHttpClient<TokenCredentials>

This class is the client to authenticate users directly based on their IP address.

It returns a HttpProfile.

Since:

1.8.0

Author:

Jerome Leleu

See Also:

HttpProfile

Field Summary

Fields inherited from class org.pac4j.http.client.direct.DirectHttpClient

extractor

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

logger

Constructor Summary

Constructors

Constructor and Description
IpClient()
IpClient(TokenAuthenticator tokenAuthenticator)
IpClient(TokenAuthenticator tokenAuthenticator, ProfileCreator profileCreator)

Method Summary

Modifier and Type	Method and Description
ClientType	getClientType()
protected void	internalInit(WebContext context)
protected IpClient	newClient()

Methods inherited from class org.pac4j.http.client.direct.DirectHttpClient

clone, getAuthenticator, getCredentials, getProfileCreator, retrieveUserProfile, setAuthenticator, setProfileCreator, toString

Methods inherited from class org.pac4j.core.client.DirectClient

redirect

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

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

IpClient

public IpClient()

IpClient

public IpClient(TokenAuthenticator tokenAuthenticator)

IpClient

public IpClient(TokenAuthenticator tokenAuthenticator,
                ProfileCreator profileCreator)

Method Detail

internalInit

protected void internalInit(WebContext context)

Overrides:

internalInit in class DirectHttpClient<TokenCredentials>

newClient

protected IpClient newClient()

Specified by:

newClient in class BaseClient<TokenCredentials,CommonProfile>

getClientType

public ClientType getClientType()

Specified by:

getClientType in class BaseClient<TokenCredentials,CommonProfile>