com.stormpath.sdk.impl.http.authc

Class BasicRequestAuthenticator

java.lang.Object

com.stormpath.sdk.impl.http.authc.BasicRequestAuthenticator

All Implemented Interfaces:

RequestAuthenticator

public class BasicRequestAuthenticator
extends Object
implements RequestAuthenticator

This RequestAuthenticator implements a HTTP Basic Authentication scheme. This defines the HTTP authentication scheme to be used when communicating with the Stormpath API server. The `Client` gets the request authenticator configured via ClientBuilder.setAuthenticationScheme(com.stormpath.sdk.client.AuthenticationScheme)

Since:

0.9.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATION_SCHEME
static String	AUTHORIZATION_HEADER
static String	STORMPATH_DATE_HEADER
static String	TIME_ZONE
static String	TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
BasicRequestAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(Request request, ApiKey apiKey) Implementations of this operation will prepare the authentication information as expected by the Stormpath API server.

Methods inherited from class java.lang.Object

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

Field Detail

AUTHORIZATION_HEADER

public static final String AUTHORIZATION_HEADER

See Also:

Constant Field Values

STORMPATH_DATE_HEADER

public static final String STORMPATH_DATE_HEADER

See Also:

Constant Field Values

AUTHENTICATION_SCHEME

public static final String AUTHENTICATION_SCHEME

See Also:

Constant Field Values

TIMESTAMP_FORMAT

public static final String TIMESTAMP_FORMAT

See Also:

Constant Field Values

TIME_ZONE

public static final String TIME_ZONE

See Also:

Constant Field Values

Constructor Detail

BasicRequestAuthenticator

public BasicRequestAuthenticator()

Method Detail

authenticate

public void authenticate(Request request,
                ApiKey apiKey)
                  throws RequestAuthenticationException

Description copied from interface: RequestAuthenticator

Implementations of this operation will prepare the authentication information as expected by the Stormpath API server.

Specified by:

authenticate in interface RequestAuthenticator

Parameters:

request - the request that will be sent to Stormpath API server, it shall be modified by the implementating classes in order to insert here the authentication information

apiKey - provides the authentication data that will be used to create the proper authentication information for the specific scheme the implementation defines.

Throws:

RequestAuthenticationException - when the authentication request cannot be created