OkHttp

An HTTP+SPDY client for Android and Java applications.

Download

Downloadable .jars can be found on the GitHub download page.

You can also depend on the .jar through Maven:

<dependency>
    <groupId>com.squareup</groupId>
    <artifactId>okhttp</artifactId>
    <version>(insert latest version)</version>
</dependency>

Known Issues

The SPDY implementation is incomplete:

• Settings frames are not honored. Flow control is not implemented.
• It assumes a well-behaved peer. If the peer sends an invalid frame, OkHttp's SPDY client will not respond with the required RST frame.

OkHttp uses the platform's ProxySelector. Prior to Android 4.0, ProxySelector didn't honor the proxyHost and proxyPort system properties for HTTPS connections. Work around this by specifying the https.proxyHost and https.proxyPort system properties when using a proxy with HTTPS.

OkHttp's test suite creates an in-process HTTPS server. Prior to Android 2.3, SSL server sockets were broken, and so HTTPS tests will time out when run on such devices.

Building

On the Desktop

Run OkHttp tests on the desktop with Maven.

mvn clean test

SPDY support uses a Deflater API that wasn't available in Java 6. For this reason SPDY tests will fail with this error: Cannot SPDY; no SYNC_FLUSH available. All other tests should run fine.

On the Desktop with NPN

Using NPN on the desktop uses Jetty-NPN which requires OpenJDK 7+.

mvn clean test -Pspdy-tls

On a Device

Test on a USB-attached Android using Vogar. Unfortunately dx requires that you build with Java 6, otherwise the test class will be silently omitted from the .dex file.

mvn clean
mvn package -DskipTests
vogar \
    --classpath ~/.m2/repository/org/bouncycastle/bcprov-jdk15on/1.47/bcprov-jdk15on-1.47.jar \
    --classpath ~/.m2/repository/com/google/mockwebserver/mockwebserver/20120905/mockwebserver-20120905.jar \
    --classpath target/okhttp-0.9-SNAPSHOT.jar \
    ./src/test/java

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.