com.loopj.android.http

Class RequestParams

java.lang.Object

com.loopj.android.http.RequestParams

All Implemented Interfaces:

java.io.Serializable

public class RequestParams
extends java.lang.Object
implements java.io.Serializable

A collection of string request parameters or files to send along with requests made from an AsyncHttpClient instance.

For example:

 RequestParams params = new RequestParams();
 params.put("username", "james");
 params.put("password", "123456");
 params.put("email", "my@email.com");
 params.put("profile_picture", new File("pic.jpg")); // Upload a File
 params.put("profile_picture2", someInputStream); // Upload an InputStream
 params.put("profile_picture3", new ByteArrayInputStream(someBytes)); // Upload some bytes

 Map<String, String> map = new HashMap<String, String>();
 map.put("first_name", "James");
 map.put("last_name", "Smith");
 params.put("user", map); // url params: "user[first_name]=James&user[last_name]=Smith"

 Set<String> set = new HashSet<String>(); // unordered collection
 set.add("music");
 set.add("art");
 params.put("like", set); // url params: "like=music&like=art"

 List<String> list = new ArrayList<String>(); // Ordered collection
 list.add("Java");
 list.add("C");
 params.put("languages", list); // url params: "languages[0]=Java&languages[1]=C"

 String[] colors = { "blue", "yellow" }; // Ordered collection
 params.put("colors", colors); // url params: "colors[0]=blue&colors[1]=yellow"

 File[] files = { new File("pic.jpg"), new File("pic1.jpg") }; // Ordered collection
 params.put("files", files); // url params: "files[]=pic.jpg&files[]=pic1.jpg"

 List<Map<String, String>> listOfMaps = new ArrayList<Map<String,
 String>>();
 Map<String, String> user1 = new HashMap<String, String>();
 user1.put("age", "30");
 user1.put("gender", "male");
 Map<String, String> user2 = new HashMap<String, String>();
 user2.put("age", "25");
 user2.put("gender", "female");
 listOfMaps.add(user1);
 listOfMaps.add(user2);
 params.put("users", listOfMaps); // url params: "users[][age]=30&users[][gender]=male&users[][age]=25&users[][gender]=female"

 AsyncHttpClient client = new AsyncHttpClient();
 client.post("https://myendpoint.com", params, responseHandler);
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestParams.FileWrapper
static class	RequestParams.StreamWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_JSON
static java.lang.String	APPLICATION_OCTET_STREAM
protected boolean	autoCloseInputStreams
protected java.lang.String	contentEncoding
protected java.lang.String	elapsedFieldInJsonStreamer
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.util.List<RequestParams.FileWrapper>>	fileArrayParams
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.FileWrapper>	fileParams
protected boolean	forceMultipartEntity
protected boolean	isRepeatable
protected static java.lang.String	LOG_TAG
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.StreamWrapper>	streamParams
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String>	urlParams
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object>	urlParamsWithObjects
protected boolean	useJsonStreamer

Constructor Summary

Constructors

