程序包 cn.taketoday.http.client.support

类 BasicAuthenticationInterceptor

java.lang.Object

cn.taketoday.http.client.support.BasicAuthenticationInterceptor

所有已实现的接口:

ClientHttpRequestInterceptor

public class BasicAuthenticationInterceptor
extends Object
implements ClientHttpRequestInterceptor

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

从以下版本开始:

4.0

作者:

Juergen Hoeller, Sam Brannen

另请参阅:

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

字段概要

字段

修饰符和类型	字段	说明
private final String	encodedCredentials

构造器概要

构造器

构造器	说明
BasicAuthenticationInterceptor(String username, String password)	Create a new interceptor which adds Basic Authentication for the given username and password.
BasicAuthenticationInterceptor(String username, String password, Charset charset)	Create a new interceptor which adds Basic Authentication for the given username and password, encoded using the specified charset.

方法概要

修饰符和类型	方法	说明
ClientHttpResponse	intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)	Intercept the given request, and return a response.

从类继承的方法 java.lang.Object

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

字段详细资料

encodedCredentials

private final String encodedCredentials

构造器详细资料

BasicAuthenticationInterceptor

public BasicAuthenticationInterceptor(String username,
 String password)

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

参数:

username - the username to use

password - the password to use

另请参阅:

• HttpHeaders.setBasicAuth(String, String)
• HttpHeaders.encodeBasicAuth(String, String, Charset)

BasicAuthenticationInterceptor

public BasicAuthenticationInterceptor(String username,
 String password,
 @Nullable
 Charset charset)

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

参数:

username - the username to use

password - the password to use

charset - the charset to use

另请参阅:

• HttpHeaders.setBasicAuth(String, String, Charset)
• HttpHeaders.encodeBasicAuth(String, String, Charset)

方法详细资料

intercept

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

从接口复制的说明: 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.
• Either
• execute the request using ClientHttpRequestExecution.execute(cn.taketoday.http.HttpRequest, byte[]),
• or
• do not execute the request to block the execution altogether.
4. Optionally wrap the response to filter HTTP attributes.

指定者:

intercept 在接口中 ClientHttpRequestInterceptor

参数:

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

body - the body of the request

execution - the request execution

返回:

the response

抛出:

IOException - in case of I/O errors