com.okta.commons.http.authc

Interface RequestAuthenticator

All Known Implementing Classes:

DisabledAuthenticator

public interface RequestAuthenticator

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

Since:

0.5.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHORIZATION_HEADER

Method Summary

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

Field Detail

AUTHORIZATION_HEADER

static final java.lang.String AUTHORIZATION_HEADER

See Also:

Constant Field Values

Method Detail

authenticate

void authenticate(Request request)
           throws RequestAuthenticationException

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

Parameters:

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

Throws:

RequestAuthenticationException - when the authentication request cannot be created