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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected BoxAuthentication.BoxAuthenticationInfo	mAuthInfo
protected java.lang.String	mClientId
protected java.lang.String	mClientRedirectUrl
protected java.lang.String	mClientSecret

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, 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 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

Methods

Modifier and Type	Method and Description
BoxFutureTask<BoxSession>	authenticate()
protected BoxFutureTask<BoxSession>	authenticate(boolean viaBoxApp)
protected BoxFutureTask<BoxSession>	authenticateUsingBoxApp() Authenticate the user using the box application if installed.
android.content.Context	getApplicationContext()
BoxAuthentication.BoxAuthenticationInfo	getAuthInfo()
java.lang.String	getClientId() Returns the associated client id.
java.lang.String	getClientSecret() Returns the associated client secret.
java.lang.String	getRedirectUrl()
BoxSharedLinkSession	getSharedLinkSession(java.lang.String sharedLinkUri) Create a shared link session based off of the current session.
BoxUser	getUser()
java.lang.String	getUserAgent()
java.lang.String	getUserId()
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)
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	setSessionAuthListener(BoxAuthentication.AuthListener listener)
protected void	setupSession()
protected void	setUserId(java.lang.String userId)

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

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.

Method Detail

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.

getUserAgent

public java.lang.String getUserAgent()

Returns:

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

authenticate

public BoxFutureTask<BoxSession> authenticate()

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()).

authenticateUsingBoxApp

protected BoxFutureTask<BoxSession> authenticateUsingBoxApp()

Authenticate the user using the box application if installed. Authenticating via the box application has the advantage of already logged in users not having to re-enter their username and password.

authenticate

protected BoxFutureTask<BoxSession> authenticate(boolean viaBoxApp)

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.

getSharedLinkSession

public BoxSharedLinkSession getSharedLinkSession(java.lang.String sharedLinkUri)

Create a shared link session based off of the current session.

Parameters:

sharedLinkUri - The url of the shared link.

Returns:

a session that can access a given shared link url and its children.

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.

onLoggedOut

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

Specified by:

onLoggedOut in interface BoxAuthentication.AuthListener

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.