public class BoxConfig extends java.lang.Object implements IBoxConfig
Modifier | Constructor and Description |
---|---|
protected |
BoxConfig()
Private constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
appendCustomQueryParameterToAllRequests(java.lang.String key,
java.lang.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.
|
java.lang.String |
getAcceptLanguage()
Get the Accept-Language HTTP header that we should set.
|
java.lang.String |
getApiUrlAuthority()
Get the API URL Authority.
|
java.lang.String |
getApiUrlPath()
Get the API URL path.
|
java.lang.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.
|
java.util.List<BasicNameValuePair> |
getCustomQueryParameters()
Get a list of all custom query parameters that have been set.
|
java.lang.String |
getDownloadUrlAuthority()
Get the Download URL Authority.
|
java.lang.String |
getDownloadUrlPath()
Get the download url path
|
java.lang.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.
|
java.lang.String |
getOAuthApiUrlPath() |
java.lang.String |
getOAuthUrlAuthority() |
java.lang.String |
getOAuthUrlScheme() |
java.lang.String |
getOAuthWebUrlPath() |
java.lang.String |
getUploadUrlAuthority()
Get the Upload URL Authority.
|
java.lang.String |
getUploadUrlPath()
Get the upload url path.
|
java.lang.String |
getUploadUrlScheme()
Get the Upload URL scheme.
|
java.lang.String |
getUserAgent()
Get the User-Agent String to apply to the HTTP(S) calls.
|
void |
setApiUrlAuthority(java.lang.String authority)
Set a custom API URL Authority.
|
void |
setApiUrlPath(java.lang.String path)
Set a custom API URL path.
|
void |
setApiUrlScheme(java.lang.String scheme)
Set a custom API URL scheme.
|
void |
setAuthUrlScheme(java.lang.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(java.lang.String authority)
Set a custom Download URL Authority.
|
void |
setDownloadUrlPath(java.lang.String downloadUrlPath) |
void |
setDownloadUrlScheme(java.lang.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(java.lang.String oAuthApiUrlPath) |
void |
setOAuthUrlAuthority(java.lang.String oAuthUrlAuthority) |
void |
setOAuthUrlPath(java.lang.String oAuthUrlPath) |
void |
setUploadUrlAuthority(java.lang.String authority)
Set a custom Upload URL Authority.
|
void |
setUploadUrlPath(java.lang.String uploadUrlPath) |
void |
setUploadUrlScheme(java.lang.String scheme)
Set a custom Upload URL scheme.
|
void |
setUserAgent(java.lang.String agent)
Set the String to use as the User-Agent HTTP header.
|
public static BoxConfig getInstance()
public void setApiUrlScheme(java.lang.String scheme)
scheme
- Custom schemepublic java.lang.String getApiUrlScheme()
getApiUrlScheme
in interface IBoxConfig
public void setApiUrlAuthority(java.lang.String authority)
authority
- Custom Authoritypublic java.lang.String getApiUrlAuthority()
getApiUrlAuthority
in interface IBoxConfig
public void setApiUrlPath(java.lang.String path)
path
- Custom pathpublic java.lang.String getApiUrlPath()
getApiUrlPath
in interface IBoxConfig
public void setUploadUrlScheme(java.lang.String scheme)
scheme
- Custom schemepublic java.lang.String getUploadUrlScheme()
getUploadUrlScheme
in interface IBoxConfig
public void setUploadUrlAuthority(java.lang.String authority)
authority
- Custom Authoritypublic java.lang.String getUploadUrlAuthority()
getUploadUrlAuthority
in interface IBoxConfig
public void setDownloadUrlScheme(java.lang.String scheme)
scheme
- Custom schemepublic java.lang.String getDownloadUrlScheme()
getDownloadUrlScheme
in interface IBoxConfig
public void setDownloadUrlAuthority(java.lang.String authority)
authority
- Custom Authoritypublic java.lang.String getDownloadUrlAuthority()
getDownloadUrlAuthority
in interface IBoxConfig
public void setConnectionTimeOut(int timeout)
timeout
- Desired connection timeout.public int getConnectionTimeOut()
getConnectionTimeOut
in interface IBoxConfig
public void setUserAgent(java.lang.String agent)
agent
- User-Agent Stringpublic java.lang.String getUserAgent()
getUserAgent
in interface IBoxConfig
public java.lang.String getOAuthUrlScheme()
getOAuthUrlScheme
in interface IBoxConfig
public void setAuthUrlScheme(java.lang.String oAuthUrlScheme)
OAuthUrlScheme
- the OAuthUrlScheme to setpublic java.lang.String getOAuthUrlAuthority()
getOAuthUrlAuthority
in interface IBoxConfig
public void setOAuthUrlAuthority(java.lang.String oAuthUrlAuthority)
OAuthUrlAuthority
- the OAuthUrlAuthority to setpublic java.lang.String getOAuthWebUrlPath()
getOAuthWebUrlPath
in interface IBoxConfig
public void setOAuthUrlPath(java.lang.String oAuthUrlPath)
OAuthUrlPath
- the OAuthUrlPath to setpublic void appendCustomQueryParameterToAllRequests(java.lang.String key, java.lang.String value)
key
- Key.value
- Value.public void clearCustomQueryParameters()
public java.util.List<BasicNameValuePair> getCustomQueryParameters()
public void setEnableHttpLogging(boolean flag)
flag
- boolean to Enable Http Logging
SHOULD NEVER BE ENABLED FOR PRODUCTION BUILDSpublic boolean getHttpLoggingEnabled()
public java.lang.String getAcceptLanguage()
getAcceptLanguage
in interface IBoxConfig
public java.lang.String getOAuthApiUrlPath()
getOAuthApiUrlPath
in interface IBoxConfig
public void setOAuthApiUrlPath(java.lang.String oAuthApiUrlPath)
mOAuthApiUrlPath
- the mOAuthApiUrlPath to setpublic java.lang.String getUploadUrlPath()
IBoxConfig
getUploadUrlPath
in interface IBoxConfig
public void setUploadUrlPath(java.lang.String uploadUrlPath)
mUploadUrlPath
- the mUploadUrlPath to setpublic java.lang.String getDownloadUrlPath()
IBoxConfig
getDownloadUrlPath
in interface IBoxConfig
public void setDownloadUrlPath(java.lang.String downloadUrlPath)
downloadUrlPath
- the downloadUrlPath to set