com.box.androidsdk.content.models

Class BoxSession

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxSession

All Implemented Interfaces:

BoxAuthentication.AuthListener, java.io.Serializable

Direct Known Subclasses:

BoxSharedLinkSession

public class BoxSession
extends BoxObject
implements BoxAuthentication.AuthListener

A BoxSession is responsible for maintaining the mapping between user and authentication tokens

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mAccountEmail
protected BoxAuthentication.BoxAuthenticationInfo	mAuthInfo
protected java.lang.String	mClientId
protected java.lang.String	mClientRedirectUrl
protected java.lang.String	mClientSecret
protected java.lang.String	mDeviceId
protected java.lang.String	mDeviceName
protected boolean	mEnableBoxAppAuthentication
protected java.lang.Long	mExpiresAt
protected BoxMDMData	mMDMData
protected BoxAuthentication.AuthenticationRefreshProvider	mRefreshProvider Optional refresh provider.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BoxSession(BoxSession session) Construct a new box session object based off of an existing session.
	BoxSession(android.content.Context context) When using this constructor, if a user has previously been logged in/stored or there is only one user, this user will be authenticated.
	BoxSession(android.content.Context context, BoxAuthentication.BoxAuthenticationInfo authInfo, E refreshProvider) This is an advanced constructor that can be used when implementing an authentication flow that differs from the default oauth 2 flow.
	BoxSession(android.content.Context context, java.lang.String userId) When setting the userId to null ui will be shown to ask which user to authenticate as if at least one user is logged in.
	BoxSession(android.content.Context context, java.lang.String accessToken, E refreshProvider) This is a convenience constructor.
	BoxSession(android.content.Context context, java.lang.String userId, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUrl) Create a BoxSession using a specific box clientId, secret, and redirectUrl.

Method Summary

Modifier and Type	Method and Description
BoxFutureTask<BoxSession>	authenticate() Deprecated.
BoxFutureTask<BoxSession>	authenticate(android.content.Context context)
void	clearCache() This clears the contents of the directory provided in getCacheDir().
android.content.Context	getApplicationContext()
BoxAuthentication.BoxAuthenticationInfo	getAuthInfo()
java.lang.String	getBoxAccountEmail()
java.io.File	getCacheDir() This function gives you the cache location associated with this session.
java.lang.String	getClientId() Returns the associated client id.
java.lang.String	getClientSecret() Returns the associated client secret.
java.lang.String	getDeviceId()
java.lang.String	getDeviceName()
BoxMDMData	getManagementData()
java.lang.String	getRedirectUrl()
BoxAuthentication.AuthenticationRefreshProvider	getRefreshProvider()
java.lang.Long	getRefreshTokenExpiresAt()
BoxUser	getUser()
java.lang.String	getUserAgent()
java.lang.String	getUserId()
boolean	isEnabledBoxAppAuthentication()
BoxFutureTask<BoxSession>	logout() Logout the currently authenticated user.
void	onAuthCreated(BoxAuthentication.BoxAuthenticationInfo info) Called when this user has logged in.
void	onAuthFailure(BoxAuthentication.BoxAuthenticationInfo info, java.lang.Exception ex) Called when a failure occurs trying to authenticate or refresh.
void	onLoggedOut(BoxAuthentication.BoxAuthenticationInfo info, java.lang.Exception ex) Called when the session was logged out of
void	onRefreshed(BoxAuthentication.BoxAuthenticationInfo info) Called when this session has been refreshed with new authentication info.
BoxFutureTask<BoxSession>	refresh() Refresh authentication information associated with this session.
void	setApplicationContext(android.content.Context context) Set the application context if this session loses it for instance when this object is deserialized.
protected void	setAuthInfo(BoxAuthentication.BoxAuthenticationInfo authInfo)
void	setBoxAccountEmail(java.lang.String accountName)
void	setDeviceId(java.lang.String deviceId)
void	setDeviceName(java.lang.String deviceName)
void	setEnableBoxAppAuthentication(boolean enabled) Sets whether or not Box App authentication is enabled or not.
void	setManagementData(BoxMDMData mdmData)
void	setRefreshTokenExpiresAt(long expiresAt)
void	setSessionAuthListener(BoxAuthentication.AuthListener listener)
protected void	setupSession()
protected void	setUserId(java.lang.String userId)
protected void	startAuthenticationUI()
void	suppressAuthErrorUIAfterLogin(boolean suppress) When set, the content sdk will not show activities/fragments requiring user input, for e.g.
boolean	suppressesAuthErrorUIAfterLogin()

Methods inherited from class java.lang.Object

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

Field Detail

mClientId

protected java.lang.String mClientId

mClientSecret

protected java.lang.String mClientSecret

mClientRedirectUrl

protected java.lang.String mClientRedirectUrl

mAuthInfo

protected BoxAuthentication.BoxAuthenticationInfo mAuthInfo

