org.pac4j.http.credentials.authenticator

Class IpRegexpAuthenticator

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.http.credentials.authenticator.IpRegexpAuthenticator

All Implemented Interfaces:

Authenticator<TokenCredentials>

public class IpRegexpAuthenticator
extends ProfileDefinitionAware<IpProfile>
implements Authenticator<TokenCredentials>

Authenticates users based on their IP and a regexp pattern.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
IpRegexpAuthenticator()
IpRegexpAuthenticator(String regexpPattern)

Method Summary

Modifier and Type	Method and Description
protected void	internalInit() Internal initialization of the object.
void	setRegexpPattern(String regexpPattern)
String	toString()
void	validate(TokenCredentials 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.InitializableObject

init

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

IpRegexpAuthenticator

public IpRegexpAuthenticator()

IpRegexpAuthenticator

public IpRegexpAuthenticator(String regexpPattern)

Method Detail

internalInit

protected void internalInit()

Description copied from class: InitializableObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableObject

validate

public void validate(TokenCredentials credentials,
                     WebContext context)

Description copied from interface: Authenticator

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

Specified by:

validate in interface Authenticator<TokenCredentials>

Parameters:

credentials - the given credentials

context - the web context

setRegexpPattern

public void setRegexpPattern(String regexpPattern)

toString

public String toString()

Overrides:

toString in class Object