com.opendxl.streaming.client

Interface ChannelAuth

All Known Implementing Classes:

ChannelAuthToken, ChannelAuthUserPass

public interface ChannelAuth

Interface to be implemented by Authentication classes responsible for adding the Authorization header to channel requests.

Method Summary

Modifier and Type	Method and Description
void	authenticate(org.apache.http.HttpRequest httpRequest) Adds the http header with the Authorization token to the given http request
void	reset() Purge any credentials cached from a previous authentication.

Method Detail

authenticate

void authenticate(org.apache.http.HttpRequest httpRequest)
           throws PermanentError,
                  TemporaryError

Adds the http header with the Authorization token to the given http request

Parameters:

httpRequest - request where to add the Authorization header

Throws:

TemporaryError - if an unexpected (but possibly recoverable) authentication error occurs for the request.

PermanentError - if the request fails due to the user not being authenticated successfully or if the user is unauthorized to make the request or if a non-recoverable authentication error occurs for the request.

reset

void reset()

Purge any credentials cached from a previous authentication.