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

Class AbstractAlfrescoSessionImpl

java.lang.Object

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

All Implemented Interfaces:

android.os.Parcelable, AlfrescoSession

Direct Known Subclasses:

CloudSession, RepositorySession

public abstract class AbstractAlfrescoSessionImpl
extends Object
implements AlfrescoSession, android.os.Parcelable

AlfrescoSession is the base class for all connection to a repository.

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
protected AuthenticationProvider	authenticator Authentication Provider.
protected String	baseUrl
protected org.apache.chemistry.opencmis.client.api.Session	cmisSession Cmis Session that comes from OpenCMIS binding.
static String	DEFAULT_CACHE_FOLDER_PATH Default Value of cache folder for the session.
protected boolean	hasPublicAPI
protected org.apache.chemistry.opencmis.commons.spi.AuthenticationProvider	passThruAuthenticator Default CMIS wrapper to use Alfresco Authenticator.
protected String	password
protected static String	PASSWORD
protected RepositoryInfo	repositoryInfo Repository Informations to the specific session.
protected Folder	rootNode Root Folder for the specific session.
protected ServiceRegistry	services Service Registry for all features available with this repository.
protected static String	USER
protected String	userIdentifier
protected Map<String,Serializable>	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
AbstractAlfrescoSessionImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String key, Serializable value) Allow to add some extra parameters as settings to modify behaviour of the session.
void	addParameters(Map<String,Serializable> parameters) Allow to add some extra parameters as settings to modify behaviour of the session.
void	clear() Clears any cached data the session is storing.
protected AuthenticationProvider	createAuthenticationProvider(String className) Create the Alfresco AuthenticationProvider.
protected ServiceRegistry	createServiceRegistry(String className) Extension Point to use a specific serviceRegistry.
protected org.apache.chemistry.opencmis.client.api.Session	createSession(org.apache.chemistry.opencmis.client.api.SessionFactory sessionFactory, AuthenticationProvider authenticator, Map<String,String> param)
protected org.apache.chemistry.opencmis.client.api.Session	createSession(org.apache.chemistry.opencmis.client.api.SessionFactory sessionFactory, Map<String,String> param)
AuthenticationProvider	getAuthenticationProvider()
String	getBaseUrl() Returns the base URL associated to the repository e.g.
org.apache.chemistry.opencmis.client.api.Session	getCmisSession() Direct access to the underlying cmis session.
ListingContext	getDefaultListingContext() Returns the current default listing parameters for paging and sorting.
Serializable	getParameter(String key) Returns the value of a parameter with the given key stored in the session.
List<String>	getParameterKeys() Returns a list of all the parameter names stored in the sesssion.
org.apache.chemistry.opencmis.commons.spi.AuthenticationProvider	getPassthruAuthenticationProvider()
String	getPersonIdentifier() Returns the user identifier with which the session was created.
String	getRepositoryIdentifier()
RepositoryInfo	getRepositoryInfo() Returns RepositoryInformation object representing the repository the session is connected to.
Folder	getRootFolder() Returns the root folder of the repository this session is connected to.
ServiceRegistry	getServiceRegistry() Return all services available with this repository.
boolean	hasForceBinding()
boolean	hasParameter(String key)
protected void	initSettings(String url, Map<String,Serializable> settings)
protected void	initSettings(String url, String username, String password, Map<String,Serializable> settings)
void	removeParameter(String key) Removes a parameter stored in the session.
protected Map<String,String>	retrieveSessionParameters() VIM : This method allows to create the CMIS Session Parameters based on Public Session Parameters provided.

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

DEFAULT_CACHE_FOLDER_PATH

public static final String DEFAULT_CACHE_FOLDER_PATH

Default Value of cache folder for the session.

See Also:

Constant Field Values

baseUrl

protected String baseUrl

userIdentifier

protected String userIdentifier

password

protected String password

rootNode

protected Folder rootNode

Root Folder for the specific session.

services

protected ServiceRegistry services

Service Registry for all features available with this repository.

repositoryInfo

protected RepositoryInfo repositoryInfo

Repository Informations to the specific session.

cmisSession

protected org.apache.chemistry.opencmis.client.api.Session cmisSession

Cmis Session that comes from OpenCMIS binding.

authenticator

protected AuthenticationProvider authenticator

Authentication Provider.

passThruAuthenticator

protected org.apache.chemistry.opencmis.commons.spi.AuthenticationProvider passThruAuthenticator

Default CMIS wrapper to use Alfresco Authenticator.

userParameters

protected Map<String,Serializable> userParameters

hasPublicAPI

protected boolean hasPublicAPI

USER

protected static final String USER

See Also:

Constant Field Values

PASSWORD

protected static final String PASSWORD

See Also:

Constant Field Values

Constructor Detail

AbstractAlfrescoSessionImpl

public AbstractAlfrescoSessionImpl()

