io.apimatic.core.authentication

Class HeaderAuth

java.lang.Object

io.apimatic.coreinterfaces.authentication.Authentication

io.apimatic.core.authentication.AuthCredential

io.apimatic.core.authentication.HeaderAuth

public class HeaderAuth
extends AuthCredential

HeaderAuth is an implementation of Authentication that supports HTTP authentication through HTTP Headers.

Constructor Summary

Constructors

Constructor and Description
HeaderAuth(Map<String,String> authParams)

Method Summary

Modifier and Type	Method and Description
io.apimatic.coreinterfaces.http.request.Request	apply(io.apimatic.coreinterfaces.http.request.Request httpRequest) Apply the Header authentication.

Methods inherited from class io.apimatic.core.authentication.AuthCredential

getAuthParams, validate

Methods inherited from class io.apimatic.coreinterfaces.authentication.Authentication

getErrorMessage, isValid, setErrorMessage, setValidity

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderAuth

public HeaderAuth(Map<String,String> authParams)

Parameters:

authParams - Map of authentication parameters.

Method Detail

apply

public io.apimatic.coreinterfaces.http.request.Request apply(io.apimatic.coreinterfaces.http.request.Request httpRequest)

Apply the Header authentication.

Specified by:

apply in class io.apimatic.coreinterfaces.authentication.Authentication

Parameters:

httpRequest - The HTTP request on which the auth is to be applied.

Returns:

Request The HTTP request after applying auth.