Package com.squareup.okhttp

Class ConnectionSpec

  • public final class ConnectionSpec
extends Object
    Specifies configuration for the socket connection that HTTP traffic travels through. For https: URLs, this includes the TLS version and cipher suites to use when negotiating a secure connection.

    • Field Detail

      • MODERN_TLS

        public static final ConnectionSpec MODERN_TLS
        A modern TLS connection with extensions like SNI and ALPN available.

      • COMPATIBLE_TLS

        public static final ConnectionSpec COMPATIBLE_TLS
        A backwards-compatible fallback connection for interop with obsolete servers.

      • CLEARTEXT

        public static final ConnectionSpec CLEARTEXT
        Unencrypted, unauthenticated connections for http: URLs.

    • Method Detail

      • isTls

        public boolean isTls()

      • cipherSuites

        public List<CipherSuite> cipherSuites()
        Returns the cipher suites to use for a connection. This method can return null if the cipher suites enabled by default should be used.

      • supportsTlsExtensions

        public boolean supportsTlsExtensions()

      • isCompatible

        public boolean isCompatible​(SSLSocket socket)
        Returns true if the socket, as currently configured, supports this ConnectionSpec. In order for a socket to be compatible the enabled cipher suites and protocols must intersect.

        For cipher suites, at least one of the required cipher suites must match the socket's enabled cipher suites. If there are no required cipher suites the socket must have at least one cipher suite enabled.

        For protocols, at least one of the required protocols must match the socket's enabled protocols.

      • 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)

      • toString

        public String toString()
        Description copied from class: Object
        Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 
           getClass().getName() + '@' + Integer.toHexString(hashCode())

        See Writing a useful toString method if you intend implementing your own toString method.

        Overrides:
        toString in class Object
        Returns:
        a printable representation of this object.