com.box.boxjavalibv2

Class BoxConfig

java.lang.Object

com.box.boxjavalibv2.BoxConfig

All Implemented Interfaces:

IBoxConfig

public class BoxConfig
extends Object
implements IBoxConfig

Class for retrieving configuration parameters.

Author:

developers@box.net

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BoxConfig() Private constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	appendCustomQueryParameterToAllRequests(String key, String value) Add a custom query parameter that will be added to all Box API requests.
void	clearCustomQueryParameters() Clear out all custom query parameters that may have been set.
String	getAcceptLanguage() Get the Accept-Language HTTP header that we should set.
String	getApiUrlAuthority() Get the API URL Authority.
String	getApiUrlPath() Get the API URL path.
String	getApiUrlScheme() Get the API URL scheme.
int	getConnectionTimeOut() Get the amount of time in milliseconds that calls to the server should wait before timing out.
List<org.apache.http.message.BasicNameValuePair>	getCustomQueryParameters() Get a list of all custom query parameters that have been set.
String	getDownloadUrlAuthority() Get the Download URL Authority.
String	getDownloadUrlPath() Get the download url path
String	getDownloadUrlScheme() Get the Download URL scheme.
boolean	getHttpLoggingEnabled() Get the flag indicating whether Http Logging is enabled.
static BoxConfig	getInstance() Get a singleton instance.
String	getOAuthApiUrlPath()
String	getOAuthUrlAuthority()
String	getOAuthUrlScheme()
String	getOAuthWebUrlPath()
String	getUploadUrlAuthority() Get the Upload URL Authority.
String	getUploadUrlPath() Get the upload url path.
String	getUploadUrlScheme() Get the Upload URL scheme.
String	getUserAgent() Get the User-Agent String to apply to the HTTP(S) calls.
void	setApiUrlAuthority(String authority) Set a custom API URL Authority.
void	setApiUrlPath(String path) Set a custom API URL path.
void	setApiUrlScheme(String scheme) Set a custom API URL scheme.
void	setAuthUrlScheme(String oAuthUrlScheme)
void	setConnectionTimeOut(int timeout) Set the amount of time in milliseconds that calls to the server should wait before timing out.
void	setDownloadUrlAuthority(String authority) Set a custom Download URL Authority.
void	setDownloadUrlPath(String downloadUrlPath)
void	setDownloadUrlScheme(String scheme) Set a custom Download URL scheme.
void	setEnableHttpLogging(boolean flag) SHOULD NEVER BE ENABLED FOR PRODUCTION BUILDS Set the flag to enable HTTP Logging.
void	setOAuthApiUrlPath(String oAuthApiUrlPath)
void	setOAuthUrlAuthority(String oAuthUrlAuthority)
void	setOAuthUrlPath(String oAuthUrlPath)
void	setUploadUrlAuthority(String authority) Set a custom Upload URL Authority.
void	setUploadUrlPath(String uploadUrlPath)
void	setUploadUrlScheme(String scheme) Set a custom Upload URL scheme.
void	setUserAgent(String agent) Set the String to use as the User-Agent HTTP header.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxConfig

protected BoxConfig()

Private constructor.

Method Detail

getInstance

public static BoxConfig getInstance()

Get a singleton instance.

Returns:

instance of BoxConfig.

setApiUrlScheme

public void setApiUrlScheme(String scheme)

Set a custom API URL scheme.

Parameters:

scheme - Custom scheme

getApiUrlScheme

public String getApiUrlScheme()

Get the API URL scheme.

Specified by:

getApiUrlScheme in interface IBoxConfig

Returns:

API URL scheme

setApiUrlAuthority

public void setApiUrlAuthority(String authority)

Set a custom API URL Authority.

Parameters:

authority - Custom Authority

getApiUrlAuthority

public String getApiUrlAuthority()

Get the API URL Authority.

Specified by:

getApiUrlAuthority in interface IBoxConfig

Returns:

API URL Authority

setApiUrlPath

public void setApiUrlPath(String path)

Set a custom API URL path.

Parameters:

path - Custom path

getApiUrlPath

public String getApiUrlPath()

Get the API URL path.

Specified by:

getApiUrlPath in interface IBoxConfig

Returns:

API URL path

setUploadUrlScheme

public void setUploadUrlScheme(String scheme)

Set a custom Upload URL scheme.

Parameters:

scheme - Custom scheme

getUploadUrlScheme

public String getUploadUrlScheme()

Get the Upload URL scheme.

Specified by:

getUploadUrlScheme in interface IBoxConfig

Returns:

Upload URL scheme

setUploadUrlAuthority

public void setUploadUrlAuthority(String authority)

Set a custom Upload URL Authority.

Parameters:

authority - Custom Authority

getUploadUrlAuthority

public String getUploadUrlAuthority()

Get the Upload URL Authority.

Specified by:

getUploadUrlAuthority in interface IBoxConfig

Returns:

Upload URL Authority

setDownloadUrlScheme

public void setDownloadUrlScheme(String scheme)

