org.springframework.http.client.support

Class BasicAuthenticationInterceptor

java.lang.Object

org.springframework.http.client.support.BasicAuthenticationInterceptor

All Implemented Interfaces:

ClientHttpRequestInterceptor

public class BasicAuthenticationInterceptor
extends java.lang.Object
implements ClientHttpRequestInterceptor

ClientHttpRequestInterceptor to apply a given HTTP Basic Authentication username/password pair, unless a custom Authorization header has been set before.

Since:

5.1.1

Author:

Juergen Hoeller

See Also:

HttpHeaders.setBasicAuth(java.lang.String, java.lang.String), HttpHeaders.AUTHORIZATION

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset
private java.lang.String	password
private java.lang.String	username

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticationInterceptor(java.lang.String username, java.lang.String password) Create a new interceptor which adds Basic Authentication for the given username and password.
BasicAuthenticationInterceptor(java.lang.String username, java.lang.String password, java.nio.charset.Charset charset) Create a new interceptor which adds Basic Authentication for the given username and password, encoded using the specified charset.

Method Summary

Modifier and Type	Method and Description
ClientHttpResponse	intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) Intercept the given request, and return a response.

Methods inherited from class java.lang.Object

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

Field Detail

username

private final java.lang.String username

password

private final java.lang.String password

charset

@Nullable
private final java.nio.charset.Charset charset

Constructor Detail

BasicAuthenticationInterceptor

public BasicAuthenticationInterceptor(java.lang.String username,
                                      java.lang.String password)

Create a new interceptor which adds Basic Authentication for the given username and password.

Parameters:

username - the username to use

password - the password to use

See Also:

HttpHeaders.setBasicAuth(String, String)

BasicAuthenticationInterceptor

public BasicAuthenticationInterceptor(java.lang.String username,
                                      java.lang.String password,
                                      @Nullable
                                      java.nio.charset.Charset charset)

Create a new interceptor which adds Basic Authentication for the given username and password, encoded using the specified charset.

Parameters:

username - the username to use

password - the password to use

charset - the charset to use

See Also:

HttpHeaders.setBasicAuth(String, String, Charset)

Method Detail

intercept

public ClientHttpResponse intercept(HttpRequest request,
                                    byte[] body,
                                    ClientHttpRequestExecution execution)
                             throws java.io.IOException

Description copied from interface: ClientHttpRequestInterceptor

Intercept the given request, and return a response. The given ClientHttpRequestExecution allows the interceptor to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:

1. Examine the request and body
2. Optionally wrap the request to filter HTTP attributes.
3. Optionally modify the body of the request.
4. Either
   • execute the request using ClientHttpRequestExecution.execute(org.springframework.http.HttpRequest, byte[]),
   or
   • do not execute the request to block the execution altogether.
5. Optionally wrap the response to filter HTTP attributes.

Specified by:

intercept in interface ClientHttpRequestInterceptor

Parameters:

request - the request, containing method, URI, and headers

body - the body of the request

execution - the request execution

Returns:

the response

Throws:

java.io.IOException - in case of I/O errors