com.squareup.okhttp

Class Address

java.lang.Object

com.squareup.okhttp.Address

public final class Address
extends 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 and hostname verifier.

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

Constructor Summary

Constructors

Constructor and Description
Address(String uriHost, int uriPort, SocketFactory socketFactory, SSLSocketFactory sslSocketFactory, HostnameVerifier hostnameVerifier, CertificatePinner certificatePinner, Authenticator authenticator, Proxy proxy, List<Protocol> protocols, List<ConnectionSpec> connectionSpecs, ProxySelector proxySelector)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Compares this instance with the specified object and indicates if they are equal.
Authenticator	getAuthenticator() Returns the client's authenticator.
CertificatePinner	getCertificatePinner() Returns this address's certificate pinner.
List<ConnectionSpec>	getConnectionSpecs()
HostnameVerifier	getHostnameVerifier() Returns the hostname verifier, or null if this is not an HTTPS address.
List<Protocol>	getProtocols() Returns the protocols the client supports.
Proxy	getProxy() Returns this address's explicitly-specified HTTP proxy, or null to delegate to the proxy selector.
ProxySelector	getProxySelector() Returns this address's proxy selector.
SocketFactory	getSocketFactory() Returns the socket factory for new connections.
SSLSocketFactory	getSslSocketFactory() Returns the SSL socket factory, or null if this is not an HTTPS address.
String	getUriHost() Returns the hostname of the origin server.
int	getUriPort() Returns the port of the origin server; typically 80 or 443.
int	hashCode() Returns an integer hash code for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Address

public Address(String uriHost,
               int uriPort,
               SocketFactory socketFactory,
               SSLSocketFactory sslSocketFactory,
               HostnameVerifier hostnameVerifier,
               CertificatePinner certificatePinner,
               Authenticator authenticator,
               Proxy proxy,
               List<Protocol> protocols,
               List<ConnectionSpec> connectionSpecs,
               ProxySelector proxySelector)

Method Detail

getUriHost

public String getUriHost()

Returns the hostname of the origin server.

getUriPort

public int getUriPort()

Returns the port of the origin server; typically 80 or 443. Unlike may getPort() accessors, this method never returns -1.

getSocketFactory

public SocketFactory getSocketFactory()

Returns the socket factory for new connections.

getSslSocketFactory

public SSLSocketFactory getSslSocketFactory()

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

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

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

getAuthenticator

public Authenticator getAuthenticator()

Returns the client's authenticator. This method never returns null.

getProtocols

public List<Protocol> getProtocols()

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

getConnectionSpecs

public List<ConnectionSpec> getConnectionSpecs()

getProxy

public Proxy getProxy()

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

getProxySelector

public ProxySelector getProxySelector()

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.

getCertificatePinner

public CertificatePinner getCertificatePinner()

Returns this address's certificate pinner. Only used for secure connections.

equals

public boolean equals(Object other)

Description copied from class: Object

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

other - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)