com.stormpath.sdk.impl.http.authc

Interface RequestAuthenticator

All Known Implementing Classes:

BasicAuthenticationRequestAuthenticator, BasicRequestAuthenticator, SAuthc1RequestAuthenticator

public interface RequestAuthenticator

Interface to be implemented by HTTP authentication schemes. Such scheme defines the way the communication with the Stormpath API server will be authenticated.

Since:

0.9.3

See Also:

BasicRequestAuthenticator, SAuthc1RequestAuthenticator, AuthenticationScheme

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.

Method Detail

authenticate

void authenticate(Request request,
                ApiKey apiKey)
                  throws RequestAuthenticationException

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

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