mDeviceId

protected java.lang.String mDeviceId

mDeviceName

protected java.lang.String mDeviceName

mMDMData

protected BoxMDMData mMDMData

mExpiresAt

protected java.lang.Long mExpiresAt

mAccountEmail

protected java.lang.String mAccountEmail

mRefreshProvider

protected BoxAuthentication.AuthenticationRefreshProvider mRefreshProvider

Optional refresh provider.

mEnableBoxAppAuthentication

protected boolean mEnableBoxAppAuthentication

Constructor Detail

BoxSession

public BoxSession(android.content.Context context)

When using this constructor, if a user has previously been logged in/stored or there is only one user, this user will be authenticated. If no user or multiple users have been stored without knowledge of the last one authenticated, ui will be shown to handle the scenario similar to BoxSession(null, context).

Parameters:

context - current context.

BoxSession

public BoxSession(android.content.Context context,
                  java.lang.String userId)

When setting the userId to null ui will be shown to ask which user to authenticate as if at least one user is logged in. If no user has been stored will show login ui. If logging in as a valid user id no ui will be displayed.

Parameters:

userId - user id to login as or null to login a new user.

context - current context.

BoxSession

public BoxSession(android.content.Context context,
                  java.lang.String userId,
                  java.lang.String clientId,
                  java.lang.String clientSecret,
                  java.lang.String redirectUrl)

Create a BoxSession using a specific box clientId, secret, and redirectUrl. This constructor is not necessary unless an application uses multiple api keys. Note: When setting the userId to null ui will be shown to ask which user to authenticate as if at least one user is logged in. If no user has been stored will show login ui.

Parameters:

context - current context.

clientId - the developer's client id to access the box api.

clientSecret - the developer's secret used to interpret the response coming from Box.

redirectUrl - the developer's redirect url to use for authenticating via Box.

userId - user id to login as or null to login as a new user.

BoxSession

protected BoxSession(BoxSession session)

Construct a new box session object based off of an existing session.

Parameters:

session - session to use as the base.

BoxSession

public BoxSession(android.content.Context context,
                  BoxAuthentication.BoxAuthenticationInfo authInfo,
                  E refreshProvider)

This is an advanced constructor that can be used when implementing an authentication flow that differs from the default oauth 2 flow.

Type Parameters:

E - an instanceof of a refresh provider that is serializable.

Parameters:

context - current context.

authInfo - authentication information that should be used. (Must at the minimum provide an access token).

refreshProvider - the refresh provider to use when the access token expires and needs to be refreshed.

BoxSession

public BoxSession(android.content.Context context,
                  java.lang.String accessToken,
                  E refreshProvider)

This is a convenience constructor. It is the equivalent of calling BoxSession(context, authInfo, refreshProvider) and creating an authInfo with just an accessToken.

Type Parameters:

E - an instanceof of a refresh provider that is serializable.

Parameters:

context - current context

accessToken - a valid accessToken.

refreshProvider - the refresh provider to use when the access token expires and needs to refreshed.

Method Detail

setAuthInfo

protected void setAuthInfo(BoxAuthentication.BoxAuthenticationInfo authInfo)

setEnableBoxAppAuthentication

public void setEnableBoxAppAuthentication(boolean enabled)

Sets whether or not Box App authentication is enabled or not.

Parameters:

enabled - true if the session should try to authenticate via the Box application, false otherwise.

isEnabledBoxAppAuthentication

public boolean isEnabledBoxAppAuthentication()

Returns:

true if authentication via the Box App is enabled (this is by default), false otherwise.

setApplicationContext

public void setApplicationContext(android.content.Context context)

Set the application context if this session loses it for instance when this object is deserialized.

Parameters:

context - current context

getApplicationContext

public android.content.Context getApplicationContext()

Returns:

the application context used to construct this session.

setSessionAuthListener

public void setSessionAuthListener(BoxAuthentication.AuthListener listener)

Parameters:

listener - listener to notify when authentication events (authentication, refreshing, and their exceptions) occur.

setupSession

protected void setupSession()

getUser

public BoxUser getUser()

Returns:

the user associated with this session. May return null if this is a new session before authentication.

getUserId

public java.lang.String getUserId()

Returns:

the user id associated with this session. This can be null if the session was created without a user id and has not been authenticated.

setUserId

protected void setUserId(java.lang.String userId)

getAuthInfo

public BoxAuthentication.BoxAuthenticationInfo getAuthInfo()

Returns:

the auth information associated with this session.

getRefreshProvider

public BoxAuthentication.AuthenticationRefreshProvider getRefreshProvider()

Returns:

the custom refresh provider associated with this session. returns null if one is not set.

setDeviceId

public void setDeviceId(java.lang.String deviceId)

Parameters:

deviceId - the optional unique ID of this device. Used for applications that want to support device-pinning.

getDeviceId

public java.lang.String getDeviceId()

Returns:

