com.box.boxjavalibv2.authorization

Class OAuthAuthorization

java.lang.Object

com.box.restclientv2.authorization.DefaultRequestAuth

com.box.boxjavalibv2.authorization.OAuthAuthorization

All Implemented Interfaces:

IBoxRequestAuth

public class OAuthAuthorization
extends DefaultRequestAuth

This is authorization class for API requests using OAuth.

Field Summary

Fields inherited from class com.box.restclientv2.authorization.DefaultRequestAuth

AUTH_HEADER_NAME

Constructor Summary

Constructors

Constructor and Description
OAuthAuthorization(OAuthDataController oAuth) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	initOAuthForRequest() Initialize this auth.
void	refresh() Refresh the OAuth token.
void	setAuth(IBoxRequest request) Set Auth into the API request.
void	setOAuthData(BoxOAuthToken data)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthAuthorization

public OAuthAuthorization(OAuthDataController oAuth)

Constructor.

Parameters:

oAuth - OAuth

autoRefresh - Whether allow auto refresh the OAuth token when it's expired.

Method Detail

setOAuthData

public void setOAuthData(BoxOAuthToken data)

refresh

public void refresh()
             throws AuthFatalFailureException

Refresh the OAuth token.

Throws:

AuthFatalFailureException - exception

initOAuthForRequest

public void initOAuthForRequest()

Initialize this auth. This need to be called before making an API request using this auth.

setAuth

public void setAuth(IBoxRequest request)
             throws BoxRestException,
                    AuthFatalFailureException

Description copied from interface: IBoxRequestAuth

Set Auth into the API request.

Specified by:

setAuth in interface IBoxRequestAuth

Overrides:

setAuth in class DefaultRequestAuth

Parameters:

request - IBoxRequest

Throws:

BoxRestException - Exception.

AuthFatalFailureException - exception