org.alfresco.dataprep

Class CMISUtil

java.lang.Object

org.alfresco.dataprep.CMISUtil

Direct Known Subclasses:

ContentActions, ContentAspects, ContentService, DataListsService, UserService, WorkflowService

public class CMISUtil
extends Object

Helper class that provides CMIS utils.

Author:

Bogdan Bocancea

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CMISUtil.DocumentAspect Different Aspects of Documents and folders.
static class	CMISUtil.DocumentType
static class	CMISUtil.Priority
static class	CMISUtil.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected AlfrescoHttpClientFactory	alfrescoHttpClientFactory

Constructor Summary

Constructors

Constructor and Description
CMISUtil()

Method Summary

Modifier and Type	Method and Description
protected void	addAspect(org.apache.chemistry.opencmis.client.api.Session session, String contentNodeRef, List<CMISUtil.DocumentAspect> documentAspects) Method to add aspect
protected void	addAspect(org.apache.chemistry.opencmis.client.api.Session session, String contentNodeRef, String... aspectPropertiesName) Method to add aspect
void	addProperties(org.apache.chemistry.opencmis.client.api.Session session, String contentNodeRef, Map<String,Object> propertiesMap) Method to add properties for aspects
void	addProperties(String userName, String password, String pathToContent, Map<String,Object> properties)
void	addPropertiesByPath(org.apache.chemistry.opencmis.client.api.Session session, String pathToContent, Map<String,Object> propertiesMap) Method to add properties for aspects by path
void	attachDocuments(String userName, String password, String siteName, List<String> docsToAttach, org.apache.chemistry.opencmis.client.api.ObjectId attachToObj) Method to attach a document to an existent object
protected void	closeStreams(InputStream stream, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream) Close streams
String	getCategoryNodeRef(String userName, String password, String categoryName) Method to get the ID for a Category
org.apache.chemistry.opencmis.client.api.CmisObject	getCmisObject(org.apache.chemistry.opencmis.client.api.Session session, String pathToItem) Get cmis object by path
org.apache.chemistry.opencmis.client.api.CmisObject	getCmisObject(org.apache.chemistry.opencmis.client.api.Session session, String siteId, String contentName) Get Cmis Object for a file or folder
org.apache.chemistry.opencmis.client.api.CmisObject	getCmisObject(String userName, String password, String pathToItem) Get cmis object by path
org.apache.chemistry.opencmis.client.api.Session	getCMISSession(String userName, String password) Method to get a CMIS session.
org.apache.chemistry.opencmis.client.api.Document	getDocumentObject(org.apache.chemistry.opencmis.client.api.Session session, String pathToDocument) Get Document object for a file
org.apache.chemistry.opencmis.client.api.Document	getDocumentObject(org.apache.chemistry.opencmis.client.api.Session session, String siteId, String fileName) Get Document object for a file
org.apache.chemistry.opencmis.client.api.Document	getDocumentObject(String userName, String password, String pathToDocument) Get Document object for a file
org.apache.chemistry.opencmis.client.api.Folder	getFolderObject(org.apache.chemistry.opencmis.client.api.Session session, String pathToFolder) Get Folder cmis object
org.apache.chemistry.opencmis.client.api.Folder	getFolderObject(org.apache.chemistry.opencmis.client.api.Session session, String siteId, String folderName) Get Folder object for a folder
org.apache.chemistry.opencmis.client.api.Folder	getFolderObject(String userName, String password, String pathToFolder) Get Folder cmis object
String	getNodeRef(org.apache.chemistry.opencmis.client.api.Session session, String siteName, String contentName) Gets the object id for a document or folder.
String	getNodeRef(String userName, String password, String siteName, String contentName) Gets the object id for a document or folder.
String	getNodeRefByPath(org.apache.chemistry.opencmis.client.api.Session session, String pathToContent) Get the node ref for a item by path
String	getNodeRefByPath(String userName, String password, String pathToContent) Get the node ref for a item by path
List<org.apache.chemistry.opencmis.client.api.Property<?>>	getProperties(org.apache.chemistry.opencmis.client.api.Session session, String pathToContent) Method to get all object properties for content by path
List<org.apache.chemistry.opencmis.client.api.Property<?>>	getProperties(org.apache.chemistry.opencmis.client.api.Session session, String siteName, String contentName) Method to get all object properties for content from site
List<org.apache.chemistry.opencmis.client.api.Property<?>>	getProperties(String userName, String password, String pathToContent) Method to get all object properties for content by path
List<org.apache.chemistry.opencmis.client.api.Property<?>>	getProperties(String userName, String password, String siteName, String contentName) Method to get all object properties for content from site
String	getPropertyValue(List<org.apache.chemistry.opencmis.client.api.Property<?>> propertyList, String propertyName) Get a specific value from a property list
String	getUserNodeRef(String userManager, String password, String searchedUser)
List<?>	getValues(List<org.apache.chemistry.opencmis.client.api.Property<?>> propertyList, String propertyName) Get the list of values from a specific property list
protected void	waitInSeconds(int seconds) Method to wait for given seconds.