the device id associated with this session. returns null if one is not set.

setDeviceName

public void setDeviceName(java.lang.String deviceName)

Parameters:

deviceName - the optional human readable name for this device.

getDeviceName

public java.lang.String getDeviceName()

Returns:

the device name associated with this session. returns null if one is not set.

getUserAgent

public java.lang.String getUserAgent()

Returns:

the user agent to use for network requests with this session.

setManagementData

public void setManagementData(BoxMDMData mdmData)

Parameters:

mdmData - MDM data object that should be used to authenticate this session if required.

getManagementData

public BoxMDMData getManagementData()

Returns:

mdm data if set.

setRefreshTokenExpiresAt

public void setRefreshTokenExpiresAt(long expiresAt)

Parameters:

expiresAt - (optional) set the time as a unix time stamp in seconds when the refresh token should expire. Must be less than the default 60 days if used.

getRefreshTokenExpiresAt

public java.lang.Long getRefreshTokenExpiresAt()

Returns:

the unix time stamp at which refresh token should expire if set, returns null if not set.

setBoxAccountEmail

public void setBoxAccountEmail(java.lang.String accountName)

Parameters:

accountName - (optional) set email account to prefill into authentication ui if available.

getBoxAccountEmail

public java.lang.String getBoxAccountEmail()

Returns:

Box Account email if set.

authenticate

@Deprecated
public BoxFutureTask<BoxSession> authenticate()

Deprecated.

Use authenticate(context) instead.

Returns:

a box future task (already submitted to an executor) that starts the process of authenticating this user. The task can be used to block until the user has completed authentication through whatever ui is necessary(using task.get()).

authenticate

public BoxFutureTask<BoxSession> authenticate(android.content.Context context)

Parameters:

context - The current context.

Returns:

a box future task (already submitted to an executor) that starts the process of authenticating this user. The task can be used to block until the user has completed authentication through whatever ui is necessary(using task.get()).

logout

public BoxFutureTask<BoxSession> logout()

Logout the currently authenticated user.

Returns:

a task that can be used to block until the user associated with this session has been logged out.

refresh

public BoxFutureTask<BoxSession> refresh()

Refresh authentication information associated with this session.

Returns:

a task that can be used to block until the information associated with this session has been refreshed.

suppressAuthErrorUIAfterLogin

public void suppressAuthErrorUIAfterLogin(boolean suppress)

When set, the content sdk will not show activities/fragments requiring user input, for e.g. when a BoxSessionRefreshRequest fails, or specific authentication errors happen while sending requests using this session.

Parameters:

suppress - true if error ui should be supressed, false otherwise.

suppressesAuthErrorUIAfterLogin

public boolean suppressesAuthErrorUIAfterLogin()

getCacheDir

public java.io.File getCacheDir()

This function gives you the cache location associated with this session. It is preferred to use this method when setting up the location of your cache as it ensures that all data will be cleared upon logout.

Returns:

directory associated with the user associated with this session.

clearCache

public void clearCache()

This clears the contents of the directory provided in getCacheDir().

onRefreshed

public void onRefreshed(BoxAuthentication.BoxAuthenticationInfo info)

Called when this session has been refreshed with new authentication info.

Specified by:

onRefreshed in interface BoxAuthentication.AuthListener

Parameters:

info - the latest info from a successful refresh.

onAuthCreated

public void onAuthCreated(BoxAuthentication.BoxAuthenticationInfo info)

Called when this user has logged in.

Specified by:

onAuthCreated in interface BoxAuthentication.AuthListener

Parameters:

info - the latest info from going through the login flow.

onAuthFailure

public void onAuthFailure(BoxAuthentication.BoxAuthenticationInfo info,
                          java.lang.Exception ex)

Called when a failure occurs trying to authenticate or refresh.

Specified by:

onAuthFailure in interface BoxAuthentication.AuthListener

Parameters:

info - The last authentication information available, before the exception.

ex - the exception that occurred.

startAuthenticationUI

protected void startAuthenticationUI()

onLoggedOut

public void onLoggedOut(BoxAuthentication.BoxAuthenticationInfo info,
                        java.lang.Exception ex)

Description copied from interface: BoxAuthentication.AuthListener

Called when the session was logged out of

Specified by:

onLoggedOut in interface BoxAuthentication.AuthListener

Parameters:

info - The last authentication information available

ex - the exception that occurred, if any

getClientId

public java.lang.String getClientId()

Returns the associated client id. If none is set, the one defined in BoxConfig will be used

Returns:

the client id this session is associated with.

getClientSecret

public java.lang.String getClientSecret()

Returns the associated client secret. Because client secrets are not managed by the SDK, if another client id/secret is used aside from the one defined in the BoxConfig

Returns:

the client secret this session is associated with

getRedirectUrl

public java.lang.String getRedirectUrl()

Returns:

the redirect url this session is using. By default comes from BoxConstants.