Package net.webpdf.wsclient.session.connection.http

Class HttpAuthorizationHandler

java.lang.Object

net.webpdf.wsclient.session.connection.http.HttpAuthorizationHandler

All Implemented Interfaces:

HttpExecChainHandler, org.apache.hc.client5.http.classic.ExecChainHandler

public class HttpAuthorizationHandler
extends Object
implements HttpExecChainHandler

An instance of HttpAuthorizationHandler may be used for a ClassicHttpRequest as a ExecChainHandler to provide authorization in the context of the ExecChain.

Constructor Summary

Constructors

Constructor	Description
HttpAuthorizationHandler(@NotNull Session session)	Instantiates a new HttpAuthorizationHandler for a given Session.

Method Summary

Modifier and Type	Method	Description
org.apache.hc.core5.http.ClassicHttpResponse	execute(@NotNull org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest, org.apache.hc.client5.http.classic.ExecChain.Scope scope, @NotNull org.apache.hc.client5.http.classic.ExecChain execChain)	When this method is called the HttpAuthorizationHandler acts as a ExecChainHandler in the context of a ExecChain.
@NotNull String	getExecChainHandlerName()	Provides a name for the HttpAuthorizationHandler in the context of a ExecChain.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpAuthorizationHandler

public HttpAuthorizationHandler(@NotNull
                                @NotNull Session session)

Instantiates a new HttpAuthorizationHandler for a given Session.

Parameters:

session - The Session to provide authorization for.

Method Detail

execute

public org.apache.hc.core5.http.ClassicHttpResponse execute(@NotNull
                                                            @NotNull org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest,
                                                            @NotNull
                                                            org.apache.hc.client5.http.classic.ExecChain.Scope scope,
                                                            @NotNull
                                                            @NotNull org.apache.hc.client5.http.classic.ExecChain execChain)
                                                     throws IOException,
                                                            org.apache.hc.core5.http.HttpException

When this method is called the HttpAuthorizationHandler acts as a ExecChainHandler in the context of a ExecChain. It will check whether the given request contains an HttpHeaders.AUTHORIZATION Header and in case it is missing it shall provide such a Header according to the provided and active Session.

Specified by:

execute in interface org.apache.hc.client5.http.classic.ExecChainHandler

Parameters:

classicHttpRequest - the actual request.

scope - the execution scope.

execChain - the next element in the request execution chain.

Throws:

IOException

org.apache.hc.core5.http.HttpException

getExecChainHandlerName

@NotNull
public @NotNull String getExecChainHandlerName()

Provides a name for the HttpAuthorizationHandler in the context of a ExecChain.

Specified by:

getExecChainHandlerName in interface HttpExecChainHandler

Returns:

A name for the HttpAuthorizationHandler in the context of a ExecChain.