com.readystatesoftware.chuck

Class ChuckInterceptor

java.lang.Object

com.readystatesoftware.chuck.ChuckInterceptor

public final class ChuckInterceptor
extends java.lang.Object

An OkHttp Interceptor which persists and displays HTTP activity in your application for later inspection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChuckInterceptor.Period

Constructor Summary

Constructors

Constructor and Description
ChuckInterceptor(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
Response	intercept(Chain chain)
ChuckInterceptor	maxContentLength(long max) Set the maximum length for request and response content before it is truncated.
ChuckInterceptor	retainDataFor(ChuckInterceptor.Period period) Set the retention period for HTTP transaction data captured by this interceptor.
ChuckInterceptor	showNotification(boolean show) Control whether a notification is shown while HTTP activity is recorded.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChuckInterceptor

public ChuckInterceptor(android.content.Context context)

Parameters:

context - The current Context.

Method Detail

showNotification

public ChuckInterceptor showNotification(boolean show)

Control whether a notification is shown while HTTP activity is recorded.

Parameters:

show - true to show a notification, false to suppress it.

Returns:

The ChuckInterceptor instance.

maxContentLength

public ChuckInterceptor maxContentLength(long max)

Set the maximum length for request and response content before it is truncated. Warning: setting this value too high may cause unexpected results.

Parameters:

max - the maximum length (in bytes) for request/response content.

Returns:

The ChuckInterceptor instance.

retainDataFor

public ChuckInterceptor retainDataFor(ChuckInterceptor.Period period)

Set the retention period for HTTP transaction data captured by this interceptor. The default is one week.

Parameters:

period - the peroid for which to retain HTTP transaction data.

Returns:

The ChuckInterceptor instance.

intercept

public Response intercept(Chain chain)
                   throws java.io.IOException

Throws:

java.io.IOException