org.jboss.aerogear.android.pipe.module

Interface PipeModule

public interface PipeModule

A PipeModule allows special actions to be taken during certain phases of the Pipe life cycle.

Method Summary

Modifier and Type	Method and Description
boolean	handleError(HttpException exception) This will try to resolve an error.
ModuleFields	loadModule(URI relativeURI, String httpMethod, byte[] requestBody) When construction a HTTP request, the module can prepare several parameters to be applied to the request body, query, and headers.

Method Detail

loadModule

ModuleFields loadModule(URI relativeURI,
                        String httpMethod,
                        byte[] requestBody)

When construction a HTTP request, the module can prepare several parameters to be applied to the request body, query, and headers.

Parameters:

relativeURI - the URI the request will be made for.

httpMethod - the HTTP method (GET, POST, PUT, DELETE) which will be used

requestBody - the body of the request, if known. May be empty may not be null.

Returns:

moduleFields which

handleError

boolean handleError(HttpException exception)

This will try to resolve an error.

Parameters:

exception - the exception to be resolved

Returns:

if the error resolution was successful and the attempt should be retried.