com.box.boxjavalibv2.resourcemanagers

Class BoxOAuthManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxOAuthManagerImpl

All Implemented Interfaces:

IBoxOAuthManager, IBoxResourceManager

Direct Known Subclasses:

MockOAuthManager

public class BoxOAuthManagerImpl
extends AbstractBoxResourceManager
implements IBoxOAuthManager

API for OAuth. Full details about the Box API can be found at http://developers.box.com/docs

Constructor Summary

Constructors

Constructor and Description
BoxOAuthManagerImpl(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxOAuthToken	createOAuth(BoxOAuthRequestObject requestObject)
BoxOAuthToken	createOAuth(java.lang.String code, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUrl)
BoxOAuthToken	createOAuth(java.lang.String code, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUrl, java.lang.String deviceId, java.lang.String deviceName)
BoxOAuthToken	refreshOAuth(BoxOAuthRequestObject requestObject)
BoxOAuthToken	refreshOAuth(java.lang.String refreshToken, java.lang.String clientId, java.lang.String clientSecret) Refresh OAuth.
BoxOAuthToken	refreshOAuth(java.lang.String refreshToken, java.lang.String clientId, java.lang.String clientSecret, java.lang.String deviceId, java.lang.String deviceName) Refresh OAuth.
void	revokeOAuth(BoxOAuthRequestObject requestObject)
void	revokeOAuth(java.lang.String accessToken, java.lang.String clientId, java.lang.String clientSecret) Revoke OAuth.

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxOAuthManagerImpl

public BoxOAuthManagerImpl(IBoxConfig config,
                   IBoxResourceHub resourceHub,
                   IBoxJSONParser parser,
                   IBoxRESTClient restClient)

Constructor.

Parameters:

config - config

resourceHub - resource hub

parser - json parser

restClient - REST client to make api calls.

Method Detail

createOAuth

public BoxOAuthToken createOAuth(java.lang.String code,
                        java.lang.String clientId,
                        java.lang.String clientSecret,
                        java.lang.String redirectUrl)
                          throws BoxRestException,
                                 BoxServerException,
                                 AuthFatalFailureException

Specified by:

createOAuth in interface IBoxOAuthManager

Parameters:

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

clientId - client id

clientSecret - client secret

redirectUrl - 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:

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

createOAuth

public BoxOAuthToken createOAuth(java.lang.String code,
                        java.lang.String clientId,
                        java.lang.String clientSecret,
                        java.lang.String redirectUrl,
                        java.lang.String deviceId,
                        java.lang.String deviceName)
                          throws BoxRestException,
                                 BoxServerException,
                                 AuthFatalFailureException

Specified by:

createOAuth in interface IBoxOAuthManager

Parameters:

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

clientId - client id

clientSecret - client secret

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

deviceId - device id

deviceName - device name

Returns:

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

createOAuth

public BoxOAuthToken createOAuth(BoxOAuthRequestObject requestObject)
                          throws BoxRestException,
                                 BoxServerException,
                                 AuthFatalFailureException

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

refreshOAuth

public BoxOAuthToken refreshOAuth(java.lang.String refreshToken,
                         java.lang.String clientId,
                         java.lang.String clientSecret,
                         java.lang.String deviceId,
                         java.lang.String deviceName)
                           throws BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Description copied from interface: IBoxOAuthManager

Refresh OAuth.

Specified by:

refreshOAuth in interface IBoxOAuthManager

Parameters:

refreshToken - refresh token.

clientId - client id.

clientSecret - client secret.

deviceId - device id.

deviceName - device name.

Returns:

refreshed BoxOAuthToken.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

refreshOAuth

public BoxOAuthToken refreshOAuth(java.lang.String refreshToken,
                         java.lang.String clientId,
                         java.lang.String clientSecret)
                           throws BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Description copied from interface: IBoxOAuthManager

Refresh OAuth.

Specified by:

refreshOAuth in interface IBoxOAuthManager

Parameters:

refreshToken - refresh token.

clientId - client id.

clientSecret - client secret.

Returns:

refreshed BoxOAuthToken

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

revokeOAuth

public void revokeOAuth(java.lang.String accessToken,
               java.lang.String clientId,
               java.lang.String clientSecret)
                 throws BoxServerException,
                        BoxRestException,
                        AuthFatalFailureException

Description copied from interface: IBoxOAuthManager

Revoke OAuth.

Specified by:

revokeOAuth in interface IBoxOAuthManager

Parameters:

accessToken - current access token (to be revoked).

clientId - client id.

clientSecret - client secret.

Throws:

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

BoxRestException - See BoxRestException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

refreshOAuth

public BoxOAuthToken refreshOAuth(BoxOAuthRequestObject requestObject)
                           throws BoxRestException,
                                  BoxServerException,
                                  AuthFatalFailureException

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

revokeOAuth

public void revokeOAuth(BoxOAuthRequestObject requestObject)
                 throws BoxServerException,
                        BoxRestException,
                        AuthFatalFailureException

Throws:

BoxServerException

BoxRestException

AuthFatalFailureException