Module org.cruk.clarity.api

Package org.cruk.clarity.api.http

Class HttpComponentsClientHttpRequestFactoryBasicAuth

java.lang.Object

org.springframework.http.client.HttpComponentsClientHttpRequestFactory

org.cruk.clarity.api.http.HttpComponentsClientHttpRequestFactoryBasicAuth

All Implemented Interfaces:

AuthenticatingClientHttpRequestFactory, DisposableBean, ClientHttpRequestFactory

public class HttpComponentsClientHttpRequestFactoryBasicAuth
extends HttpComponentsClientHttpRequestFactory
implements AuthenticatingClientHttpRequestFactory

Client HTTP request factory adding basic authentication to the request.

Since:

2.23.1

See Also:

• This post about adding basic authentication to REST template.

Constructor Summary

Constructors

Constructor	Description
HttpComponentsClientHttpRequestFactoryBasicAuth()	Constructor.
HttpComponentsClientHttpRequestFactoryBasicAuth(HttpClient client)	Constructor with an HTTP client.
HttpComponentsClientHttpRequestFactoryBasicAuth(HttpClient client, CredentialsProvider credentialsProvider)	Constructor with an HTTP client and credentials provider.

Method Summary

Modifier and Type	Method	Description
protected HttpContext	createHttpContext(HttpMethod httpMethod, URI uri)	Provide the HTTP context set up for basic authentication by this factory.
Credentials	getCredentials()	Get the credentials currently in use.
CredentialsProvider	getCredentialsProvider()	Get the credentials provider used by this factory.
HttpHost	getHost()	Get the host to which the credentials will be applied.
void	setCredentials(URI uri, Credentials credentials)	Set the credentials based on the protocol, host and port in the URL.
void	setCredentials(HttpHost host, Credentials credentials)	Set the credentials based on the HTTP host specification.
void	setCredentialsProvider(CredentialsProvider credentialsProvider)	Set the credentials provider to use.

Methods inherited from class org.springframework.http.client.HttpComponentsClientHttpRequestFactory

createHttpUriRequest, createRequest, createRequestConfig, destroy, getHttpClient, mergeRequestConfig, postProcessHttpRequest, setBufferRequestBody, setConnectionRequestTimeout, setConnectionRequestTimeout, setConnectTimeout, setConnectTimeout, setHttpClient, setHttpContextFactory, setReadTimeout, setReadTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.client.ClientHttpRequestFactory

createRequest

Constructor Details

HttpComponentsClientHttpRequestFactoryBasicAuth

public HttpComponentsClientHttpRequestFactoryBasicAuth()

Constructor.

HttpComponentsClientHttpRequestFactoryBasicAuth

public HttpComponentsClientHttpRequestFactoryBasicAuth(HttpClient client)

Constructor with an HTTP client.

Parameters:

client - The underlying HTTP client.

HttpComponentsClientHttpRequestFactoryBasicAuth

public HttpComponentsClientHttpRequestFactoryBasicAuth(HttpClient client,
 CredentialsProvider credentialsProvider)

Constructor with an HTTP client and credentials provider.

Parameters:

client - The underlying HTTP client.

credentialsProvider - The authentication credentials provider.

Method Details

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

Get the credentials provider used by this factory.

Returns:

The authentication credentials provider.

setCredentialsProvider

public void setCredentialsProvider(CredentialsProvider credentialsProvider)

Set the credentials provider to use.

Parameters:

credentialsProvider - The authentication credentials provider.

createHttpContext

protected HttpContext createHttpContext(HttpMethod httpMethod,
 URI uri)

Provide the HTTP context set up for basic authentication by this factory. Despite the method being called "create", the same HttpContext can be returned each time.

Overrides:

createHttpContext in class HttpComponentsClientHttpRequestFactory

Parameters:

httpMethod - The HTTP method.

uri - The request URI.

Returns:

The HttpContext.

getHost

public HttpHost getHost()

Get the host to which the credentials will be applied.

Specified by:

getHost in interface AuthenticatingClientHttpRequestFactory

Returns:

The HttpHost specification to which the authentication applies.

getCredentials

public Credentials getCredentials()

Get the credentials currently in use.

Specified by:

getCredentials in interface AuthenticatingClientHttpRequestFactory

Returns:

The credentials.

setCredentials

public void setCredentials(URI uri,
 Credentials credentials)

Set the credentials based on the protocol, host and port in the URL.

Specified by:

setCredentials in interface AuthenticatingClientHttpRequestFactory

Parameters:

uri - The URI of the HTTP server.

credentials - The credentials to use, or null to reset.

setCredentials

public void setCredentials(HttpHost host,
 Credentials credentials)

Set the credentials based on the HTTP host specification.

Specified by:

setCredentials in interface AuthenticatingClientHttpRequestFactory

Parameters:

host - The host specification of the HTTP server.

credentials - The credentials to use, or null to reset.