com.box.boxjavalibv2

Class BoxRESTClient

java.lang.Object

com.box.restclientv2.BoxBasicRestClient

com.box.boxjavalibv2.BoxRESTClient

All Implemented Interfaces:

IBoxRESTClient

public class BoxRESTClient
extends BoxBasicRestClient

API v2 client. By default, DefaultHttpClient is used as underlying http client. This takes visitors for requests and handles OAuth failures.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_CANNOT_BE_RETRIED
static String	OAUTH_ERROR_HEADER
static String	OAUTH_INVALID_TOKEN
static String	WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
BoxRESTClient()
BoxRESTClient(int maxConnection, int maxConnectionPerRoute, long timePeriodCleanUpIdleConnection, long idleTimeThreshold)

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptRestVisitor(IBoxRestVisitor visitor) Accept a visitor to visit http request/response.
IBoxResponse	execute(IBoxRequest boxRequest) Execute the API request and return a response.
protected org.apache.http.HttpResponse	getResponse(org.apache.http.client.methods.HttpUriRequest request)
void	setConnectionOpen(boolean connectionOpen)
void	setConnectionTimeOut(int timeOut)

Methods inherited from class com.box.restclientv2.BoxBasicRestClient

getRawHttpClient

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_CANNOT_BE_RETRIED

public static final String ENTITY_CANNOT_BE_RETRIED

See Also:

Constant Field Values

OAUTH_ERROR_HEADER

public static final String OAUTH_ERROR_HEADER

See Also:

Constant Field Values

OAUTH_INVALID_TOKEN

public static final String OAUTH_INVALID_TOKEN

See Also:

Constant Field Values

WWW_AUTHENTICATE

public static final String WWW_AUTHENTICATE

See Also:

Constant Field Values

Constructor Detail

BoxRESTClient

public BoxRESTClient()

BoxRESTClient

public BoxRESTClient(int maxConnection,
             int maxConnectionPerRoute,
             long timePeriodCleanUpIdleConnection,
             long idleTimeThreshold)

Method Detail

acceptRestVisitor

public void acceptRestVisitor(IBoxRestVisitor visitor)

Accept a visitor to visit http request/response.

Parameters:

visitor - visitor

setConnectionOpen

public void setConnectionOpen(boolean connectionOpen)

execute

public IBoxResponse execute(IBoxRequest boxRequest)
                     throws BoxRestException,
                            AuthFatalFailureException

Description copied from interface: IBoxRESTClient

Execute the API request and return a response.

Specified by:

execute in interface IBoxRESTClient

Overrides:

execute in class BoxBasicRestClient

Parameters:

boxRequest - Incoming API request.

Returns:

Response from API.

Throws:

BoxRestException

AuthFatalFailureException

setConnectionTimeOut

public void setConnectionTimeOut(int timeOut)

getResponse

protected org.apache.http.HttpResponse getResponse(org.apache.http.client.methods.HttpUriRequest request)
                                            throws org.apache.http.client.ClientProtocolException,
                                                   IOException

Throws:

org.apache.http.client.ClientProtocolException

IOException