org.alfresco.mobile.android.api.session

Class CloudSession

java.lang.Object

org.alfresco.mobile.android.api.session.impl.AbstractAlfrescoSessionImpl

org.alfresco.mobile.android.api.session.CloudSession

All Implemented Interfaces:

android.os.Parcelable, AlfrescoSession

Direct Known Subclasses:

CloudSessionImpl

public abstract class CloudSession
extends AbstractAlfrescoSessionImpl

Represents a connection to the Alfresco Cloud repository as a specific user.

Author:

Jean Marie Pascal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOUD_NETWORK_ID Define a different cloud network.
static String	USER_ME Username identifier for all cloud service API request.

Fields inherited from class org.alfresco.mobile.android.api.session.impl.AbstractAlfrescoSessionImpl

authenticator, baseUrl, cmisSession, DEFAULT_CACHE_FOLDER_PATH, hasPublicAPI, passThruAuthenticator, password, PASSWORD, repositoryInfo, rootNode, services, USER, userIdentifier, userParameters

Fields inherited from interface org.alfresco.mobile.android.api.session.AlfrescoSession

AUTHENTICATOR_CLASSNAME, CACHE_FOLDER, CLOUD_SERVICES_CLASSNAME, CREATE_THUMBNAIL, EXTRACT_METADATA, HTTP_ACCEPT_ENCODING, HTTP_ACCEPT_LANGUAGE, HTTP_CHUNK_TRANSFERT, HTTP_INVOKER_CLASSNAME, LISTING_MAX_ITEMS, ONPREMISE_SERVICES_CLASSNAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
CloudSession()

Method Summary

Methods

Modifier and Type	Method and Description
static CloudSession	connect(OAuthData oauthData) Connects to the Alfresco in the Cloud server in the context of the users home network.
static CloudSession	connect(OAuthData oauthData, Map<String,Serializable> parameters) Connects to the Alfresco in the Cloud server in the context of the users home network.
static CloudSession	connect(OAuthData oauthData, String networkId) Connects the given user to the Alfresco in the cloud server in the context of the given network.
static CloudSession	connect(OAuthData oauthData, String networkId, Map<String,Serializable> parameters) Connects the given user to the Alfresco in the cloud server in the context of the given network.
abstract CloudNetwork	getNetwork() Returns the current network for the session.
abstract List<CloudNetwork>	getNetworks() Returns the list of networks the current user has access to.
abstract OAuthData	getOAuthData() Returns the OAuthData the session is currently using.
abstract void	setOAuthData(OAuthData oauthData) Sets the OAuthData object associated with the session, typically used after an access token has been refreshed.

Methods inherited from class org.alfresco.mobile.android.api.session.impl.AbstractAlfrescoSessionImpl

addParameter, addParameters, clear, createAuthenticationProvider, createServiceRegistry, createSession, createSession, getAuthenticationProvider, getBaseUrl, getCmisSession, getDefaultListingContext, getParameter, getParameterKeys, getPassthruAuthenticationProvider, getPersonIdentifier, getRepositoryIdentifier, getRepositoryInfo, getRootFolder, getServiceRegistry, hasForceBinding, hasParameter, initSettings, initSettings, removeParameter, retrieveSessionParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

CLOUD_NETWORK_ID

public static final String CLOUD_NETWORK_ID

Define a different cloud network.
Value must be a String value that represents a valid network identifier.
Default : the home network of the logged user.
This parameter can't be changed after the session creation.

See Also:

Constant Field Values

USER_ME

public static final String USER_ME

Username identifier for all cloud service API request.
Indeed CloudSession doesn't know username of the logged user. Due to OAuth it's not aware of this information. To replace the username information, CloudSession use -me- instead.

See Also:

Constant Field Values

Constructor Detail

CloudSession

public CloudSession()

Method Detail

connect

public static CloudSession connect(OAuthData oauthData)

Connects to the Alfresco in the Cloud server in the context of the users home network.

Parameters:

oauthData -

Returns:

connect

public static CloudSession connect(OAuthData oauthData,
                   Map<String,Serializable> parameters)

Connects to the Alfresco in the Cloud server in the context of the users home network.

Parameters:

oauthData -

parameters -

Returns:

connect

public static CloudSession connect(OAuthData oauthData,
                   String networkId)

Connects the given user to the Alfresco in the cloud server in the context of the given network.

Parameters:

oauthData -

networkId -

Returns:

connect

public static CloudSession connect(OAuthData oauthData,
                   String networkId,
                   Map<String,Serializable> parameters)

Connects the given user to the Alfresco in the cloud server in the context of the given network.

Parameters:

oauthData -

networkId -

parameters -

Returns:

getNetworks

public abstract List<CloudNetwork> getNetworks()

Returns the list of networks the current user has access to.

getNetwork

public abstract CloudNetwork getNetwork()

Returns the current network for the session.

getOAuthData

public abstract OAuthData getOAuthData()

Returns the OAuthData the session is currently using.

Returns:

setOAuthData

public abstract void setOAuthData(OAuthData oauthData)

Sets the OAuthData object associated with the session, typically used after an access token has been refreshed.

Parameters:

oauthData -