com.opendxl.streaming.client.auth

Class ChannelAuthToken

java.lang.Object

com.opendxl.streaming.client.auth.ChannelAuthToken

All Implemented Interfaces:

ChannelAuth

public class ChannelAuthToken
extends java.lang.Object
implements ChannelAuth

Authentication class where a given fixed token is used in Authorization headers of channel requests.

Constructor Summary

Constructors

Constructor and Description
ChannelAuthToken(java.lang.String token)

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() This method does no operation in ChannelAuthToken class.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelAuthToken

public ChannelAuthToken(java.lang.String token)

Parameters:

token - token value to use in the Authorization HTTP Header. The token is added to HTTP requests when the authenticate(HttpRequest) method is invoked.

Method Detail

authenticate

public void authenticate(org.apache.http.HttpRequest httpRequest)

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

Specified by:

authenticate in interface ChannelAuth

Parameters:

httpRequest - request where to add the Authorization header

reset

public void reset()

This method does no operation in ChannelAuthToken class. If a new token has to be provided, then it is necessary to create a new ChannelAuthToken instance and provide the new token to the ChannelAuthToken(String) constructor.

Specified by:

reset in interface ChannelAuth