Set a custom Download URL scheme.

Parameters:

scheme - Custom scheme

getDownloadUrlScheme

public String getDownloadUrlScheme()

Get the Download URL scheme.

Specified by:

getDownloadUrlScheme in interface IBoxConfig

Returns:

Download URL scheme

setDownloadUrlAuthority

public void setDownloadUrlAuthority(String authority)

Set a custom Download URL Authority.

Parameters:

authority - Custom Authority

getDownloadUrlAuthority

public String getDownloadUrlAuthority()

Get the Download URL Authority.

Specified by:

getDownloadUrlAuthority in interface IBoxConfig

Returns:

Download URL Authority

setConnectionTimeOut

public void setConnectionTimeOut(int timeout)

Set the amount of time in milliseconds that calls to the server should wait before timing out. Default is 0 which stands for infinite timeout.

Parameters:

timeout - Desired connection timeout.

getConnectionTimeOut

public int getConnectionTimeOut()

Get the amount of time in milliseconds that calls to the server should wait before timing out.

Specified by:

getConnectionTimeOut in interface IBoxConfig

Returns:

The current connection timeout set.

setUserAgent

public void setUserAgent(String agent)

Set the String to use as the User-Agent HTTP header.

Parameters:

agent - User-Agent String

getUserAgent

public String getUserAgent()

Get the User-Agent String to apply to the HTTP(S) calls.

Specified by:

getUserAgent in interface IBoxConfig

Returns:

String to use for User-Agent.

getOAuthUrlScheme

public String getOAuthUrlScheme()

Specified by:

getOAuthUrlScheme in interface IBoxConfig

Returns:

the OAuthUrlScheme

setAuthUrlScheme

public void setAuthUrlScheme(String oAuthUrlScheme)

Parameters:

OAuthUrlScheme - the OAuthUrlScheme to set

getOAuthUrlAuthority

public String getOAuthUrlAuthority()

Specified by:

getOAuthUrlAuthority in interface IBoxConfig

Returns:

the OAuthUrlAuthority

setOAuthUrlAuthority

public void setOAuthUrlAuthority(String oAuthUrlAuthority)

Parameters:

OAuthUrlAuthority - the OAuthUrlAuthority to set

getOAuthWebUrlPath

public String getOAuthWebUrlPath()

Specified by:

getOAuthWebUrlPath in interface IBoxConfig

Returns:

the OAuthUrlPath

setOAuthUrlPath

public void setOAuthUrlPath(String oAuthUrlPath)

Parameters:

OAuthUrlPath - the OAuthUrlPath to set

appendCustomQueryParameterToAllRequests

public void appendCustomQueryParameterToAllRequests(String key,
                                           String value)

Add a custom query parameter that will be added to all Box API requests. In general you should not need to use this.

Parameters:

key - Key.

value - Value.

clearCustomQueryParameters

public void clearCustomQueryParameters()

Clear out all custom query parameters that may have been set.

getCustomQueryParameters

public List<org.apache.http.message.BasicNameValuePair> getCustomQueryParameters()

Get a list of all custom query parameters that have been set. This may return null or an empty List if none have been set. The list returned is not modifiable. Attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException.

Returns:

Unmodifiable list of custom query parameters.

setEnableHttpLogging

public void setEnableHttpLogging(boolean flag)

SHOULD NEVER BE ENABLED FOR PRODUCTION BUILDS Set the flag to enable HTTP Logging.

Parameters:

flag - boolean to Enable Http Logging SHOULD NEVER BE ENABLED FOR PRODUCTION BUILDS

getHttpLoggingEnabled

public boolean getHttpLoggingEnabled()

Get the flag indicating whether Http Logging is enabled.

Returns:

boolean.

getAcceptLanguage

public String getAcceptLanguage()

Get the Accept-Language HTTP header that we should set.

Specified by:

getAcceptLanguage in interface IBoxConfig

Returns:

Accept-Language HTTP header.

getOAuthApiUrlPath

public String getOAuthApiUrlPath()

Specified by:

getOAuthApiUrlPath in interface IBoxConfig

Returns:

the mOAuthApiUrlPath

setOAuthApiUrlPath

public void setOAuthApiUrlPath(String oAuthApiUrlPath)

Parameters:

mOAuthApiUrlPath - the mOAuthApiUrlPath to set

getUploadUrlPath

public String getUploadUrlPath()

Description copied from interface: IBoxConfig

Get the upload url path.

Specified by:

getUploadUrlPath in interface IBoxConfig

setUploadUrlPath

public void setUploadUrlPath(String uploadUrlPath)

Parameters:

mUploadUrlPath - the mUploadUrlPath to set

getDownloadUrlPath

public String getDownloadUrlPath()

Description copied from interface: IBoxConfig

Get the download url path

Specified by:

getDownloadUrlPath in interface IBoxConfig

setDownloadUrlPath

public void setDownloadUrlPath(String downloadUrlPath)

Parameters:

downloadUrlPath - the downloadUrlPath to set