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

Class AbstractDocumentFolderServiceImpl

java.lang.Object

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

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

All Implemented Interfaces:

android.os.Parcelable, DocumentFolderService, Service

Direct Known Subclasses:

OnPremiseDocumentFolderServiceImpl, PublicAPIDocumentFolderServiceImpl

public abstract class AbstractDocumentFolderServiceImpl
extends AlfrescoService
implements DocumentFolderService

Abstract class implementation of DocumentFolderService. Responsible of sharing common methods between child class (OnPremise and Cloud)

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 org.apache.chemistry.opencmis.client.api.Session	cmisSession

Fields inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

CONTENT_CACHE, RENDITION_CACHE, session

Fields inherited from interface org.alfresco.mobile.android.api.services.DocumentFolderService

FILTER_INCLUDE_LINKS, RENDITION_PREVIEW, RENDITION_THUMBNAIL, SORT_PROPERTY_CREATED_AT, SORT_PROPERTY_DESCRIPTION, SORT_PROPERTY_MODIFIED_AT, SORT_PROPERTY_NAME, SORT_PROPERTY_TITLE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentFolderServiceImpl(AlfrescoSession repositorySession) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Node	addAspects(Node node, List<String> aspects) Adds the given aspects to the given node.
Document	createDocument(Folder parentFolder, String documentName, Map<String,Serializable> properties, ContentFile contentFile) Creates a document object in the specified location with an optional set of properties.
Document	createDocument(Folder parentFolder, String documentName, Map<String,Serializable> properties, ContentFile contentFile, List<String> aspects) Creates a document object in the specified location with an optional set of properties.
Document	createDocument(Folder parentFolder, String documentName, Map<String,Serializable> properties, ContentFile contentFile, List<String> aspects, String type) Creates a document object in the specified location with an optional set of properties.
Folder	createFolder(Folder parentFolder, String folderName, Map<String,Serializable> properties) Creates a folder object in the specified location with an optional set of properties and aspects.
Folder	createFolder(Folder parentFolder, String folderName, Map<String,Serializable> properties, List<String> aspects) Creates a folder object in the specified location with an optional set of properties and aspects.
Folder	createFolder(Folder parentFolder, String folderName, Map<String,Serializable> properties, List<String> aspects, String type) Creates a folder object in the specified location with an optional set of properties and aspects.
void	deleteNode(Node node) Deletes the specified node.
ContentStream	downloadContentStream(String identifier)
Node	getChildByPath(Folder folder, String relativePathFromFolder) Gets the node object stored at the relative specified path from the folder object.
Node	getChildByPath(String path) Gets the node object stored at the specified path.
List<Node>	getChildren(Folder parentFolder) Lists all immediate child nodes of the given context folder.
PagingResult<Node>	getChildren(Folder parentFolder, ListingContext lcontext) Lists immediate child nodes of the given context folder.
ContentFile	getContent(Document document) Downloads the content for the given document.
ContentStream	getContentStream(Document document) Downloads the content for the given document as InputStream.
List<Document>	getDocuments(Folder folder) Lists all immediate child documents of the given context node Note: this could be a long list
PagingResult<Document>	getDocuments(Folder folder, ListingContext listingContext) Lists all immediate child documents of the given context folder.
String	getDownloadUrl(Document document) Internal : Retrieves the downloading url for the given document.
List<Folder>	getFolders(Folder parentFolder) Lists all immediate child folders of the given context folder.
PagingResult<Folder>	getFolders(Folder folder, ListingContext listingContext) Lists all immediate child folders of the given context folder.
Node	getNodeByIdentifier(String identifier)
Folder	getParentFolder(Node node) Gets the direct parent folder object.
Permissions	getPermissions(Node node)
ContentFile	getRendition(Node node, String type) Retrieve a specific type of Rendition for the specified identifier.
ContentStream	getRenditionStream(Node node, String type) Retrieve a specific type of Rendition for the specified identifier as InputStream
abstract ContentStream	getRenditionStream(String identifier, String type)
abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getRenditionUrl(String identifier, String type)
Folder	getRootFolder()
Node	refreshNode(Node node) Returns the latest (and complete) metadata for the provided node.
Document	updateContent(Document content, ContentFile contentFile) Updates the content on the given document using the provided local file.
Node	updateProperties(Node node, Map<String,Serializable> properties) Updates the properties of the specified node.
Node	updateProperties(Node node, Map<String,Serializable> properties, List<String> aspects) Updates the properties for the given node and applies the given aspects.
protected Node	updateProperties(Node node, Map<String,Serializable> properties, List<String> aspects, boolean propertiesRequired)

