Package org.wildfly.security.http

Class HttpAuthenticator

java.lang.Object

org.wildfly.security.http.HttpAuthenticator

public class HttpAuthenticator
extends Object

A HTTP based authenticator responsible for performing the authentication of the current request based on the policies of the associated SecurityDomain.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpAuthenticator.Builder	A Builder to configure and create an instance of HttpAuthenticator.

Method Summary

Modifier and Type	Method	Description
boolean	authenticate()	Perform authentication for the request.
static HttpAuthenticator.Builder	builder()	Construct and return a new Builder to configure and create an instance of HttpAuthenticator.
SecurityIdentity	login(String username, String password)	Perform a login for the supplied username and password using the pre-configured mechanism name.

Methods inherited from class java.lang.Object

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

Method Detail

authenticate

public boolean authenticate()
                     throws HttpAuthenticationException

Perform authentication for the request.

Returns:

true if the call should be allowed to continue within the web server, false if the call should be returning to the client.

Throws:

HttpAuthenticationException

login

public SecurityIdentity login(String username,
                              String password)

Perform a login for the supplied username and password using the pre-configured mechanism name.

Parameters:

username - the username to use for authentication.

password - the password to use for authentication.

Returns:

A SecurityIdentity is authentication and authorization is successful.

builder

public static HttpAuthenticator.Builder builder()

Construct and return a new Builder to configure and create an instance of HttpAuthenticator.

Returns:

a new Builder to configure and create an instance of HttpAuthenticator.