okhttp3

Class Address

java.lang.Object

okhttp3.Address

public final class Address
extends java.lang.Object

A specification for a connection to an origin server. For simple connections, this is the server's hostname and port. If an explicit proxy is requested (or no proxy is explicitly requested), this also includes that proxy information. For secure connections the address also includes the SSL socket factory, hostname verifier, and certificate pinner.

HTTP requests that share the same Address may also share the same Connection.

Constructor Summary

Constructors

Constructor and Description

Address(java.lang.String uriHost, int uriPort, Dns dns, javax.net.SocketFactory socketFactory, javax.net.ssl.SSLSocketFactory sslSocketFactory, javax.net.ssl.HostnameVerifier hostnameVerifier, CertificatePinner certificatePinner, Authenticator proxyAuthenticator, java.net.Proxy proxy, java.util.List<Protocol> protocols, java.util.List<ConnectionSpec> connectionSpecs, java.net.ProxySelector proxySelector)

Method Summary

Modifier and Type	Method and Description
CertificatePinner	certificatePinner() Returns this address's certificate pinner, or null if this is not an HTTPS address.
java.util.List<ConnectionSpec>	connectionSpecs()
Dns	dns() Returns the service that will be used to resolve IP addresses for hostnames.
boolean	equals(java.lang.Object other)
int	hashCode()
javax.net.ssl.HostnameVerifier	hostnameVerifier() Returns the hostname verifier, or null if this is not an HTTPS address.
java.util.List<Protocol>	protocols() Returns the protocols the client supports.
java.net.Proxy	proxy() Returns this address's explicitly-specified HTTP proxy, or null to delegate to the proxy selector.
Authenticator	proxyAuthenticator() Returns the client's proxy authenticator.
java.net.ProxySelector	proxySelector() Returns this address's proxy selector.
javax.net.SocketFactory	socketFactory() Returns the socket factory for new connections.
javax.net.ssl.SSLSocketFactory	sslSocketFactory() Returns the SSL socket factory, or null if this is not an HTTPS address.
java.lang.String	toString()
HttpUrl	url() Returns a URL with the hostname and port of the origin server.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Address

public Address(java.lang.String uriHost,
               int uriPort,
               Dns dns,
               javax.net.SocketFactory socketFactory,
               @Nullable
               javax.net.ssl.SSLSocketFactory sslSocketFactory,
               @Nullable
               javax.net.ssl.HostnameVerifier hostnameVerifier,
               @Nullable
               CertificatePinner certificatePinner,
               Authenticator proxyAuthenticator,
               @Nullable
               java.net.Proxy proxy,
               java.util.List<Protocol> protocols,
               java.util.List<ConnectionSpec> connectionSpecs,
               java.net.ProxySelector proxySelector)

Method Detail

url

public HttpUrl url()

Returns a URL with the hostname and port of the origin server. The path, query, and fragment of this URL are always empty, since they are not significant for planning a route.

dns

public Dns dns()

Returns the service that will be used to resolve IP addresses for hostnames.

socketFactory

public javax.net.SocketFactory socketFactory()

Returns the socket factory for new connections.

proxyAuthenticator

public Authenticator proxyAuthenticator()

Returns the client's proxy authenticator.

protocols

public java.util.List<Protocol> protocols()

Returns the protocols the client supports. This method always returns a non-null list that contains minimally Protocol.HTTP_1_1.

connectionSpecs

public java.util.List<ConnectionSpec> connectionSpecs()

proxySelector

public java.net.ProxySelector proxySelector()

Returns this address's proxy selector. Only used if the proxy is null. If none of this selector's proxies are reachable, a direct connection will be attempted.

proxy

@Nullable
public java.net.Proxy proxy()

Returns this address's explicitly-specified HTTP proxy, or null to delegate to the proxy selector.

sslSocketFactory

@Nullable
public javax.net.ssl.SSLSocketFactory sslSocketFactory()

Returns the SSL socket factory, or null if this is not an HTTPS address.

hostnameVerifier

@Nullable
public javax.net.ssl.HostnameVerifier hostnameVerifier()

Returns the hostname verifier, or null if this is not an HTTPS address.

certificatePinner

@Nullable
public CertificatePinner certificatePinner()

Returns this address's certificate pinner, or null if this is not an HTTPS address.

equals

public boolean equals(@Nullable
                      java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object