com.box.boxjavalibv2.authorization

Class OAuthDataController

java.lang.Object

com.box.boxjavalibv2.authorization.OAuthDataController

All Implemented Interfaces:

IAuthDataController

public class OAuthDataController
extends Object
implements IAuthDataController

This is the data controller for OAuth, it handles token auto refresh.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuthDataController.OAuthTokenState

Constructor Summary

Constructors

Constructor and Description
OAuthDataController(BoxClient boxClient, String clientId, String clientSecret, boolean autoRefresh) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOAuthRefreshListener(OAuthRefreshListener listener)
boolean	getAndSetLock(boolean doLock) Get the lock, optionally lock the lock after getting the lock.
BoxOAuthToken	getAuthData() Get OAuthData, counting number of retries, in case of too many retries, throw.
String	getAuthority()
String	getClientId()
String	getClientSecret()
Exception	getRefreshFailException()
String	getScheme()
OAuthDataController.OAuthTokenState	getTokenState()
String	getUrlPath()
void	initialize() Initialize the controller.
void	refresh() Refresh the OAuth.
void	setAutoRefreshOAuth(boolean autoRefresh) Makes OAuth auto refresh itself when token expires.
void	setDeviceId(String deviceId) Set device id.
void	setDeviceName(String deviceName) Set device name.
void	setOAuthData(BoxOAuthToken token)
void	setRefreshFail(Exception refreshFailException)
void	setTokenState(OAuthDataController.OAuthTokenState tokenState)
void	setWaitTimeOut(int timeout) Set the timeout for threads waiting for OAuth token refresh.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthDataController

public OAuthDataController(BoxClient boxClient,
                   String clientId,
                   String clientSecret,
                   boolean autoRefresh)

Constructor.

Parameters:

config - BoxConfig

resourceHub - resource hub

clientId - client id

clientSecret - client secret

Method Detail

setAutoRefreshOAuth

public void setAutoRefreshOAuth(boolean autoRefresh)

Makes OAuth auto refresh itself when token expires. Note if autorefresh fails, it's not going to try refresh again.

Parameters:

autoRefresh -

setWaitTimeOut

public void setWaitTimeOut(int timeout)

Set the timeout for threads waiting for OAuth token refresh.

Parameters:

timeout -

getScheme

public String getScheme()

Returns:

the mScheme

getAuthority

public String getAuthority()

Returns:

the mAuthority

getUrlPath

public String getUrlPath()

Returns:

the OAuth url path.

getClientId

public String getClientId()

Returns:

the mClientId

getClientSecret

public String getClientSecret()

Returns:

the mClientSecret

setOAuthData

public void setOAuthData(BoxOAuthToken token)

setDeviceId

public void setDeviceId(String deviceId)

Set device id. This is optional.

Parameters:

deviceId - device id

setDeviceName

public void setDeviceName(String deviceName)

Set device name. Optional.

Parameters:

deviceName - device name

getTokenState

public OAuthDataController.OAuthTokenState getTokenState()

Returns:

the TokenState

setTokenState

public void setTokenState(OAuthDataController.OAuthTokenState tokenState)

Parameters:

tokenState - the mTokenState to set

getRefreshFailException

public Exception getRefreshFailException()

Returns:

the refreshFailException

setRefreshFail

public void setRefreshFail(Exception refreshFailException)

Parameters:

refreshFailException - the refreshFailException to set

initialize

public void initialize()

Initialize the controller.

getAuthData

public BoxOAuthToken getAuthData()
                          throws AuthFatalFailureException

Get OAuthData, counting number of retries, in case of too many retries, throw.

Specified by:

getAuthData in interface IAuthDataController

Returns:

OAuthData

Throws:

AuthFatalFailureException

refresh

public void refresh()
             throws AuthFatalFailureException

Refresh the OAuth.

Specified by:

refresh in interface IAuthDataController

Throws:

AuthFatalFailureException - exception

getAndSetLock

public boolean getAndSetLock(boolean doLock)

Get the lock, optionally lock the lock after getting the lock.

Parameters:

doLock - whether want to lock after getting the lock.

Returns:

addOAuthRefreshListener

public void addOAuthRefreshListener(OAuthRefreshListener listener)