Constructor and Description
RequestParams() Constructs a new empty RequestParams instance.
RequestParams(java.util.Map<java.lang.String,java.lang.String> source) Constructs a new RequestParams instance containing the key/value string params from the specified map.
RequestParams(java.lang.Object... keysAndValues) Constructs a new RequestParams instance and populate it with multiple initial key/value string param.
RequestParams(java.lang.String key, java.lang.String value) Constructs a new RequestParams instance and populate it with a single initial key/value string param.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, java.lang.String value) Adds string value to param which can have more than one value.
cz.msebera.android.httpclient.HttpEntity	getEntity(ResponseHandlerInterface progressHandler) Returns an HttpEntity containing all request parameters.
protected java.util.List<cz.msebera.android.httpclient.message.BasicNameValuePair>	getParamsList()
protected java.lang.String	getParamString()
boolean	has(java.lang.String key) Check if a parameter is defined.
void	put(java.lang.String key, java.io.File file) Adds a file to the request.
void	put(java.lang.String key, java.io.File[] files) Adds files array to the request.
void	put(java.lang.String key, java.io.File[] files, java.lang.String contentType, java.lang.String customFileName) Adds files array to the request with both custom provided file content-type and files name
void	put(java.lang.String key, java.io.File file, java.lang.String contentType) Adds a file to the request with custom provided file content-type
void	put(java.lang.String key, java.io.File file, java.lang.String contentType, java.lang.String customFileName) Adds a file to the request with both custom provided file content-type and file name
void	put(java.lang.String key, java.io.InputStream stream) Adds an input stream to the request.
void	put(java.lang.String key, java.io.InputStream stream, java.lang.String name) Adds an input stream to the request.
void	put(java.lang.String key, java.io.InputStream stream, java.lang.String name, java.lang.String contentType) Adds an input stream to the request.
void	put(java.lang.String key, java.io.InputStream stream, java.lang.String name, java.lang.String contentType, boolean autoClose) Adds an input stream to the request.
void	put(java.lang.String key, int value) Adds a int value to the request.
void	put(java.lang.String key, long value) Adds a long value to the request.
void	put(java.lang.String key, java.lang.Object value) Adds param with non-string value (e.g.
void	put(java.lang.String key, java.lang.String value) Adds a key/value string pair to the request.
void	put(java.lang.String key, java.lang.String customFileName, java.io.File file) Adds a file to the request with custom provided file name
void	remove(java.lang.String key) Removes a parameter from the request.
void	setAutoCloseInputStreams(boolean flag) Set global flag which determines whether to automatically close input streams on successful upload.
void	setContentEncoding(java.lang.String encoding) Sets content encoding for return value of getParamString() and createFormEntity()
void	setElapsedFieldInJsonStreamer(java.lang.String value) Sets an additional field when upload a JSON object through the streamer to hold the time, in milliseconds, it took to upload the payload.
void	setForceMultipartEntityContentType(boolean force) If set to true will force Content-Type header to `multipart/form-data` even if there are not Files or Streams to be send
void	setHttpEntityIsRepeatable(boolean flag)
void	setUseJsonStreamer(boolean flag)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_OCTET_STREAM

public static final java.lang.String APPLICATION_OCTET_STREAM

See Also:

Constant Field Values

APPLICATION_JSON

public static final java.lang.String APPLICATION_JSON

See Also:

Constant Field Values

LOG_TAG

protected static final java.lang.String LOG_TAG

See Also:

Constant Field Values

urlParams

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.String> urlParams

streamParams

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.StreamWrapper> streamParams

fileParams

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,RequestParams.FileWrapper> fileParams

fileArrayParams

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,java.util.List<RequestParams.FileWrapper>> fileArrayParams

urlParamsWithObjects

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object> urlParamsWithObjects

isRepeatable

protected boolean isRepeatable

forceMultipartEntity

protected boolean forceMultipartEntity

useJsonStreamer

protected boolean useJsonStreamer

elapsedFieldInJsonStreamer

protected java.lang.String elapsedFieldInJsonStreamer

autoCloseInputStreams

protected boolean autoCloseInputStreams

contentEncoding

protected java.lang.String contentEncoding

Constructor Detail

RequestParams

public RequestParams()

Constructs a new empty RequestParams instance.

RequestParams

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

Constructs a new RequestParams instance containing the key/value string params from the specified map.

Parameters:

source - the source key/value string map to add.

RequestParams

public RequestParams(java.lang.String key,
                     java.lang.String value)

Constructs a new RequestParams instance and populate it with a single initial key/value string param.

Parameters:

key - the key name for the intial param.

value - the value string for the initial param.

RequestParams

public RequestParams(java.lang.Object... keysAndValues)

Constructs a new RequestParams instance and populate it with multiple initial key/value string param.

Parameters:

keysAndValues - a sequence of keys and values. Objects are automatically converted to Strings (including the value null).

Throws:

java.lang.IllegalArgumentException - if the number of arguments isn't even.

Method Detail

setContentEncoding

public void setContentEncoding(java.lang.String encoding)

Sets content encoding for return value of getParamString() and createFormEntity()

Default encoding is "UTF-8"

Parameters:

encoding - String constant from HTTP

setForceMultipartEntityContentType

public void setForceMultipartEntityContentType(boolean force)

If set to true will force Content-Type header to `multipart/form-data` even if there are not Files or Streams to be send

Default value is false

Parameters:

force - boolean, should declare content-type multipart/form-data even without files or streams present

put

public void put(java.lang.String key,
                java.lang.String value)

Adds a key/value string pair to the request.

Parameters:

key - the key name for the new param.

value - the value string for the new param.

put

public void put(java.lang.String key,
                java.io.File[] files)
         throws java.io.FileNotFoundException

Adds files array to the request.

Parameters:

key - the key name for the new param.

files - the files array to add.

Throws:

java.io.FileNotFoundException - if one of passed files is not found at time of assembling the requestparams into request

put

public void put(java.lang.String key,
                java.io.File[] files,
                java.lang.String contentType,
                java.lang.String customFileName)
         throws java.io.FileNotFoundException

Adds files array to the request with both custom provided file content-type and files name

Parameters:

key - the key name for the new param.

files - the files array to add.

contentType - the content type of the file, eg. application/json

customFileName - file name to use instead of real file name

Throws:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.io.File file)
         throws java.io.FileNotFoundException

