com.box.boxjavalibv2.requests.requestobjects

Class BoxOAuthRequestObject

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxOAuthRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxOAuthRequestObject
extends BoxDefaultRequestObject

Method Summary

Methods

Modifier and Type	Method and Description
static BoxOAuthRequestObject	createOAuthRequestObject(String code, String clientId, String clientSecret, String redirectUrl) Request object to create OAUth.
org.apache.http.client.entity.UrlEncodedFormEntity	getEntity() Get entity, which will be put into request body.
static BoxOAuthRequestObject	refreshOAuthRequestObject(String refreshToken, String clientId, String clientSecret)
static BoxOAuthRequestObject	revokeOAuthRequestObject(String revokeToken, String clientId, String clientSecret) Request object to revoke OAuth.
BoxOAuthRequestObject	setAuthCode(String code)
BoxOAuthRequestObject	setClient(String clientId, String clientSecret)
BoxOAuthRequestObject	setRedirectUrl(String redirectUrl)
BoxOAuthRequestObject	setRefreshToken(String refreshToken)
BoxOAuthRequestObject	setRevokeToken(String token) Set the token to revoke.

Methods inherited from class com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

addField, addFields, addHeader, addQueryParam, get, getFields, getHeaders, getJSONEntity, getJSONParser, getQueryParams, put, put, put, setJSONParser, setPage

Methods inherited from class java.lang.Object

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

Method Detail

createOAuthRequestObject

public static BoxOAuthRequestObject createOAuthRequestObject(String code,
                                             String clientId,
                                             String clientSecret,
                                             String redirectUrl)

Request object to create OAUth.

Parameters:

code - The authorization code you retrieved previously used to create OAuth.

clientId - client id

clientSecret - client secret

redirectUri - optional, required only if a redirect URI is not configured at Box Developers Services, use null if don't want to supply this field.

Returns:

BoxOAuthRequestObject

refreshOAuthRequestObject

public static BoxOAuthRequestObject refreshOAuthRequestObject(String refreshToken,
                                              String clientId,
                                              String clientSecret)

revokeOAuthRequestObject

public static BoxOAuthRequestObject revokeOAuthRequestObject(String revokeToken,
                                             String clientId,
                                             String clientSecret)

Request object to revoke OAuth.

Parameters:

revokeToken - The access_token or refresh_token to be destroyed. Only one is required, though both will be destroyed.

clientId -

clientSecret -

Returns:

setRevokeToken

public BoxOAuthRequestObject setRevokeToken(String token)

Set the token to revoke.

Parameters:

token - The access_token or refresh_token to be destroyed. Only one is required, though both will be destroyed.

Returns:

setRefreshToken

public BoxOAuthRequestObject setRefreshToken(String refreshToken)

setAuthCode

public BoxOAuthRequestObject setAuthCode(String code)

Parameters:

code - The authorization code you retrieved previously used to create OAuth.

Returns:

setClient

public BoxOAuthRequestObject setClient(String clientId,
                              String clientSecret)

setRedirectUrl

public BoxOAuthRequestObject setRedirectUrl(String redirectUrl)

getEntity

public org.apache.http.client.entity.UrlEncodedFormEntity getEntity()
                                                             throws BoxRestException

Description copied from interface: IBoxRequestObject

Get entity, which will be put into request body.

Specified by:

getEntity in interface IBoxRequestObject

Overrides:

getEntity in class BoxDefaultRequestObject

Returns:

HttpEntity.

Throws:

BoxRestException