Methods inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

clear, convertException, convertNode, convertNode, convertStatusCode, delete, describeContents, getHttpInvoker, getSessionHttp, isCloudSession, isListNull, isMapNull, isObjectNull, isOnPremiseSession, isStringNull, post, put, read, saveContentStream, writeToParcel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.mobile.android.api.services.DocumentFolderService

addFavorite, getFavoriteDocuments, getFavoriteDocuments, getFavoriteFolders, getFavoriteFolders, getFavoriteNodes, getFavoriteNodes, isFavorite, removeFavorite

Methods inherited from interface org.alfresco.mobile.android.api.services.Service

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

cmisSession

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

Constructor Detail

AbstractDocumentFolderServiceImpl

public AbstractDocumentFolderServiceImpl(AlfrescoSession repositorySession)

Default Constructor. Only used inside ServiceRegistry.

Parameters:

repositorySession - : Repository Session.

Method Detail

getChildren

public List<Node> getChildren(Folder parentFolder)

Lists all immediate child nodes of the given context folder.
By default, this list contains a maximum of 50 elements.
Use DocumentFolderService.getChildren(Folder, ListingContext) to change this behaviour.

Specified by:

getChildren in interface DocumentFolderService

Parameters:

parentFolder - : context folder

Returns:

Returns a list of the immediate child nodes of the given folder.

See Also:

DocumentFolderService.getChildren(Folder, ListingContext)

getChildren

public PagingResult<Node> getChildren(Folder parentFolder,
                             ListingContext lcontext)

Lists immediate child nodes of the given context folder.

Specified by:

getChildren in interface DocumentFolderService

Parameters:

parentFolder - : context folder

lcontext - : Listing context that define the behaviour of paging results ListingContext

Returns:

Returns a paged list of the immediate child nodes of the given folder.

getChildByPath

public Node getChildByPath(String path)

Gets the node object stored at the specified path.

Specified by:

getChildByPath in interface DocumentFolderService

Parameters:

path - : path from the root folder.

Returns:

Returns the node object stored at the specified path.

getChildByPath

public Node getChildByPath(Folder folder,
                  String relativePathFromFolder)

Gets the node object stored at the relative specified path from the folder object.

Specified by:

getChildByPath in interface DocumentFolderService

Parameters:

folder - : context folder

relativePathFromFolder - : relative path from the root folder.

Returns:

Returns the node object stored at the given path relative from the given folder.

getNodeByIdentifier

public Node getNodeByIdentifier(String identifier)

Specified by:

getNodeByIdentifier in interface DocumentFolderService

Returns:

Returns the node object with the specified identifier.

getRootFolder

public Folder getRootFolder()

Specified by:

getRootFolder in interface DocumentFolderService

Returns:

Returns the root folder of the repository.

getFolders

public List<Folder> getFolders(Folder parentFolder)

Lists all immediate child folders of the given context folder.

Specified by:

getFolders in interface DocumentFolderService

Parameters:

parentFolder - : Parent Folder

Returns:

Returns a list of all immediate child folders of the given folder.

See Also:

DocumentFolderService.getFolders(Folder, ListingContext)

getFolders

public PagingResult<Folder> getFolders(Folder folder,
                              ListingContext listingContext)

Lists all immediate child folders of the given context folder.

Specified by:

getFolders in interface DocumentFolderService

Parameters:

folder - : Parent Folder

listingContext - : : defines the behaviour of paging results ListingContext

Returns:

Returns a paged list of all immediate child folders of the given folder.

See Also:

DocumentFolderService.getFolders(Folder)

getDocuments

public List<Document> getDocuments(Folder folder)

Lists all immediate child documents of the given context node
Note: this could be a long list

Specified by:

getDocuments in interface DocumentFolderService

Parameters:

folder - : context folder

Returns:

