public class BoxDefaultRequestObject extends java.lang.Object implements IBoxRequestObject
Constructor and Description |
---|
BoxDefaultRequestObject()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
BoxDefaultRequestObject |
addField(java.lang.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(java.util.List<java.lang.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(java.lang.String key,
java.lang.String value)
Add a header.
|
BoxDefaultRequestObject |
addQueryParam(java.lang.String key,
java.lang.String value)
Add a query parameter.
|
java.lang.Object |
get(java.lang.String key)
Get value.
|
HttpEntity |
getEntity()
Get entity, which will be put into request body.
|
java.util.List<java.lang.String> |
getFields()
Get fields, these fields (Please check "Fields" part in developer doc will end up as fields query parameter
in the url.
|
java.util.Map<java.lang.String,java.lang.String> |
getHeaders()
Headers.
|
MapJSONStringEntity |
getJSONEntity()
Get JSON entity.
|
IBoxJSONParser |
getJSONParser() |
java.util.Map<java.lang.String,java.lang.String> |
getQueryParams()
Query parameters.
|
IBoxJSONStringEntity |
put(java.lang.String key,
IBoxJSONStringEntity value)
Add a key value pair to the request body.
|
java.lang.String |
put(java.lang.String key,
java.lang.String value)
Add a key value string pair to the request body.
|
void |
setJSONParser(IBoxJSONParser parser) |
BoxDefaultRequestObject |
setPage(int limit,
int offset) |
public IBoxJSONParser getJSONParser()
public void setJSONParser(IBoxJSONParser parser)
public HttpEntity getEntity() throws BoxRestException
IBoxRequestObject
getEntity
in interface IBoxRequestObject
BoxRestException
public MapJSONStringEntity getJSONEntity()
public java.util.List<java.lang.String> getFields()
IBoxRequestObject
getFields
in interface IBoxRequestObject
public BoxDefaultRequestObject addField(java.lang.String field)
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
...public BoxDefaultRequestObject addFields(java.util.List<java.lang.String> fields)
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
...public BoxDefaultRequestObject addQueryParam(java.lang.String key, java.lang.String value)
key
- keyvalue
- valuepublic BoxDefaultRequestObject addHeader(java.lang.String key, java.lang.String value)
key
- keyvalue
- valuepublic java.util.Map<java.lang.String,java.lang.String> getHeaders()
IBoxRequestObject
getHeaders
in interface IBoxRequestObject
public java.util.Map<java.lang.String,java.lang.String> getQueryParams()
IBoxRequestObject
getQueryParams
in interface IBoxRequestObject
public IBoxJSONStringEntity put(java.lang.String key, IBoxJSONStringEntity value)
key
- keyvalue
- valuepublic java.lang.String put(java.lang.String key, java.lang.String value)
key
- keyvalue
- valuepublic java.lang.Object get(java.lang.String key)
key
- keypublic BoxDefaultRequestObject setPage(int limit, int offset)
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.