AlfrescoSession (Alfresco Mobile Android 1.5.1-SNAPSHOT)

All Superinterfaces:

android.os.Parcelable

All Known Implementing Classes:

AbstractAlfrescoSessionImpl, CloudSession, CloudSessionImpl, RepositorySession, RepositorySessionImpl
```
public interface AlfrescoSession
extends android.os.Parcelable
```
RepositorySession represents a connection to an on-premise 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`	`AUTHENTICATOR_CLASSNAME` Define the specific implementation of authenticator for the session.
`static String`	`CACHE_FOLDER` Define the path to the cache folder.
`static String`	`CLOUD_SERVICES_CLASSNAME` Cloud ONLY Define the specific implementation of all services for the session.
`static String`	`CREATE_THUMBNAIL` OnPremise ONLY : Allow thumbnail generation during file import.
`static String`	`EXTRACT_METADATA` OnPremise ONLY : Allow metadata extraction during file import.
`static String`	`HTTP_ACCEPT_ENCODING` Define the HTTP Header "Accept-Encoding" for all requests. Values can be true (as string value) : gzip,deflate false (as string value) : empty value any string value : replace the default value. This parameter can't be changed after the session creation.
`static String`	`HTTP_ACCEPT_LANGUAGE` Define the HTTP Header "Accept-Language" for all requests. By default it's system Locale + ", en-us;q=0.8" This parameter can't be changed after the session creation.
`static String`	`HTTP_CHUNK_TRANSFERT` Used by the NetworkHttpInvoker to enable/disable the chunkStreamingMode.
`static String`	`HTTP_INVOKER_CLASSNAME` Define the specific implementation of HTTP layer for the session.
`static String`	`LISTING_MAX_ITEMS` Define the maximum number of items a list can contains by default in all SDK services. Value must be an Integer > 0.
`static String`	`ONPREMISE_SERVICES_CLASSNAME` OnPremise ONLY : Define the specific implementation of all services for the session.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

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.
`String`	`getBaseUrl()` Returns the base URL associated to the repository e.g.
`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.
`String`	`getPersonIdentifier()` Returns the user identifier with which the session was created.
`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.
`void`	`removeParameter(String key)` Removes a parameter stored in the session.

Methods inherited from interface android.os.Parcelable
describeContents, writeToParcel

- Field Detail
  - HTTP_ACCEPT_ENCODING
```
static final String HTTP_ACCEPT_ENCODING
```
    Define the HTTP Header "Accept-Encoding" for all requests.
    Values can be
    - true (as string value) : gzip,deflate
    - false (as string value) : empty value
    - any string value : replace the default value.
    This parameter can't be changed after the session creation.
    Since:
    
    1.3
    
    See Also:
    Constant Field Values
  - HTTP_ACCEPT_LANGUAGE
```
static final String HTTP_ACCEPT_LANGUAGE
```
    Define the HTTP Header "Accept-Language" for all requests.
    By default it's system Locale + ", en-us;q=0.8" This parameter can't be changed after the session creation.
    
    Since:
    
    1.3
    
    See Also:
    Constant Field Values
  - HTTP_CHUNK_TRANSFERT
```
static final String HTTP_CHUNK_TRANSFERT
```
    Used by the NetworkHttpInvoker to enable/disable the chunkStreamingMode. Some HTTP server configuration doesn't support this mode.
    By default the mode is disabled. This parameter can't be changed after the session creation.
    
    Since:
    
    1.3
    
    See Also:
    Constant Field Values
  - ONPREMISE_SERVICES_CLASSNAME
```
static final String ONPREMISE_SERVICES_CLASSNAME
```
    OnPremise ONLY : Define the specific implementation of all services for the session. Must be a full qualified classname. This class must extend ServiceRegistry
    This parameter can't be changed after the session creation.
    
    See Also:
    Constant Field Values
  - CLOUD_SERVICES_CLASSNAME
```
static final String CLOUD_SERVICES_CLASSNAME
```
    Cloud ONLY Define the specific implementation of all services for the session. Must be a full qualified classname. This class must extend ServiceRegistry This parameter can't be changed after the session creation.
    
    See Also:
    Constant Field Values
  - AUTHENTICATOR_CLASSNAME
```
static final String AUTHENTICATOR_CLASSNAME
```
    Define the specific implementation of authenticator for the session. Must be a full qualified classname. This class must extend AuthenticationProvider
    This parameter can't be changed after the session creation.
    
    See Also:
    Constant Field Values
  - HTTP_INVOKER_CLASSNAME
```
static final String HTTP_INVOKER_CLASSNAME
```
    Define the specific implementation of HTTP layer for the session. Must be a full qualified classname. This class must extend HttpInvoker
    This parameter can't be changed after the session creation.
    
    See Also:
    Constant Field Values
  - EXTRACT_METADATA
```
static final String EXTRACT_METADATA
```
    OnPremise ONLY : Allow metadata extraction during file import. Value must be a boolean. Default : false
    
    See Also:
    Constant Field Values
  - CREATE_THUMBNAIL
```
static final String CREATE_THUMBNAIL
```
    OnPremise ONLY : Allow thumbnail generation during file import. Value must be a boolean. Default : false
    
    See Also:
    Constant Field Values
  - LISTING_MAX_ITEMS
```
static final String LISTING_MAX_ITEMS
```
    Define the maximum number of items a list can contains by default in all SDK services.
    Value must be an Integer > 0.
    Default : 50
    
    See Also:
    Constant Field Values
  - CACHE_FOLDER
```
static final String CACHE_FOLDER
```
    Define the path to the cache folder. The cache folder is used to store temporary file.
    Value must be String value that represents a valid path inside the device.
    Default : "/sdcard/Android/data/org.alfresco.mobile.android.sdk/cache"
    
    See Also:
    Constant Field Values
- Method Detail
  - getRepositoryInfo
```
RepositoryInfo getRepositoryInfo()
```
    Returns RepositoryInformation object representing the repository the session is connected to.
  - getBaseUrl
```
String getBaseUrl()
```
    Returns the base URL associated to the repository e.g. http://hostname:port/alfresco.
  - getPersonIdentifier
```
String getPersonIdentifier()
```
    Returns the user identifier with which the session was created.
  - getDefaultListingContext
```
ListingContext getDefaultListingContext()
```
    Returns the current default listing parameters for paging and sorting.
  - getServiceRegistry
```
ServiceRegistry getServiceRegistry()
```
    Return all services available with this repository.
    
    Returns:
    Service Provider associated to the session.
  - getRootFolder
```
Folder getRootFolder()
```
    Returns the root folder of the repository this session is connected to.
  - addParameter
```
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.
    
    Parameters:
    key -
    value -
  - addParameters
```
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.
    
    Parameters:
    parameters -
  - getParameter
```
Serializable getParameter(String key)
```
    Returns the value of a parameter with the given key stored in the session.
    
    Parameters:
    key -
    
    Returns:
  - removeParameter
```
void removeParameter(String key)
```
    Removes a parameter stored in the session.
    
    Parameters:
    key -
  - getParameterKeys
```
List<String> getParameterKeys()
```
    Returns a list of all the parameter names stored in the sesssion.
  - clear
```
void clear()
```
    Clears any cached data the session is storing.

Interface AlfrescoSession

Nested Class Summary

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

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from interface android.os.Parcelable

Field Detail

HTTP_ACCEPT_ENCODING

HTTP_ACCEPT_LANGUAGE

HTTP_CHUNK_TRANSFERT

ONPREMISE_SERVICES_CLASSNAME

CLOUD_SERVICES_CLASSNAME

AUTHENTICATOR_CLASSNAME

HTTP_INVOKER_CLASSNAME

EXTRACT_METADATA

CREATE_THUMBNAIL

LISTING_MAX_ITEMS

CACHE_FOLDER

Method Detail

getRepositoryInfo

getBaseUrl

getPersonIdentifier

getDefaultListingContext

getServiceRegistry

getRootFolder

addParameter

addParameters

getParameter

removeParameter

getParameterKeys

clear