com.box.restclientv2.requestsbase

Interface IBoxRequest

All Known Implementing Classes:

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

public interface IBoxRequest

Interface for the request to Box API.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value) Add header into request.
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.
ICookie	getCookie() Cookie.
int	getExpectedResponseCode() Get expected response code.
org.apache.http.params.HttpParams	getHttpParams() HttpParams
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.HttpUriRequest	prepareRequest() Prepare the request by setting all headers, query params, entities...
void	setAuth(IBoxRequestAuth auth) Set authorization.
void	setCookie(ICookie cookie) Set cookie.

Method Detail

getAuth

IBoxRequestAuth getAuth()

Auth.

Returns:

auth.

getCookie

ICookie getCookie()

Cookie.

Returns:

cookie

getRequestEntity

org.apache.http.HttpEntity getRequestEntity()

Request entity.

Returns:

request entity.

getHttpParams

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

HttpParams

Returns:

http params

addQueryParam

void addQueryParam(String name,
                 String value)

Add query parameters into request url.

Parameters:

name - name of the parameter

value - value of the parameter

addHeader

void addHeader(String name,
             String value)

Add header into request.

Parameters:

name - name of header

value - value of header

setAuth

void setAuth(IBoxRequestAuth auth)

Set authorization.

Parameters:

auth - auth

setCookie

void setCookie(ICookie cookie)

Set cookie.

Parameters:

cookie - cookie.

prepareRequest

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

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

Returns:

raw request.

Throws:

BoxRestException

AuthFatalFailureException

getRestMethod

RestMethod getRestMethod()

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

Returns:

REST method.

getScheme

String getScheme()

Get scheme for the api call.

getAuthority

String getAuthority()

Get authority for the api call.

getApiUrlPath

String getApiUrlPath()

Get api path for the api call.

getExpectedResponseCode

int getExpectedResponseCode()

Get expected response code.