org.forgerock.caf.authentication.framework

Class AuthenticationFramework

java.lang.Object

org.forgerock.caf.authentication.framework.AuthenticationFramework

public final class AuthenticationFramework
extends Object

An authentication framework for protecting all types of resources.

The authentication framework can be configured with a single session authentication module, which will authenticate requests based on some session identifier, and an ordered list of authentication modules, that are executed in order on a first succeeds wins basis.

The authentication framework must be configured with a non-null AuditApi instance, so that it can audit authentication outcomes.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_AUTH_CONTEXT The name of the HTTP Request attribute where any additional authentication context information will be set.
static String	ATTRIBUTE_AUTH_PRINCIPAL The name of the HTTP Request attribute where the principal name of the user/client making the request will be set.
static String	ATTRIBUTE_REQUEST_ID The name of the HTTP Request attribute where the unique id of the request will be set.
static org.slf4j.Logger	LOG Runtime slf4j debug logger.

Method Summary

Modifier and Type	Method and Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Runtime slf4j debug logger.

ATTRIBUTE_AUTH_PRINCIPAL

public static final String ATTRIBUTE_AUTH_PRINCIPAL

The name of the HTTP Request attribute where the principal name of the user/client making the request will be set.

See Also:

Constant Field Values

ATTRIBUTE_AUTH_CONTEXT

public static final String ATTRIBUTE_AUTH_CONTEXT

The name of the HTTP Request attribute where any additional authentication context information will be set. It MUST contain a Map if present.

See Also:

Constant Field Values

ATTRIBUTE_REQUEST_ID

public static final String ATTRIBUTE_REQUEST_ID

The name of the HTTP Request attribute where the unique id of the request will be set.

See Also:

Constant Field Values

Method Detail

toString

public String toString()

Overrides:

toString in class Object