Methods inherited from class java.lang.Object

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

Field Detail

alfrescoHttpClientFactory

@Autowired
protected AlfrescoHttpClientFactory alfrescoHttpClientFactory

Constructor Detail

CMISUtil

public CMISUtil()

Method Detail

getCMISSession

public org.apache.chemistry.opencmis.client.api.Session getCMISSession(String userName,
                                                                       String password)

Method to get a CMIS session.

Parameters:

userName - String identifier

password - String password

Returns:

Session the session

Throws:

org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException - if invalid user and password

getNodeRef

public String getNodeRef(String userName,
                         String password,
                         String siteName,
                         String contentName)

Gets the object id for a document or folder.

Parameters:

userName - String identifier

password - String password

siteName - String site identifier

contentName - String content identifier

Returns:

String node identifier

Throws:

org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException - if site is not found

getNodeRef

public String getNodeRef(org.apache.chemistry.opencmis.client.api.Session session,
                         String siteName,
                         String contentName)

Gets the object id for a document or folder.

Parameters:

session - Session Cmis session

siteName - String site identifier

contentName - String content identifier

Returns:

String node identifier

Throws:

org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException - if site is not found

getNodeRefByPath

public String getNodeRefByPath(String userName,
                               String password,
                               String pathToContent)

Get the node ref for a item by path

Parameters:

userName - String user

password - String password

pathToContent - String path to item (e.g. /Sites/siteId/documentLibrary/doc.txt)

Returns:

String node ref of the item

getNodeRefByPath

public String getNodeRefByPath(org.apache.chemistry.opencmis.client.api.Session session,
                               String pathToContent)

Get the node ref for a item by path

Parameters:

session - the session

pathToContent - String path to item (e.g. /Sites/siteId/documentLibrary/doc.txt)

Returns:

String node ref of the item

addAspect

protected void addAspect(org.apache.chemistry.opencmis.client.api.Session session,
                         String contentNodeRef,
                         List<CMISUtil.DocumentAspect> documentAspects)

Method to add aspect

Parameters:

session - cmis session

contentNodeRef - String node identifier

documentAspects - aspect to apply on node

addAspect

protected void addAspect(org.apache.chemistry.opencmis.client.api.Session session,
                         String contentNodeRef,
                         String... aspectPropertiesName)

Method to add aspect

Parameters:

session - cmis session

contentNodeRef - String node identifier

aspectPropertyName - aspect to apply on node

addProperties

public void addProperties(org.apache.chemistry.opencmis.client.api.Session session,
                          String contentNodeRef,
                          Map<String,Object> propertiesMap)

Method to add properties for aspects

Parameters:

userName - String identifier

password - String password

contentNodeRef - String node identifier

propertiesMap - Map of properties

addPropertiesByPath

public void addPropertiesByPath(org.apache.chemistry.opencmis.client.api.Session session,
                                String pathToContent,
                                Map<String,Object> propertiesMap)

Method to add properties for aspects by path

Parameters:

session - Session

contentNodeRef - String node identifier

propertiesMap - Map of properties

addProperties

public void addProperties(String userName,
                          String password,
                          String pathToContent,
                          Map<String,Object> properties)

getProperties

public List<org.apache.chemistry.opencmis.client.api.Property<?>> getProperties(org.apache.chemistry.opencmis.client.api.Session session,
                                                                                String siteName,
                                                                                String contentName)

Method to get all object properties for content from site

Parameters:

session - Session

siteName - String site identifier

contentName - String content identifier

Returns:

Property list of content properties

getProperties

public List<org.apache.chemistry.opencmis.client.api.Property<?>> getProperties(String userName,
                                                                                String password,
                                                                                String siteName,
                                                                                String contentName)

Method to get all object properties for content from site

Parameters:

userName - String identifier

password - String password

siteName - String site identifier

contentName - String content identifier

Returns:

Property list of content properties

getProperties

public List<org.apache.chemistry.opencmis.client.api.Property<?>> getProperties(String userName,
                                                                                String password,
                                                                                String pathToContent)

Method to get all object properties for content by path

Parameters:

userName - String identifier

password - String password

pathToContent -

Returns:

Property list of content properties

getProperties

