com.box.boxjavalibv2.resourcemanagers

Interface IBoxOAuthManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxOAuthManagerImpl, MockOAuthManager

public interface IBoxOAuthManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
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(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(java.lang.String accessToken, java.lang.String clientId, java.lang.String clientSecret) Revoke OAuth.

Method Detail

createOAuth

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

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

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

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.

refreshOAuth

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

Refresh OAuth.

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

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

Refresh OAuth.

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

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

Revoke OAuth.

Parameters:

accessToken - current access token (to be revoked).

clientId - client id.

clientSecret - client secret.

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.