Adds a file to the request.

Parameters:

key - the key name for the new param.

file - the file to add.

Throws:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.lang.String customFileName,
                java.io.File file)
         throws java.io.FileNotFoundException

Adds a file to the request with custom provided file name

Parameters:

key - the key name for the new param.

file - the file to add.

customFileName - file name to use instead of real file name

Throws:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.io.File file,
                java.lang.String contentType)
         throws java.io.FileNotFoundException

Adds a file to the request with custom provided file content-type

Parameters:

key - the key name for the new param.

file - the file to add.

contentType - the content type of the file, eg. application/json

Throws:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.io.File file,
                java.lang.String contentType,
                java.lang.String customFileName)
         throws java.io.FileNotFoundException

Adds a file to the request with both custom provided file content-type and file name

Parameters:

key - the key name for the new param.

file - the file to add.

contentType - the content type of the file, eg. application/json

customFileName - file name to use instead of real file name

Throws:

java.io.FileNotFoundException - throws if wrong File argument was passed

put

public void put(java.lang.String key,
                java.io.InputStream stream)

Adds an input stream to the request.

Parameters:

key - the key name for the new param.

stream - the input stream to add.

put

public void put(java.lang.String key,
                java.io.InputStream stream,
                java.lang.String name)

Adds an input stream to the request.

Parameters:

key - the key name for the new param.

stream - the input stream to add.

name - the name of the stream.

put

public void put(java.lang.String key,
                java.io.InputStream stream,
                java.lang.String name,
                java.lang.String contentType)

Adds an input stream to the request.

Parameters:

key - the key name for the new param.

stream - the input stream to add.

name - the name of the stream.

contentType - the content type of the file, eg. application/json

put

public void put(java.lang.String key,
                java.io.InputStream stream,
                java.lang.String name,
                java.lang.String contentType,
                boolean autoClose)

Adds an input stream to the request.

Parameters:

key - the key name for the new param.

stream - the input stream to add.

name - the name of the stream.

contentType - the content type of the file, eg. application/json

autoClose - close input stream automatically on successful upload

put

public void put(java.lang.String key,
                java.lang.Object value)

Adds param with non-string value (e.g. Map, List, Set).

Parameters:

key - the key name for the new param.

value - the non-string value object for the new param.

put

public void put(java.lang.String key,
                int value)

Adds a int value to the request.

Parameters:

key - the key name for the new param.

value - the value int for the new param.

put

public void put(java.lang.String key,
                long value)

Adds a long value to the request.

Parameters:

key - the key name for the new param.

value - the value long for the new param.

add

public void add(java.lang.String key,
                java.lang.String value)

Adds string value to param which can have more than one value.

Parameters:

key - the key name for the param, either existing or new.

value - the value string for the new param.

remove

public void remove(java.lang.String key)

Removes a parameter from the request.

Parameters:

key - the key name for the parameter to remove.

has

public boolean has(java.lang.String key)

Check if a parameter is defined.

Parameters:

key - the key name for the parameter to check existence.

Returns:

Boolean

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setHttpEntityIsRepeatable

public void setHttpEntityIsRepeatable(boolean flag)

setUseJsonStreamer

public void setUseJsonStreamer(boolean flag)

setElapsedFieldInJsonStreamer

public void setElapsedFieldInJsonStreamer(java.lang.String value)

Sets an additional field when upload a JSON object through the streamer to hold the time, in milliseconds, it took to upload the payload. By default, this field is set to "_elapsed".

To disable this feature, call this method with null as the field value.

Parameters:

value - field name to add elapsed time, or null to disable

setAutoCloseInputStreams

public void setAutoCloseInputStreams(boolean flag)

Set global flag which determines whether to automatically close input streams on successful upload.

Parameters:

flag - boolean whether to automatically close input streams

getEntity

public cz.msebera.android.httpclient.HttpEntity getEntity(ResponseHandlerInterface progressHandler)
                                                   throws java.io.IOException

Returns an HttpEntity containing all request parameters.

Parameters:

progressHandler - HttpResponseHandler for reporting progress on entity submit

Returns:

HttpEntity resulting HttpEntity to be included along with HttpEntityEnclosingRequestBase

Throws:

java.io.IOException - if one of the streams cannot be read

getParamsList

protected java.util.List<cz.msebera.android.httpclient.message.BasicNameValuePair> getParamsList()

getParamString

protected java.lang.String getParamString()