Returns a list of all immediate child documents of the given folder.

See Also:

DocumentFolderService.getDocuments(Folder, ListingContext)

getDocuments

public PagingResult<Document> getDocuments(Folder folder,
                                  ListingContext listingContext)

Lists all immediate child documents of the given context folder.

Specified by:

getDocuments in interface DocumentFolderService

Parameters:

folder - : context folder

listingContext - : defines the behavior of paging results ListingContext

Returns:

Returns a paged list of all immediate child documents of the given folder.

getParentFolder

public Folder getParentFolder(Node node)

Gets the direct parent folder object.

Specified by:

getParentFolder in interface DocumentFolderService

Parameters:

node - : Node object (Folder or Document).

Returns:

Returns the parent folder object of the given node, null if the node does not have a parent.

createFolder

public Folder createFolder(Folder parentFolder,
                  String folderName,
                  Map<String,Serializable> properties)

Creates a folder object in the specified location with an optional set of properties and aspects.

Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description

A collection of default Alfresco aspects and properties are available inside the ContentModel

Specified by:

createFolder in interface DocumentFolderService

folderName - : Name of the future folder

properties - : Map of properties to apply to the new folder

Returns:

the newly created folder

createFolder

public Folder createFolder(Folder parentFolder,
                  String folderName,
                  Map<String,Serializable> properties,
                  List<String> aspects)

Creates a folder object in the specified location with an optional set of properties and aspects.

Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.

A collection of default Alfresco aspects and properties are available inside the ContentModel

Specified by:

createFolder in interface DocumentFolderService

folderName - : Name of the future folder

properties - : Map of properties to apply to the new folder

aspects - : List of aspects to apply to the new folder

Returns:

the newly created folder

createFolder

public Folder createFolder(Folder parentFolder,
                  String folderName,
                  Map<String,Serializable> properties,
                  List<String> aspects,
                  String type)

Creates a folder object in the specified location with an optional set of properties and aspects.

Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.
Type value must respect the format : namespace_prefix:property_name like my:customfolder / cm:folder

A collection of default Alfresco aspects and properties are available inside the ContentModel

Specified by:

createFolder in interface DocumentFolderService

folderName - : Name of the future folder

properties - : Map of properties to apply to the new folder

aspects - : List of aspects to apply to the new folder

type - : custom type of the folder. If null it creates a default cm:folder.

Returns:

the newly created folder

createDocument

public Document createDocument(Folder parentFolder,
                      String documentName,
                      Map<String,Serializable> properties,
                      ContentFile contentFile)

Creates a document object in the specified location with an optional set of properties. The content for the node is taken from the provided file.
If the file parameter is not provided the document is created without content.
If the session is bind to an onPremise server and depending on sessionSettings, this method can launch metadata extraction and thumbnail generation after creation.

Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description

A collection of default Alfresco aspects and properties are available inside the ContentModel

Specified by:

createDocument in interface DocumentFolderService

properties - : (Optional) list of property values that must be applied

contentFile - : (Optional) ContentFile that contains data stream or file

Returns:

the newly created document object.

createDocument

public Document createDocument(Folder parentFolder,
                      String documentName,
                      Map<String,Serializable> properties,
                      ContentFile contentFile,
                      List<String> aspects)

Creates a document object in the specified location with an optional set of properties. The content for the node is taken from the provided file.
If the file parameter is not provided the document is created without content.
If the session is bind to an onPremise server and depending on sessionSettings, this method can launch metadata extraction and thumbnail generation after creation.

Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.

A collection of default Alfresco aspects and properties are available inside the ContentModel

Specified by:

createDocument in interface DocumentFolderService

properties - : (Optional) list of property values that must be applied

contentFile - : (Optional) ContentFile that contains data stream or file

aspects - : List of aspects to apply to the new folder

Returns:

the newly created document object.

createDocument

public Document createDocument(Folder parentFolder,
                      String documentName,
                      Map<String,Serializable> properties,
                      ContentFile contentFile,
                      List<String> aspects,
                      String type)

Creates a document object in the specified location with an optional set of properties. The content for the node is taken from the provided file.
If the file parameter is not provided the document is created without content.
If the session is bind to an onPremise server and depending on sessionSettings, this method can launch metadata extraction and thumbnail generation after creation.

Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.
Type value must respect the format : namespace_prefix:property_name like my:customfolder / cm:folder

