okhttp3

接口 Authenticator

public interface Authenticator

Responds to an authentication challenge from either a remote web server or a proxy server. Implementations may either attempt to satisfy the challenge by returning a request that includes an authorization header, or they may refuse the challenge by returning null. In this case the unauthenticated response will be returned to the caller that triggered it.

Implementations should check if the initial request already included an attempt to authenticate. If so it is likely that further attempts will not be useful and the authenticator should give up.

When authentication is requested by an origin server, the response code is 401 and the implementation should respond with a new request that sets the "Authorization" header.

   

  Request authenticate(Route route, Response response) {
      if (response.request().header("Authorization") != null) {
        return null; // Give up, we've already failed to authenticate.
      }

      String credential = Credentials.basic(...)
        return response.request().newBuilder()
          .header("Authorization", credential)
          .build();
  }

 

When authentication is requested by a proxy server, the response code is 407 and the implementation should respond with a new request that sets the "Proxy-Authorization" header.

   

  Request authenticate(Route route, Response response) {
    if (response.request().header("Proxy-Authorization") != null) {
      return null; // Give up, we've already failed to authenticate.
    }

    String credential = Credentials.basic(...)
    return response.request().newBuilder()
        .header("Proxy-Authorization", credential)
        .build();
  }

 

Applications may configure OkHttp with an authenticator for origin servers, or proxy servers, or both.

字段概要

字段

限定符和类型	字段和说明
static Authenticator	NONE An authenticator that knows no credentials and makes no attempt to authenticate.

方法概要

限定符和类型	方法和说明
Request	authenticate(Request request) Returns a tunnel request if a TLS tunnel via an HTTP proxy.
Request	authenticate(Route route, Response response) Returns a request that includes a credential to satisfy an authentication challenge in response.

字段详细资料

NONE

static final Authenticator NONE

An authenticator that knows no credentials and makes no attempt to authenticate.

方法详细资料

authenticate

@Nullable
Request authenticate(Request request)
                        throws java.io.IOException

Returns a tunnel request if a TLS tunnel via an HTTP proxy. Returns a request before connect socket. Returns null if no authentication.

抛出:

java.io.IOException

authenticate

@Nullable
Request authenticate(Route route,
                               Response response)
                        throws java.io.IOException

Returns a request that includes a credential to satisfy an authentication challenge in response. Returns null if the challenge cannot be satisfied.

抛出:

java.io.IOException