com.box.restclientv2.requests

Class DefaultBoxRequest

java.lang.Object

com.box.restclientv2.requests.DefaultBoxRequest

All Implemented Interfaces:

IBoxRequest

Direct Known Subclasses:

CopyItemRequest, CreateCollaborationRequest, CreateCommentRequest, CreateEmailAliasRequest, CreateEnterpriseUserRequest, CreateGroupMembershipRequest, CreateGroupRequest, CreateNewFolderRequest, CreateOAuthRequest, CreateSharedLinkRequest, DeleteCollaborationRequest, DeleteCommentRequest, DeleteEmailAliasRequest, DeleteFileRequest, DeleteFolderRequest, DeleteGroupMembershipRequest, DeleteGroupRequest, DeleteTrashItemRequest, DownloadFileRequest, EventOptionsRequest, GetAllCollaborationsRequest, GetAllGroupsRequest, GetAllUsersInEnterpriseRequest, GetCollaborationRequest, GetCommentRequest, GetCurrentUserRequest, GetEmailAliasesRequest, GetEventsRequest, GetFileCommentsRequest, GetFileVersionsRequest, GetFolderCollaborationsRequest, GetFolderItemsRequest, GetFolderTrashItemsRequest, GetGroupCollaborationsRequest, GetGroupMembershipRequest, GetGroupMembershipsRequest, GetItemRequest, GetSharedItemRequest, GetTrashItemRequest, MoveFolderToAnotherUserRequest, PreviewRequest, RefreshOAuthRequest, RestoreTrashItemRequest, RevokeOAuthRequest, SearchRequest, ThumbnailRequest, UpdateCollaborationRequest, UpdateCommentRequest, UpdateGroupMembershipRequest, UpdateGroupRequest, UpdateItemInfoRequest, UpdateUserLoginRequest, UpdateUserRequest, UploadFileRequest, UploadNewVersionFileRequest

public class DefaultBoxRequest
extends Object
implements IBoxRequest

Default implementation for IBoxRequest interface. This implementaion utilizes HttpRequestBase as underlying http request.

Constructor Summary

Constructors

Constructor and Description
DefaultBoxRequest(IBoxConfig config, IBoxJSONParser parser, String uriPath, RestMethod restMethod, BoxDefaultRequestObject requestObject) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value) Add header into request.
void	addHttpParam(String name, String value) Add http param.
void	addQueryParam(String name, String value) Add query parameters into request url.
String	getApiUrlPath() Get api path for the api call.
IBoxRequestAuth	getAuth() Auth.
String	getAuthority() Get authority for the api call.
IBoxConfig	getConfig()
ICookie	getCookie() Cookie.
int	getExpectedResponseCode() Get expected response code.
Map<String,String>	getHeaders() Get the headers.
org.apache.http.params.HttpParams	getHttpParams() HttpParams
Map<String,String>	getQueryParams() Get query parameters.
org.apache.http.client.methods.HttpRequestBase	getRawRequest() Get raw request underlying this DefaultBoxRequest.
org.apache.http.HttpEntity	getRequestEntity() Request entity.
RestMethod	getRestMethod() REST method, GET/PUT/POST/DELETE/...
String	getScheme() Get scheme for the api call.
org.apache.http.client.methods.HttpRequestBase	prepareRequest() Prepare the request by setting all headers, query params, entities...
void	setAuth(IBoxRequestAuth auth) Set authorization.
void	setCookie(ICookie cookie) Set cookie.
void	setEntity(org.apache.http.HttpEntity entity) Set entity for the request.
protected void	setExpectedResponseCode(int code) Set the expected returned http response status code.
void	setIfMatch(String ifMatch) Set If-Match header.
void	setRequestFields(List<String> fields) Set fields on the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBoxRequest

public DefaultBoxRequest(IBoxConfig config,
                 IBoxJSONParser parser,
                 String uriPath,
                 RestMethod restMethod,
                 BoxDefaultRequestObject requestObject)
                  throws BoxRestException

Constructor.

Parameters:

config - config

parser - json parser

uriPath - e.g. /folders/93285/items

restMethod - REST method

requestObject - request object

Throws:

BoxRestException - exception

Method Detail

getExpectedResponseCode

public int getExpectedResponseCode()

