com.box.androidsdk.preview.ext

Class BoxAutoRefreshingSession

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxSession

com.box.androidsdk.content.models.BoxSharedLinkSession

com.box.androidsdk.preview.ext.BoxAutoRefreshingSession

All Implemented Interfaces:

com.box.androidsdk.content.auth.BoxAuthentication.AuthListener, java.io.Serializable

public class BoxAutoRefreshingSession
extends com.box.androidsdk.content.models.BoxSharedLinkSession

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	ACCESS_TOKEN_MAX_LIFE
static long	SUGGESTED_GRACE_PERIOD

Fields inherited from class com.box.androidsdk.content.models.BoxSession

mAccountEmail, mAuthInfo, mClientId, mClientRedirectUrl, mClientSecret, mDeviceId, mDeviceName, mEnableBoxAppAuthentication, mExpiresAt, mMDMData, mRefreshProvider

Constructor Summary

Constructors

Constructor and Description
BoxAutoRefreshingSession(com.box.androidsdk.content.models.BoxSession session) Convenience constructor that uses the suggested grace period of 1 minute.
BoxAutoRefreshingSession(com.box.androidsdk.content.models.BoxSession session, long gracePeriod) Creates a BoxSession that automatically refreshes when the access token is about to expire.

Method Summary

Modifier and Type	Method and Description
long	getDelayTillNextRefreshTime()
void	onAuthFailure(com.box.androidsdk.content.auth.BoxAuthentication.BoxAuthenticationInfo info, java.lang.Exception ex)
void	onLoggedOut(com.box.androidsdk.content.auth.BoxAuthentication.BoxAuthenticationInfo info, java.lang.Exception ex)
void	onRefreshed(com.box.androidsdk.content.auth.BoxAuthentication.BoxAuthenticationInfo info)
com.box.androidsdk.content.BoxFutureTask<com.box.androidsdk.content.models.BoxSession>	refresh()
void	startAutoRefreshing()
void	stopAutoRefreshing()

Methods inherited from class com.box.androidsdk.content.models.BoxSharedLinkSession

getPassword, getSharedLink, setPassword, setSharedLink

Methods inherited from class com.box.androidsdk.content.models.BoxSession

authenticate, authenticate, clearCache, getApplicationContext, getAuthInfo, getBoxAccountEmail, getCacheDir, getClientId, getClientSecret, getDeviceId, getDeviceName, getManagementData, getRedirectUrl, getRefreshProvider, getRefreshTokenExpiresAt, getUser, getUserAgent, getUserId, isEnabledBoxAppAuthentication, logout, onAuthCreated, setApplicationContext, setAuthInfo, setBoxAccountEmail, setDeviceId, setDeviceName, setEnableBoxAppAuthentication, setManagementData, setRefreshTokenExpiresAt, setSessionAuthListener, setupSession, setUserId, startAuthenticationUI, suppressAuthErrorUIAfterLogin, suppressesAuthErrorUIAfterLogin

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_TOKEN_MAX_LIFE

public static final long ACCESS_TOKEN_MAX_LIFE

See Also:

Constant Field Values

SUGGESTED_GRACE_PERIOD

public static long SUGGESTED_GRACE_PERIOD

Constructor Detail

BoxAutoRefreshingSession

public BoxAutoRefreshingSession(com.box.androidsdk.content.models.BoxSession session)

Convenience constructor that uses the suggested grace period of 1 minute.

Parameters:

session - a session to copy values from.

BoxAutoRefreshingSession

public BoxAutoRefreshingSession(com.box.androidsdk.content.models.BoxSession session,
                                long gracePeriod)

Creates a BoxSession that automatically refreshes when the access token is about to expire.

Parameters:

session - a session to copy data from.

gracePeriod - an amount of time in milliseconds to refresh before estimated expiration time.

Method Detail

getDelayTillNextRefreshTime

public long getDelayTillNextRefreshTime()

startAutoRefreshing

public void startAutoRefreshing()

stopAutoRefreshing

public void stopAutoRefreshing()

refresh

public com.box.androidsdk.content.BoxFutureTask<com.box.androidsdk.content.models.BoxSession> refresh()

Overrides:

refresh in class com.box.androidsdk.content.models.BoxSession

onRefreshed

public void onRefreshed(com.box.androidsdk.content.auth.BoxAuthentication.BoxAuthenticationInfo info)

Specified by:

onRefreshed in interface com.box.androidsdk.content.auth.BoxAuthentication.AuthListener

Overrides:

onRefreshed in class com.box.androidsdk.content.models.BoxSession

onAuthFailure

public void onAuthFailure(com.box.androidsdk.content.auth.BoxAuthentication.BoxAuthenticationInfo info,
                          java.lang.Exception ex)

Specified by:

onAuthFailure in interface com.box.androidsdk.content.auth.BoxAuthentication.AuthListener

Overrides:

onAuthFailure in class com.box.androidsdk.content.models.BoxSession

onLoggedOut

public void onLoggedOut(com.box.androidsdk.content.auth.BoxAuthentication.BoxAuthenticationInfo info,
                        java.lang.Exception ex)

Specified by:

onLoggedOut in interface com.box.androidsdk.content.auth.BoxAuthentication.AuthListener

Overrides:

onLoggedOut in class com.box.androidsdk.content.models.BoxSession