public List<org.apache.chemistry.opencmis.client.api.Property<?>> getProperties(org.apache.chemistry.opencmis.client.api.Session session,
                                                                                String pathToContent)

Method to get all object properties for content by path

Parameters:

session - Session

pathToContent -

Returns:

Property list of content properties

getPropertyValue

public String getPropertyValue(List<org.apache.chemistry.opencmis.client.api.Property<?>> propertyList,
                               String propertyName)

Get a specific value from a property list

Parameters:

propertyList - List of Property

propertyName - String name of property

Returns:

String property value

getValues

public List<?> getValues(List<org.apache.chemistry.opencmis.client.api.Property<?>> propertyList,
                         String propertyName)

Get the list of values from a specific property list

Parameters:

propertyList - List of Property

propertyName - String name of property

Returns:

List of values

getCategoryNodeRef

public String getCategoryNodeRef(String userName,
                                 String password,
                                 String categoryName)

Method to get the ID for a Category

Parameters:

userName - String identifier

password - String password

categoryName - String category name

Returns:

String node identifier

getUserNodeRef

public String getUserNodeRef(String userManager,
                             String password,
                             String searchedUser)

Parameters:

userName - String user name

password - String password

Returns:

String nodeRef of userName

attachDocuments

public void attachDocuments(String userName,
                            String password,
                            String siteName,
                            List<String> docsToAttach,
                            org.apache.chemistry.opencmis.client.api.ObjectId attachToObj)

Method to attach a document to an existent object

Parameters:

userName - String user name

password - String password

siteName - String site name

docsToAttach - String document to attach

attachToObj - ObjectId attach to object

waitInSeconds

protected void waitInSeconds(int seconds)

Method to wait for given seconds.

Parameters:

seconds - time in seconds

getCmisObject

public org.apache.chemistry.opencmis.client.api.CmisObject getCmisObject(org.apache.chemistry.opencmis.client.api.Session session,
                                                                         String siteId,
                                                                         String contentName)

Get Cmis Object for a file or folder

Parameters:

session - the session

siteId - site id

contentName - file or folder name

Returns:

CmisObject cmis object

getCmisObject

public org.apache.chemistry.opencmis.client.api.CmisObject getCmisObject(org.apache.chemistry.opencmis.client.api.Session session,
                                                                         String pathToItem)

Get cmis object by path

Parameters:

session - Session the session

pathToItem - String path to item

Returns:

CmisObject cmis object

getCmisObject

public org.apache.chemistry.opencmis.client.api.CmisObject getCmisObject(String userName,
                                                                         String password,
                                                                         String pathToItem)

Get cmis object by path

Parameters:

userName - String user name

password - String user password

pathToItem - String path to item

Returns:

CmisObject cmis object

getDocumentObject

public org.apache.chemistry.opencmis.client.api.Document getDocumentObject(org.apache.chemistry.opencmis.client.api.Session session,
                                                                           String siteId,
                                                                           String fileName)

Get Document object for a file

Parameters:

session - the session

siteId - site id

fileName - file name

Returns:

CmisObject cmis object

getDocumentObject

public org.apache.chemistry.opencmis.client.api.Document getDocumentObject(org.apache.chemistry.opencmis.client.api.Session session,
                                                                           String pathToDocument)

Get Document object for a file

Parameters:

session - Session

pathToDocument - path to document

Returns:

Document

getDocumentObject

public org.apache.chemistry.opencmis.client.api.Document getDocumentObject(String userName,
                                                                           String password,
                                                                           String pathToDocument)

Get Document object for a file

Parameters:

userName -

password -

pathToDocument - path to document

Returns:

Document

getFolderObject

public org.apache.chemistry.opencmis.client.api.Folder getFolderObject(org.apache.chemistry.opencmis.client.api.Session session,
                                                                       String siteId,
                                                                       String folderName)

Get Folder object for a folder

Parameters:

session - the session

siteId - site id

folderName - folder name

Returns:

CmisObject cmis object

getFolderObject

public org.apache.chemistry.opencmis.client.api.Folder getFolderObject(org.apache.chemistry.opencmis.client.api.Session session,
                                                                       String pathToFolder)

Get Folder cmis object

Parameters:

session - Session

pathToFolder - path to folder

Returns:

Folder

getFolderObject

public org.apache.chemistry.opencmis.client.api.Folder getFolderObject(String userName,
                                                                       String password,
                                                                       String pathToFolder)

Get Folder cmis object

Parameters:

userName -

password -

pathToFolder -

Returns:

Folder

closeStreams

protected void closeStreams(InputStream stream,
                            org.apache.chemistry.opencmis.commons.data.ContentStream contentStream)

Close streams

Parameters:

stream -

contentStream -