Description copied from interface: IBoxRequest

Get expected response code.

Specified by:

getExpectedResponseCode in interface IBoxRequest

setExpectedResponseCode

protected void setExpectedResponseCode(int code)

Set the expected returned http response status code.

Parameters:

code - code

getHttpParams

public org.apache.http.params.HttpParams getHttpParams()

Description copied from interface: IBoxRequest

HttpParams

Specified by:

getHttpParams in interface IBoxRequest

Returns:

http params

getAuth

public IBoxRequestAuth getAuth()

Description copied from interface: IBoxRequest

Auth.

Specified by:

getAuth in interface IBoxRequest

Returns:

auth.

getCookie

public ICookie getCookie()

Description copied from interface: IBoxRequest

Cookie.

Specified by:

getCookie in interface IBoxRequest

Returns:

cookie

getRequestEntity

public org.apache.http.HttpEntity getRequestEntity()

Description copied from interface: IBoxRequest

Request entity.

Specified by:

getRequestEntity in interface IBoxRequest

Returns:

request entity.

getRestMethod

public RestMethod getRestMethod()

Description copied from interface: IBoxRequest

REST method, GET/PUT/POST/DELETE/...

Specified by:

getRestMethod in interface IBoxRequest

Returns:

REST method.

getRawRequest

public org.apache.http.client.methods.HttpRequestBase getRawRequest()

Get raw request underlying this DefaultBoxRequest. Note this object is not constructed until prepareRequest method is called.

Returns:

raw request.

setAuth

public void setAuth(IBoxRequestAuth auth)

Description copied from interface: IBoxRequest

Set authorization.

Specified by:

setAuth in interface IBoxRequest

Parameters:

auth - auth

setCookie

public void setCookie(ICookie cookie)

Description copied from interface: IBoxRequest

Set cookie.

Specified by:

setCookie in interface IBoxRequest

Parameters:

cookie - cookie.

setEntity

public void setEntity(org.apache.http.HttpEntity entity)

Set entity for the request.

Parameters:

entity - entity.

addQueryParam

public void addQueryParam(String name,
                 String value)

Description copied from interface: IBoxRequest

Add query parameters into request url.

Specified by:

addQueryParam in interface IBoxRequest

Parameters:

name - name of the parameter

value - value of the parameter

addHeader

public void addHeader(String name,
             String value)

Description copied from interface: IBoxRequest

Add header into request.

Specified by:

addHeader in interface IBoxRequest

Parameters:

name - name of header

value - value of header

setIfMatch

public void setIfMatch(String ifMatch)

Set If-Match header.

Parameters:

ifMatch - the If-Match header value

setRequestFields

public void setRequestFields(List<String> fields)

Set fields on the request. By default, each box object has a complete and a mini format. The complete format is returned when you request a specific object. The mini is returned when the object is part of a collection of items. In either case, you can set the fields here to specify which specific fields you'd like returned. They can be any fields that are a part of the complete object for that particular type.

Parameters:

fields - fields

getHeaders

public Map<String,String> getHeaders()

Get the headers.

Returns:

headers

addHttpParam

public void addHttpParam(String name,
                String value)

Add http param.

Parameters:

name - name

value - value

getQueryParams

public Map<String,String> getQueryParams()

Get query parameters.

Returns:

query parameters

prepareRequest

public org.apache.http.client.methods.HttpRequestBase prepareRequest()
                                                              throws BoxRestException,
                                                                     AuthFatalFailureException

Description copied from interface: IBoxRequest

Prepare the request by setting all headers, query params, entities...

Specified by:

prepareRequest in interface IBoxRequest

Returns:

raw request.

Throws:

BoxRestException

AuthFatalFailureException

getConfig

public IBoxConfig getConfig()

getScheme

public String getScheme()

Description copied from interface: IBoxRequest

Get scheme for the api call.

Specified by:

getScheme in interface IBoxRequest

getAuthority

public String getAuthority()

Description copied from interface: IBoxRequest

Get authority for the api call.

Specified by:

getAuthority in interface IBoxRequest

getApiUrlPath

public String getApiUrlPath()

Description copied from interface: IBoxRequest

Get api path for the api call.

Specified by:

getApiUrlPath in interface IBoxRequest