Package com.squareup.okhttp

Class Handshake

java.lang.Object

com.squareup.okhttp.Handshake

public final class Handshake
extends Object

A record of a TLS handshake. For HTTPS clients, the client is local and the remote server is its peer.

This value object describes a completed handshake. Use SSLSocketFactory to set policy for new handshakes.

Method Summary

Modifier and Type	Method	Description
String	cipherSuite()	Returns a cipher suite name like "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA".
boolean	equals(Object other)	Compares this instance with the specified object and indicates if they are equal.
static Handshake	get(String cipherSuite, List<Certificate> peerCertificates, List<Certificate> localCertificates)
static Handshake	get(SSLSession session)
int	hashCode()	Returns an integer hash code for this object.
List<Certificate>	localCertificates()	Returns a possibly-empty list of certificates that identify this peer.
Principal	localPrincipal()	Returns the local principle, or null if this peer is anonymous.
List<Certificate>	peerCertificates()	Returns a possibly-empty list of certificates that identify the remote peer.
Principal	peerPrincipal()	Returns the remote peer's principle, or null if that peer is anonymous.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static Handshake get(SSLSession session)

get

public static Handshake get(String cipherSuite,
                            List<Certificate> peerCertificates,
                            List<Certificate> localCertificates)

cipherSuite

public String cipherSuite()

Returns a cipher suite name like "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA".

peerCertificates

public List<Certificate> peerCertificates()

Returns a possibly-empty list of certificates that identify the remote peer.

peerPrincipal

public Principal peerPrincipal()

Returns the remote peer's principle, or null if that peer is anonymous.

localCertificates

public List<Certificate> localCertificates()

Returns a possibly-empty list of certificates that identify this peer.

localPrincipal

public Principal localPrincipal()

Returns the local principle, or null if this peer is anonymous.

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)