A collection of default Alfresco aspects and properties are available inside the ContentModel

Specified by:

createDocument in interface DocumentFolderService

properties - : (Optional) list of property values that must be applied

contentFile - : (Optional) ContentFile that contains data stream or file

aspects - : List of aspects to apply to the new folder

type - : custom type of the folder. If null it creates a default cm:folder.

Returns:

the newly created document object.

deleteNode

public void deleteNode(Node node)

Deletes the specified node.

Specified by:

deleteNode in interface DocumentFolderService

Parameters:

node - : Node object (Folder or Document).

addAspects

public Node addAspects(Node node,
              List<String> aspects)

Adds the given aspects to the given node.

Specified by:

addAspects in interface DocumentFolderService

Parameters:

node - Node to update

aspects - : list of aspects to apply

Returns:

Returns Newly update node.

updateProperties

public Node updateProperties(Node node,
                    Map<String,Serializable> properties)

Updates the properties of the specified node. Can accept Alfresco Content Model Properties id or cmis properties id.

Specified by:

updateProperties in interface DocumentFolderService

Parameters:

node - : Node to update

properties - : Properties to update.

Returns:

Returns Newly update node.

updateProperties

public Node updateProperties(Node node,
                    Map<String,Serializable> properties,
                    List<String> aspects)

Updates the properties for the given node and applies the given aspects. Can accept Alfresco Content Model Properties id or cmis properties id.

Specified by:

updateProperties in interface DocumentFolderService

Parameters:

node - : Node to update

properties - : Properties to update.

aspects - : list of aspects to apply

Returns:

Returns Newly update node.

updateProperties

protected Node updateProperties(Node node,
                    Map<String,Serializable> properties,
                    List<String> aspects,
                    boolean propertiesRequired)

updateContent

public Document updateContent(Document content,
                     ContentFile contentFile)

Updates the content on the given document using the provided local file.

Specified by:

updateContent in interface DocumentFolderService

Parameters:

content - : Document object

contentFile - : File that is going to replace document content

Returns:

newly updated Document.

getContent

public ContentFile getContent(Document document)

Downloads the content for the given document.

Specified by:

getContent in interface DocumentFolderService

Parameters:

document - : Document object

Returns:

the contentFile representation that contains file informations + inputStream of the content.

getContentStream

public ContentStream getContentStream(Document document)

Downloads the content for the given document as InputStream.

Specified by:

getContentStream in interface DocumentFolderService

Parameters:

document - : Document object

Returns:

the contentFile representation that contains file informations + inputStream of the content.

downloadContentStream

public ContentStream downloadContentStream(String identifier)

getDownloadUrl

public String getDownloadUrl(Document document)

Internal : Retrieves the downloading url for the given document.

Parameters:

document -

Returns:

@ : if network or internal problems occur during the process.

getRenditionStream

public abstract ContentStream getRenditionStream(String identifier,
                               String type)

getRenditionUrl

public abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getRenditionUrl(String identifier,
                                                                    String type)

getRenditionStream

public ContentStream getRenditionStream(Node node,
                               String type)

Retrieve a specific type of Rendition for the specified identifier as InputStream

Specified by:

getRenditionStream in interface DocumentFolderService

Parameters:

node - : Node (Document in general)

type - : : Type of rendition available

Returns:

Returns a ContentFile object representing a rendition of the given node.

getRendition

public ContentFile getRendition(Node node,
                       String type)

Retrieve a specific type of Rendition for the specified identifier.

Specified by:

getRendition in interface DocumentFolderService

Parameters:

node - : Node (Document in general)

type - : : Type of rendition available

Returns:

Returns a ContentFile object representing a rendition of the given node.

getPermissions

public Permissions getPermissions(Node node)

Specified by:

getPermissions in interface DocumentFolderService

Returns:

Returns a Permissions object representing the allowed actions for the current user on the given node.

refreshNode

public Node refreshNode(Node node)

Description copied from interface: DocumentFolderService

Returns the latest (and complete) metadata for the provided node.

Specified by:

refreshNode in interface DocumentFolderService

Returns: