org.alfresco.mobile.android.api.services.impl

Class AlfrescoService

java.lang.Object

org.alfresco.mobile.android.api.services.impl.AlfrescoService

All Implemented Interfaces:

android.os.Parcelable, Service

Direct Known Subclasses:

AbstractActivityStreamService, AbstractCommentService, AbstractDocumentFolderServiceImpl, AbstractModelDefinitionService, AbstractPersonService, AbstractRatingsService, AbstractSiteServiceImpl, AbstractWorkflowService, OnPremiseTaggingServiceImpl, PublicAPITaggingServiceImpl, SearchServiceImpl, VersionServiceImpl

public abstract class AlfrescoService
extends Object
implements Service

Abstract base class for all public Alfresco SDK Services. Contains all utility methods that are common for building a service.
Developers can extend this class if they want to add new services inside the SDK.
NB : Don't forget to add the newly service to a custom ServiceRegistry

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 static int	CONTENT_CACHE
protected static int	RENDITION_CACHE
protected AlfrescoSession	session Repository Session.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AlfrescoService() Default empty Constructor.
AlfrescoService(AlfrescoSession repositorySession) Default constructor for service.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all caches informations used by the service.
protected static void	convertException(Exception t) Catch all underlying CMIS or not exception and throw them as AlfrescoServiceException
protected Node	convertNode(org.apache.chemistry.opencmis.client.api.CmisObject object) Wrap and transform cmisobject into NodeObject
protected Node	convertNode(org.apache.chemistry.opencmis.client.api.CmisObject object, boolean hasAllProperties)
void	convertStatusCode(org.apache.chemistry.opencmis.client.bindings.spi.http.Response resp, int serviceErrorCode) Try to convert error response from repository into high level ErrorContent object.
protected void	delete(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, int errorCode) Performs a DELETE on an URL, checks the response code and returns the result.
int	describeContents()
protected org.apache.chemistry.opencmis.client.bindings.spi.http.HttpInvoker	getHttpInvoker() Gets the HTTP Invoker object.
protected org.apache.chemistry.opencmis.client.bindings.spi.BindingSession	getSessionHttp()
protected boolean	isCloudSession()
protected boolean	isListNull(List l) Utils method to check if a list is null/empty.
protected boolean	isMapNull(Map m) Utils method to check if a map is null/empty.
protected boolean	isObjectNull(Object o) Utils method to check if an object is null.
protected boolean	isOnPremiseSession()
protected boolean	isStringNull(String s) Utils method to check if a string objec is null or empty.
protected org.apache.chemistry.opencmis.client.bindings.spi.http.Response	post(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, String contentType, org.apache.chemistry.opencmis.client.bindings.spi.http.Output writer, int errorCode) Performs a POST on an URL, checks the response code and returns the result.
protected org.apache.chemistry.opencmis.client.bindings.spi.http.Response	put(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, String contentType, Map<String,String> headers, org.apache.chemistry.opencmis.client.bindings.spi.http.Output writer, int errorCode) Performs a PUT on an URL, checks the response code and returns the result.
protected org.apache.chemistry.opencmis.client.bindings.spi.http.Response	read(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, int errorCode) Performs a GET on an URL, checks the response code and returns the result.
protected ContentFile	saveContentStream(ContentStream contentStream, String cacheFileName, int storageType) Allow to save a contentStream inside the devices file system.
void	writeToParcel(android.os.Parcel dest, int arg1)

Methods inherited from class java.lang.Object

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

Field Detail

session

protected AlfrescoSession session

Repository Session.

RENDITION_CACHE

protected static final int RENDITION_CACHE

See Also:

Constant Field Values

CONTENT_CACHE

protected static final int CONTENT_CACHE

See Also:

Constant Field Values

Constructor Detail

AlfrescoService

public AlfrescoService()

Default empty Constructor.

AlfrescoService

public AlfrescoService(AlfrescoSession repositorySession)

Default constructor for service.
Used by the ServiceRegistry.

Parameters:

repositorySession - : Repository Session.

cmisSession - : CMIS session.

Method Detail

read

protected org.apache.chemistry.opencmis.client.bindings.spi.http.Response read(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url,
                                                                   int errorCode)

Performs a GET on an URL, checks the response code and returns the result.

Parameters:

url - : requested URL. @ : if network or internal problems occur during the process.

post

protected org.apache.chemistry.opencmis.client.bindings.spi.http.Response post(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url,
                                                                   String contentType,
                                                                   org.apache.chemistry.opencmis.client.bindings.spi.http.Output writer,
                                                                   int errorCode)

Performs a POST on an URL, checks the response code and returns the result. @ : if network or internal problems occur during the process.

delete

protected void delete(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url,
          int errorCode)

Performs a DELETE on an URL, checks the response code and returns the result. @ : if network or internal problems occur during the process.

put

protected org.apache.chemistry.opencmis.client.bindings.spi.http.Response put(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url,
                                                                  String contentType,
                                                                  Map<String,String> headers,
                                                                  org.apache.chemistry.opencmis.client.bindings.spi.http.Output writer,
                                                                  int errorCode)

Performs a PUT on an URL, checks the response code and returns the result. @ : if network or internal problems occur during the process.

getSessionHttp

protected org.apache.chemistry.opencmis.client.bindings.spi.BindingSession getSessionHttp()

Returns:

Binding session for passing the authenticationProvider to execute the http request.

getHttpInvoker

protected org.apache.chemistry.opencmis.client.bindings.spi.http.HttpInvoker getHttpInvoker()

Gets the HTTP Invoker object.

convertNode

protected Node convertNode(org.apache.chemistry.opencmis.client.api.CmisObject object)

Wrap and transform cmisobject into NodeObject

Parameters:

object - : Underlying OpenCMIS Object

Returns:

Alfresco Node Object.

convertNode

protected Node convertNode(org.apache.chemistry.opencmis.client.api.CmisObject object,
               boolean hasAllProperties)

isObjectNull

protected boolean isObjectNull(Object o)

Utils method to check if an object is null.

Parameters:

o - : object to check

Returns:

true if the object is null.

isStringNull

protected boolean isStringNull(String s)

Utils method to check if a string objec is null or empty.

Parameters:

s - : String to check

Returns:

true if the string is null/empty.

isListNull

protected boolean isListNull(List l)

Utils method to check if a list is null/empty.

Parameters:

l - : object to check

Returns:

true if the list is null or empty.

isMapNull

protected boolean isMapNull(Map m)

Utils method to check if a map is null/empty.

Parameters:

l - : object to check

Returns:

true if the list is null or empty.

isOnPremiseSession

protected boolean isOnPremiseSession()

isCloudSession

protected boolean isCloudSession()

convertException

protected static void convertException(Exception t)

Catch all underlying CMIS or not exception and throw them as AlfrescoServiceException

Parameters:

t - : exceptions catched

convertStatusCode

public void convertStatusCode(org.apache.chemistry.opencmis.client.bindings.spi.http.Response resp,
                     int serviceErrorCode)

Try to convert error response from repository into high level ErrorContent object. This object allow developper to retrieve information on the exception.

Parameters:

resp - : http response.

serviceErrorCode - : service from which the error occurs.

saveContentStream

protected ContentFile saveContentStream(ContentStream contentStream,
                            String cacheFileName,
                            int storageType)

Allow to save a contentStream inside the devices file system. The content is saved as cache file inside a cache folder. It's possible to determine the subfolders.

Parameters:

contentStream - : Content stream of any content

cacheFileName - : Name of the cache file

storageType - : Determine in which subfolders the content is stored

Returns:

ContentFile associated to the cache file.

clear

public void clear()

Description copied from interface: Service

Clear all caches informations used by the service.

Specified by:

clear in interface Service

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                 int arg1)

Specified by:

writeToParcel in interface android.os.Parcelable