Method Detail

initSettings

protected void initSettings(String url,
                Map<String,Serializable> settings)

initSettings

protected void initSettings(String url,
                String username,
                String password,
                Map<String,Serializable> settings)

addParameter

public void addParameter(String key,
                Serializable value)

Allow to add some extra parameters as settings to modify behaviour of the session. Settings provide session configuration parameters e.g. cache settings, default paging values, ordering etc.

Specified by:

addParameter in interface AlfrescoSession

addParameters

public void addParameters(Map<String,Serializable> parameters)

Allow to add some extra parameters as settings to modify behaviour of the session. Settings provide session configuration parameters e.g. cache settings, default paging values, ordering etc.

Specified by:

addParameters in interface AlfrescoSession

hasParameter

public boolean hasParameter(String key)

getParameter

public Serializable getParameter(String key)

Returns the value of a parameter with the given key stored in the session.

Specified by:

getParameter in interface AlfrescoSession

Returns:

removeParameter

public void removeParameter(String key)

Removes a parameter stored in the session.

Specified by:

removeParameter in interface AlfrescoSession

getParameterKeys

public List<String> getParameterKeys()

Returns a list of all the parameter names stored in the sesssion.

Specified by:

getParameterKeys in interface AlfrescoSession

retrieveSessionParameters

protected Map<String,String> retrieveSessionParameters()

VIM : This method allows to create the CMIS Session Parameters based on Public Session Parameters provided. Depending on session type, it creates the bunch of parameters OpenCMIS can understand.

Returns:

OpenCMIS Map of Session Parameters.

createSession

protected org.apache.chemistry.opencmis.client.api.Session createSession(org.apache.chemistry.opencmis.client.api.SessionFactory sessionFactory,
                                                             AuthenticationProvider authenticator,
                                                             Map<String,String> param)

createSession

protected org.apache.chemistry.opencmis.client.api.Session createSession(org.apache.chemistry.opencmis.client.api.SessionFactory sessionFactory,
                                                             Map<String,String> param)

createAuthenticationProvider

protected AuthenticationProvider createAuthenticationProvider(String className)

Create the Alfresco AuthenticationProvider. Used by the default "CMIS enable" PassThruAuthenticationProvider.

Parameters:

className -

Returns:

getRepositoryInfo

public RepositoryInfo getRepositoryInfo()

Description copied from interface: AlfrescoSession

Returns RepositoryInformation object representing the repository the session is connected to.

Specified by:

getRepositoryInfo in interface AlfrescoSession

Returns:

Returns RepositoryInformations object representing the repository the session is connected to.

getRepositoryIdentifier

public String getRepositoryIdentifier()

Returns:

Returns repository unique identifier.

getRootFolder

public Folder getRootFolder()

Description copied from interface: AlfrescoSession

Returns the root folder of the repository this session is connected to.

Specified by:

getRootFolder in interface AlfrescoSession

Returns:

Returns the root folder of the repository.

getBaseUrl

public String getBaseUrl()

Description copied from interface: AlfrescoSession

Returns the base URL associated to the repository e.g. http://hostname:port/alfresco.

Specified by:

getBaseUrl in interface AlfrescoSession

Returns:

Returns the base URL associated to the repository
For example : http://hostname:port/alfresco

getPersonIdentifier

public String getPersonIdentifier()

Description copied from interface: AlfrescoSession

Returns the user identifier with which the session was created.

Specified by:

getPersonIdentifier in interface AlfrescoSession

Returns:

Returns the username with which we have created the session.

getAuthenticationProvider

public AuthenticationProvider getAuthenticationProvider()

Returns:

Returns the authenticationProvider associated to the session.

getPassthruAuthenticationProvider

public org.apache.chemistry.opencmis.commons.spi.AuthenticationProvider getPassthruAuthenticationProvider()

getDefaultListingContext

public ListingContext getDefaultListingContext()

Returns the current default listing parameters for paging and sorting.

Specified by:

getDefaultListingContext in interface AlfrescoSession

getServiceRegistry

public ServiceRegistry getServiceRegistry()

Return all services available with this repository.

Specified by:

getServiceRegistry in interface AlfrescoSession

Returns:

Service Provider associated to the session.

getCmisSession

public org.apache.chemistry.opencmis.client.api.Session getCmisSession()

Direct access to the underlying cmis session. Use with caution.

Returns:

the cmisSession

createServiceRegistry

protected ServiceRegistry createServiceRegistry(String className)

Extension Point to use a specific serviceRegistry.

Parameters:

className - : ClassName of the serviceRegistry to implement

Returns:

an instance of serviceRegistry.

clear

public void clear()

Description copied from interface: AlfrescoSession

Clears any cached data the session is storing.

Specified by:

clear in interface AlfrescoSession

hasForceBinding

public boolean hasForceBinding()