com.box.boxjavalibv2.requests.requestobjects

Class BoxDefaultRequestObject

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

All Implemented Interfaces:

IBoxRequestObject

Direct Known Subclasses:

BoxCollabRequestObject, BoxCommentRequestObject, BoxFileUploadRequestObject, BoxGroupRequestObject, BoxImageRequestObject, BoxItemRequestObject, BoxItemRestoreRequestObject, BoxOAuthRequestObject, BoxSharedLinkRequestObject, BoxUserRequestObject

public class BoxDefaultRequestObject
extends Object
implements IBoxRequestObject

A request object with entity and fields.

Constructor Summary

Constructors

Constructor and Description
BoxDefaultRequestObject() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxDefaultRequestObject	addField(String field) Add a field in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.
BoxDefaultRequestObject	addFields(List<String> fields) Add fields in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.
BoxDefaultRequestObject	addHeader(String key, String value) Add a header.
BoxDefaultRequestObject	addQueryParam(String key, String value) Add a query parameter.
Object	get(String key) Get value.
org.apache.http.HttpEntity	getEntity() Get entity, which will be put into request body.
List<String>	getFields() Get fields, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.
Map<String,String>	getHeaders() Headers.
MapJSONStringEntity	getJSONEntity() Get JSON entity.
IBoxJSONParser	getJSONParser()
Map<String,String>	getQueryParams() Query parameters.
IBoxJSONStringEntity	put(String key, IBoxJSONStringEntity value) Add a key value pair to the request body.
String	put(String key, String value) Add a key value string pair to the request body.
String[]	put(String key, String[] value) Add a key value string pair to the request body.
void	setJSONParser(IBoxJSONParser parser)
BoxDefaultRequestObject	setPage(int limit, int offset)

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxDefaultRequestObject

public BoxDefaultRequestObject()

Constructor.

Method Detail

getJSONParser

public IBoxJSONParser getJSONParser()

setJSONParser

public void setJSONParser(IBoxJSONParser parser)

getEntity

public org.apache.http.HttpEntity getEntity()
                                     throws BoxRestException

Description copied from interface: IBoxRequestObject

Get entity, which will be put into request body.

Specified by:

getEntity in interface IBoxRequestObject

Returns:

HttpEntity.

Throws:

BoxRestException

getJSONEntity

public MapJSONStringEntity getJSONEntity()

Get JSON entity.

Returns:

JSON entity

getFields

public List<String> getFields()

Description copied from interface: IBoxRequestObject

Get fields, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.

Specified by:

getFields in interface IBoxRequestObject

Returns:

addField

public BoxDefaultRequestObject addField(String field)

Add a field in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.

Parameters:

field - field to add. Currently supported fields are the Strings defined in com.box.boxjavalibv2.dao, for example: BoxCollaboration.FIELD_ROLE, BoxCollaboration.FIELD_CREATED_BY...

addFields

public BoxDefaultRequestObject addFields(List<String> fields)

Add fields in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.

Parameters:

fields - fields to add. Currently supported fields are the Strings defined in com.box.boxjavalibv2.dao, for example: BoxCollaboration.FIELD_ROLE, BoxCollaboration.FIELD_CREATED_BY...

addQueryParam

public BoxDefaultRequestObject addQueryParam(String key,
                                    String value)

Add a query parameter. Which eventually will go into url.

Parameters:

key - key

value - value

addHeader

public BoxDefaultRequestObject addHeader(String key,
                                String value)

Add a header.

Parameters:

key - key

value - value

getHeaders

public Map<String,String> getHeaders()

Description copied from interface: IBoxRequestObject

Headers.

Specified by:

getHeaders in interface IBoxRequestObject

Returns:

headers

getQueryParams

public Map<String,String> getQueryParams()

Description copied from interface: IBoxRequestObject

Query parameters. Which eventually will go into url.

Specified by:

getQueryParams in interface IBoxRequestObject

Returns:

query parameters.

put

public IBoxJSONStringEntity put(String key,
                       IBoxJSONStringEntity value)

Add a key value pair to the request body.

Parameters:

key - key

value - value

put

public String put(String key,
         String value)

Add a key value string pair to the request body.

Parameters:

key - key

value - value

put

public String[] put(String key,
           String[] value)

Add a key value string pair to the request body.

Parameters:

key - key

value - value

get

public Object get(String key)

Get value.

Parameters:

key - key

Returns:

value

setPage

public BoxDefaultRequestObject setPage(int limit,
                              int offset)

Parameters:

limit - the number of items to return. default is 100, max is 1000.

offset - the item at which to begin the response, default is 0.

Returns:

BoxFolderRequestObject