org.pac4j.saml.credentials.authenticator

Class SAML2Authenticator

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

org.pac4j.saml.credentials.authenticator.SAML2Authenticator

All Implemented Interfaces:

Authenticator<SAML2Credentials>

public class SAML2Authenticator
extends ProfileDefinitionAware<SAML2Profile>
implements Authenticator<SAML2Credentials>

Authenticator for SAML 2.0

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHN_CONTEXT
static String	ISSUER_ID
protected org.slf4j.Logger	logger
static String	SAML_CONDITION_NOT_BEFORE_ATTRIBUTE
static String	SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE
static String	SAML_NAME_ID_FORMAT
static String	SAML_NAME_ID_NAME_QUALIFIER
static String	SAML_NAME_ID_SP_NAME_QUALIFIER
static String	SAML_NAME_ID_SP_PROVIDED_ID
static String	SESSION_INDEX

Constructor Summary

Constructors

Constructor and Description
SAML2Authenticator()

Method Summary

Modifier and Type	Method and Description
protected void	internalInit(WebContext context) Internal initialization of the object.
void	validate(SAML2Credentials 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, toString, wait, wait, wait

Field Detail

SAML_CONDITION_NOT_BEFORE_ATTRIBUTE

public static final String SAML_CONDITION_NOT_BEFORE_ATTRIBUTE

See Also:

Constant Field Values

SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE

public static final String SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE

See Also:

Constant Field Values

SESSION_INDEX

public static final String SESSION_INDEX

See Also:

Constant Field Values

ISSUER_ID

public static final String ISSUER_ID

See Also:

Constant Field Values

AUTHN_CONTEXT

public static final String AUTHN_CONTEXT

See Also:

Constant Field Values

SAML_NAME_ID_FORMAT

public static final String SAML_NAME_ID_FORMAT

See Also:

Constant Field Values

SAML_NAME_ID_NAME_QUALIFIER

public static final String SAML_NAME_ID_NAME_QUALIFIER

See Also:

Constant Field Values

SAML_NAME_ID_SP_NAME_QUALIFIER

public static final String SAML_NAME_ID_SP_NAME_QUALIFIER

See Also:

Constant Field Values

SAML_NAME_ID_SP_PROVIDED_ID

public static final String SAML_NAME_ID_SP_PROVIDED_ID

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Constructor Detail

SAML2Authenticator

public SAML2Authenticator()

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(SAML2Credentials 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<SAML2Credentials>

Parameters:

credentials - the given credentials

context - the web context

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid