com.ibm.mobilefirstplatform.clientsdk.android.core.api

Class Request

java.lang.Object

BaseRequest

com.ibm.mobilefirstplatform.clientsdk.android.core.api.Request

public class Request
extends BaseRequest

This class is used to create and send network requests.

Constructor Summary

Constructors

Constructor and Description
Request(java.lang.String url, java.lang.String method) Constructs a new resource request with the specified URL, using the specified HTTP method.
Request(java.lang.String url, java.lang.String method, int timeout) Constructs a new resource request with the specified URL, using the specified HTTP method.
Request(java.lang.String url, java.lang.String method, int timeout, int autoRetries) Constructs a new resource request with the specified URL, using the specified HTTP method.

Method Summary

Modifier and Type	Method and Description
void	download(Context context, byte[] data, ProgressListener progressListener, ResponseListener responseListener) Download this resource asynchronously, with the given byte array as the request body.
void	download(Context context, JSONObject json, ProgressListener progressListener, ResponseListener responseListener) Download this resource asynchronously, with the given JSON object as the request body.
void	download(Context context, java.util.Map<java.lang.String,java.lang.String> formParameters, ProgressListener progressListener, ResponseListener responseListener) Download this resource asynchronously, with the given form parameters as the request body.
void	download(Context context, ProgressListener progressListener, ResponseListener responseListener) Download this resource asynchronously, without a request body.
void	download(Context context, java.lang.String requestBody, ProgressListener progressListener, ResponseListener responseListener) Download this resource asynchronously, with the given string as the request body.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders() Returns all the headers that were set for this resource request.
java.lang.String	getMethod() Returns the HTTP method for this resource request.
java.util.Map<java.lang.String,java.lang.String>	getQueryParameters() Returns the query parameters set for this resource request.
int	getTimeout() Returns the timeout for this resource request.
java.lang.String	getUrl() Returns the URL for this resource request.
void	send(Context context, byte[] data, ResponseListener listener) Send this resource request asynchronously, with the given byte array as the request body.
void	send(Context context, ResponseListener listener) Send this resource request asynchronously, without a request body.
void	send(Context context, java.lang.String text, ResponseListener listener) Send this resource request asynchronously, with the given string as the request body.
void	setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers) Sets headers for this resource request.
void	setQueryParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets the query parameters for this resource request.
void	upload(Context context, byte[] data, ProgressListener progressListener, ResponseListener responseListener) Upload a byte array asynchronously.
void	upload(Context context, java.io.File file, ProgressListener progressListener, ResponseListener responseListener) Upload a file asynchronously.
void	upload(Context context, java.lang.String text, ProgressListener progressListener, ResponseListener responseListener) Upload text asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request(java.lang.String url,
               java.lang.String method)

Constructs a new resource request with the specified URL, using the specified HTTP method.

Parameters:

url - The resource URL, may be either relative or absolute.

method - The HTTP method to use

Request

public Request(java.lang.String url,
               java.lang.String method,
               int timeout)

Constructs a new resource request with the specified URL, using the specified HTTP method. Additionally this constructor sets a custom timeout.

Parameters:

url - The resource URL

method - The HTTP method to use.

timeout - The timeout in milliseconds for this request.

Request

public Request(java.lang.String url,
               java.lang.String method,
               int timeout,
               int autoRetries)

Constructs a new resource request with the specified URL, using the specified HTTP method. Additionally this constructor sets a custom timeout and number of times to automatically retry failed requests.

Parameters:

url - The resource URL

method - The HTTP method to use.

timeout - The timeout in milliseconds for this request.

autoRetries - The number of times to retry each request if it fails due to timeout or loss of network connection.

Method Detail

getUrl

public java.lang.String getUrl()

Returns the URL for this resource request.

Returns:

String The URL representing the path for this resource request.

getMethod

public java.lang.String getMethod()

Returns the HTTP method for this resource request.

Returns:

A string containing the name of the HTTP method.

getTimeout

public int getTimeout()

Returns the timeout for this resource request.

Returns:

the timeout for this resource request

getQueryParameters

public java.util.Map<java.lang.String,java.lang.String> getQueryParameters()

Returns the query parameters set for this resource request.

Returns:

A Map containing the query parameters

setQueryParameters

public void setQueryParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Sets the query parameters for this resource request.

Parameters:

parameters - A HashMap containing the query parameters

getHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()

Returns all the headers that were set for this resource request.

Returns:

An array of Headers

setHeaders

public void setHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Sets headers for this resource request. Overrides all headers previously added.

Parameters:

headers - A multimap containing the header names and corresponding values

send

public void send(Context context,
                 ResponseListener listener)

Send this resource request asynchronously, without a request body.

Parameters:

context - The context that will be passed to authentication listener.

listener - The listener whose onSuccess or onFailure methods will be called when this request finishes

send

public void send(Context context,
                 java.lang.String text,
                 ResponseListener listener)

Send this resource request asynchronously, with the given string as the request body. If no Content-Type header was set, this method will set it to "text/plain".

Parameters:

context - The context that will be passed to authentication listener.

text - The text to put in the request body

listener - The listener whose onSuccess or onFailure methods will be called when this request finishes

send

public void send(Context context,
                 byte[] data,
                 ResponseListener listener)

Send this resource request asynchronously, with the given byte array as the request body. This method does not set any Content-Type header; if such a header is required, it must be set before calling this method.

Parameters:

context - The context that will be passed to authentication listener.

data - The byte array to put in the request body

listener - The listener whose onSuccess or onFailure methods will be called when this request finishes

download

public void download(Context context,
                     ProgressListener progressListener,
                     ResponseListener responseListener)

Download this resource asynchronously, without a request body. The download progress will be monitored with a ProgressListener.

Note: This method consumes the InputStream from the response and closes it, so the Response.getResponseByteStream() method will always return null for this request.

Parameters:

context - The context that will be passed to authentication listener.

progressListener - The listener that monitors the download progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes

download

public void download(Context context,
                     java.lang.String requestBody,
                     ProgressListener progressListener,
                     ResponseListener responseListener)

Download this resource asynchronously, with the given string as the request body. The download progress will be monitored with a ProgressListener. If no Content-Type header was set, this method will set it to "text/plain".

Note: This method consumes the InputStream from the response and closes it, so the Response.getResponseByteStream() method will always return null for this request.

Parameters:

context - The context that will be passed to authentication listener.

requestBody - The text to put in the request body

progressListener - The listener that monitors the download progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes

download

public void download(Context context,
                     java.util.Map<java.lang.String,java.lang.String> formParameters,
                     ProgressListener progressListener,
                     ResponseListener responseListener)

Download this resource asynchronously, with the given form parameters as the request body. The download progress will be monitored with a ProgressListener. If no Content-Type header was set, this method will set it to "application/x-www-form-urlencoded".

Note: This method consumes the InputStream from the response and closes it, so the Response.getResponseByteStream() method will always return null for this request.

Parameters:

context - The context that will be passed to authentication listener.

formParameters - The parameters to put in the request body

progressListener - The listener that monitors the download progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes

download

public void download(Context context,
                     JSONObject json,
                     ProgressListener progressListener,
                     ResponseListener responseListener)

Download this resource asynchronously, with the given JSON object as the request body. The download progress will be monitored with a ProgressListener. If no Content-Type header was set, this method will set it to "application/json".

Note: This method consumes the InputStream from the response and closes it, so the Response.getResponseByteStream() method will always return null for this request.

Parameters:

context - The context that will be passed to authentication listener.

json - The JSON object to put in the request body

progressListener - The listener that monitors the download progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes

download

public void download(Context context,
                     byte[] data,
                     ProgressListener progressListener,
                     ResponseListener responseListener)

Download this resource asynchronously, with the given byte array as the request body. The download progress will be monitored with a ProgressListener. This method does not set any Content-Type header; if such a header is required, it must be set before calling this method.

Note: This method consumes the InputStream from the response and closes it, so the Response.getResponseByteStream() method will always return null for this request.

Parameters:

context - The context that will be passed to authentication listener.

data - The byte array to put in the request body

progressListener - The listener that monitors the download progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes

upload

public void upload(Context context,
                   java.lang.String text,
                   ProgressListener progressListener,
                   ResponseListener responseListener)

Upload text asynchronously. If no Content-Type header was set, this method will set it to "text/plain".

Parameters:

context - The context that will be passed to authentication listener.

text - The text to upload

progressListener - The listener that monitors the upload progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes

upload

public void upload(Context context,
                   byte[] data,
                   ProgressListener progressListener,
                   ResponseListener responseListener)

Upload a byte array asynchronously. This method does not set any Content-Type header; if such a header is required, it must be set before calling this method.

Parameters:

context - The context that will be passed to authentication listener.

data - The byte array to upload

progressListener - The listener that monitors the upload progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes

upload

public void upload(Context context,
                   java.io.File file,
                   ProgressListener progressListener,
                   ResponseListener responseListener)

Upload a file asynchronously. This method does not set any Content-Type header; if such a header is required, it must be set before calling this method.

Parameters:

context - The context that will be passed to authentication listener.

file - The file to upload

progressListener - The listener that monitors the upload progress

responseListener - The listener whose onSuccess or onFailure methods will be called when this request finishes