org.alfresco.test.utils.api

Class CmisApiUtils

java.lang.Object

org.alfresco.test.utils.api.CmisApiUtils

public class CmisApiUtils
extends Object

Class to contain Cmis api Utils

Since:

1.0

Author:

Meenal Bhave

Constructor Summary

Constructors

Constructor and Description
CmisApiUtils(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	addAspect(CMISBinding cmisBinding, String[] authDetails, String domain, String nodeRef, String aspectName, Map<String,Object> propertiesMap) Method to add aspect to a Document or Folder Node
org.apache.chemistry.opencmis.client.api.Document	appendContent(CMISBinding cmisBinding, String[] authDetails, String domain, String fileNodeRef, String content, boolean isLastChunk)
org.apache.chemistry.opencmis.client.api.Document	appendContentFromFile(CMISBinding cmisBinding, String[] authDetails, String domain, String fileNodeRef, String fileName, boolean isLastChunk)
org.apache.chemistry.opencmis.client.api.Document	checkInDocument(CMISBinding cmisBinding, String[] authDetails, String forUser, String domain, org.apache.chemistry.opencmis.client.api.Document docToCheckIn, String docContent, Map<String,String> properties, Boolean majorVersion, String checkInComment) Checks in a Document with the specified versioning state (major / minor) using CMIS
org.apache.chemistry.opencmis.client.api.Document	createDocument(CMISBinding cmisBinding, String[] authDetails, String forUser, String domain, String siteName, String docContent, Map<String,Object> properties) Creates a Document in the Site's DocumentLibrary using CMIS
org.apache.chemistry.opencmis.client.api.Document	createDocumentFromSource(CMISBinding cmisBinding, String[] authDetails, String fileName, String domain, String folderNodeRef, Map<String,Serializable> properties, org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState, String sourceNodeRef) Creates a Document using CMIS from source.
org.apache.chemistry.opencmis.client.api.Document	createDocumentInFolder(CMISBinding cmisBinding, String[] authDetails, String fileName, String domain, String folderNodeRef, Map<String,Serializable> properties, org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream) Creates a Document under the Specified folder node ref using CMIS
org.apache.chemistry.opencmis.client.api.Folder	createFolder(CMISBinding cmisBinding, String[] authDetails, String forUser, String domain, String siteName, Map<String,Object> properties) Creates a folder in Site's DocumentLibrary using CMIS
org.apache.chemistry.opencmis.client.api.ObjectId	createRelationship(CMISBinding cmisBinding, String[] authDetails, String domain, String sourceObjectId, String targetObjectId, String objectTypeValue)
org.apache.chemistry.opencmis.client.api.Folder	createSubFolder(CMISBinding cmisBinding, String[] authDetails, String forUser, String domain, String siteName, String parentFolderPath, Map<String,Object> properties) Creates a sub-folder in the parentFolderPath under the Site's DocumentLibrary using CMIS
void	delete(CMISBinding cmisBinding, String[] authDetails, String domain, String nodeRef)
void	deleteContent(CMISBinding cmisBinding, String[] authDetails, String domain, String nodeRef)
boolean	deleteTree(CMISBinding cmisBinding, String[] authDetails, String domain, String folderRef, boolean allVersions, org.apache.chemistry.opencmis.commons.enums.UnfileObject unfile, boolean continueOnFailure)
List<org.apache.chemistry.opencmis.client.api.Repository>	getCMISRepositories(CMISBinding cmisBinding, String[] authDetails)
List<org.apache.chemistry.opencmis.client.api.Repository>	getCMISRepositories(String[] authDetails, String domain)
org.alfresco.rest.api.tests.client.PublicApiClient.CmisSession	getCmisSession(CMISBinding cmisBinding, String[] authDetails, String domain) Creates a CMIS session using the publicApiClient
org.alfresco.rest.api.tests.client.PublicApiClient.CmisSession	getCmisSession(CMISBinding cmisBinding, String authDetails, String domain)
String	getContentNodeRef(CMISBinding cmisBinding, String[] authDetails, String domain, String siteName, String parentForlderPath, String ContentName) Method to get Content Node ref.
String	getDoclibNodeRef(CMISBinding cmisBinding, String[] authDetails, String domain, String siteName) Method to get Content Node ref.
protected org.apache.chemistry.opencmis.client.api.CmisObject	getObject(CMISBinding cmisBinding, String[] authDetails, String domain, String nodeRef)
String	getObjectBaseType(org.apache.chemistry.opencmis.client.api.CmisObject object)
String	getObjectID(CMISBinding cmisBinding, String[] authDetails, String domain, String siteName, String parentForlderPath, String ContentName) Method to get Object ID of a content item.
List<org.apache.chemistry.opencmis.client.api.Property<?>>	getProperties(CMISBinding cmisBinding, String[] authDetails, String domain, String nodeRef) Method to get Cmis object Properties
Object	getPropertyValue(List<org.apache.chemistry.opencmis.client.api.Property<?>> propertyList, String propertyName)
String	getTagNodeRef(CMISBinding cmisBinding, String[] authDetails, String domain, String nodeRef) Method to get Tag Node ref.
boolean	isDocument(org.apache.chemistry.opencmis.client.api.CmisObject object)
boolean	isFolder(org.apache.chemistry.opencmis.client.api.CmisObject object)
void	removeAspect(CMISBinding cmisBinding, String[] authDetails, String domain, String nodeRef, String aspectName) Method to remove an aspect from a Document or Folder Node
org.apache.chemistry.opencmis.client.api.Document	setContent(CMISBinding cmisBinding, String[] authdetails, String domain, String fileNodeRef, String content)
protected org.apache.chemistry.opencmis.commons.data.ContentStream	streamContent(String docContent, String mimeType)
void	updateProperties(CMISBinding cmisBinding, String[] authDetails, String domain, String documentNodeRef, Map<String,Object> propertiesMap) Method to add, update or remove node properties

Methods inherited from class java.lang.Object

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

Constructor Detail

CmisApiUtils

public CmisApiUtils(ApiClient apiClient)

Method Detail

getCMISRepositories

public List<org.apache.chemistry.opencmis.client.api.Repository> getCMISRepositories(String[] authDetails,
                                                                                     String domain)

getCmisSession

public org.alfresco.rest.api.tests.client.PublicApiClient.CmisSession getCmisSession(CMISBinding cmisBinding,
                                                                                     String[] authDetails,
                                                                                     String domain)

Creates a CMIS session using the publicApiClient

Parameters:

{@link - CMISBindin} CMIS binding and Version

authDetails -

domain -

getCmisSession

public org.alfresco.rest.api.tests.client.PublicApiClient.CmisSession getCmisSession(CMISBinding cmisBinding,
                                                                                     String authDetails,
                                                                                     String domain)

createFolder

public org.apache.chemistry.opencmis.client.api.Folder createFolder(CMISBinding cmisBinding,
                                                                    String[] authDetails,
                                                                    String forUser,
                                                                    String domain,
                                                                    String siteName,
                                                                    Map<String,Object> properties)

Creates a folder in Site's DocumentLibrary using CMIS

Parameters:

cmisBinding - CMISBinding CMIS binding and Version

authDetails -

forUser -

domain -

siteName -

properties -

createSubFolder

public org.apache.chemistry.opencmis.client.api.Folder createSubFolder(CMISBinding cmisBinding,
                                                                       String[] authDetails,
                                                                       String forUser,
                                                                       String domain,
                                                                       String siteName,
                                                                       String parentFolderPath,
                                                                       Map<String,Object> properties)

Creates a sub-folder in the parentFolderPath under the Site's DocumentLibrary using CMIS

Parameters:

cmisBinding - CMISBinding CMIS binding and Version

authDetails -

forUser -

domain -

siteName -

parentFolderPath -

properties -

createDocument

public org.apache.chemistry.opencmis.client.api.Document createDocument(CMISBinding cmisBinding,
                                                                        String[] authDetails,
                                                                        String forUser,
                                                                        String domain,
                                                                        String siteName,
                                                                        String docContent,
                                                                        Map<String,Object> properties)

Creates a Document in the Site's DocumentLibrary using CMIS

Parameters:

cmisBinding - CMISBinding CMIS binding and Version

authDetails -

forUser -

domain -

siteName -

docContent -

properties -

createDocumentInFolder

public org.apache.chemistry.opencmis.client.api.Document createDocumentInFolder(CMISBinding cmisBinding,
                                                                                String[] authDetails,
                                                                                String fileName,
                                                                                String domain,
                                                                                String folderNodeRef,
                                                                                Map<String,Serializable> properties,
                                                                                org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState,
                                                                                org.apache.chemistry.opencmis.commons.data.ContentStream contentStream)

Creates a Document under the Specified folder node ref using CMIS

Parameters:

cmisBinding - CMISBinding CMIS binding and Version

authDetails -

fileName -

domain -

folderNodeRef -

properties -

versioningState -

contentStream -

Returns:

Document

createDocumentFromSource

public org.apache.chemistry.opencmis.client.api.Document createDocumentFromSource(CMISBinding cmisBinding,
                                                                                  String[] authDetails,
                                                                                  String fileName,
                                                                                  String domain,
                                                                                  String folderNodeRef,
                                                                                  Map<String,Serializable> properties,
                                                                                  org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState,
                                                                                  String sourceNodeRef)

Creates a Document using CMIS from source.

Parameters:

cmisBinding - CMISBinding CMIS binding and Version

authDetails -

fileName -

domain -

folderNodeRef -

properties -

versioningState -

sourceNodeRef -

Returns:

Document

checkInDocument

public org.apache.chemistry.opencmis.client.api.Document checkInDocument(CMISBinding cmisBinding,
                                                                         String[] authDetails,
                                                                         String forUser,
                                                                         String domain,
                                                                         org.apache.chemistry.opencmis.client.api.Document docToCheckIn,
                                                                         String docContent,
                                                                         Map<String,String> properties,
                                                                         Boolean majorVersion,
                                                                         String checkInComment)

Checks in a Document with the specified versioning state (major / minor) using CMIS

Parameters:

cmisBinding - CMISBinding CMIS binding and Version

authDetails -

forUser -

domain -

docToCheckIn -

docContent -

properties -

majorVersion -

checkInComment -

Returns:

Document

deleteTree

public boolean deleteTree(CMISBinding cmisBinding,
                          String[] authDetails,
                          String domain,
                          String folderRef,
                          boolean allVersions,
                          org.apache.chemistry.opencmis.commons.enums.UnfileObject unfile,
                          boolean continueOnFailure)

Parameters:

cmisBinding -

authDetails -

domain -

folderRef -

allVersions -

unfile -

continueOnFailure -

Returns:

true if delete successful

delete

public void delete(CMISBinding cmisBinding,
                   String[] authDetails,
                   String domain,
                   String nodeRef)

Parameters:

cmisBinding -

authDetails -

domain -

nodeRef -

createRelationship

public org.apache.chemistry.opencmis.client.api.ObjectId createRelationship(CMISBinding cmisBinding,
                                                                            String[] authDetails,
                                                                            String domain,
                                                                            String sourceObjectId,
                                                                            String targetObjectId,
                                                                            String objectTypeValue)

Parameters:

cmisBinding -

authDetails -

domain -

sourceObjectId -

targetObjectId -

objectTypeValue -

Returns:

ObjectId NodeRef

setContent

public org.apache.chemistry.opencmis.client.api.Document setContent(CMISBinding cmisBinding,
                                                                    String[] authdetails,
                                                                    String domain,
                                                                    String fileNodeRef,
                                                                    String content)

Parameters:

cmisBinding -

authdetails -

domain -

fileNodeRef -

content -

Returns:

Document

appendContent

public org.apache.chemistry.opencmis.client.api.Document appendContent(CMISBinding cmisBinding,
                                                                       String[] authDetails,
                                                                       String domain,
                                                                       String fileNodeRef,
                                                                       String content,
                                                                       boolean isLastChunk)

Parameters:

cmisBinding -

authDetails -

domain -

fileNodeRef -

content -

isLastChunk -

Returns:

Document

appendContentFromFile

public org.apache.chemistry.opencmis.client.api.Document appendContentFromFile(CMISBinding cmisBinding,
                                                                               String[] authDetails,
                                                                               String domain,
                                                                               String fileNodeRef,
                                                                               String fileName,
                                                                               boolean isLastChunk)

streamContent

protected org.apache.chemistry.opencmis.commons.data.ContentStream streamContent(String docContent,
                                                                                 String mimeType)

Parameters:

docContent -

mimeType -

Returns:

addAspect

public void addAspect(CMISBinding cmisBinding,
                      String[] authDetails,
                      String domain,
                      String nodeRef,
                      String aspectName,
                      Map<String,Object> propertiesMap)

Method to add aspect to a Document or Folder Node

Parameters:

cmisBinding - CMISBinding

authDetails -

domain -

nodeRef -

DocumentAspect - DocumentAspect

propertiesMap -

removeAspect

public void removeAspect(CMISBinding cmisBinding,
                         String[] authDetails,
                         String domain,
                         String nodeRef,
                         String aspectName)

Method to remove an aspect from a Document or Folder Node

Parameters:

cmisBinding - CMISBinding

authDetails -

domain -

nodeRef -

DocumentAspect - DocumentAspect

updateProperties

public void updateProperties(CMISBinding cmisBinding,
                             String[] authDetails,
                             String domain,
                             String documentNodeRef,
                             Map<String,Object> propertiesMap)

Method to add, update or remove node properties

Parameters:

cmisBinding -

authDetails -

domain -

documentNodeRef -

propertiesMap -

getProperties

public List<org.apache.chemistry.opencmis.client.api.Property<?>> getProperties(CMISBinding cmisBinding,
                                                                                String[] authDetails,
                                                                                String domain,
                                                                                String nodeRef)

Method to get Cmis object Properties

Parameters:

cmisBinding -

authDetails -

domain -

nodeRef -

getObject

protected org.apache.chemistry.opencmis.client.api.CmisObject getObject(CMISBinding cmisBinding,
                                                                        String[] authDetails,
                                                                        String domain,
                                                                        String nodeRef)

Parameters:

cmisBinding -

authDetails -

domain -

nodeRef -

Returns:

getContentNodeRef

public String getContentNodeRef(CMISBinding cmisBinding,
                                String[] authDetails,
                                String domain,
                                String siteName,
                                String parentForlderPath,
                                String ContentName)

Method to get Content Node ref.

Parameters:

cmisBinding -

authDetails -

domain -

siteName -

parentForlderPath -

ContentName -

Returns:

getDoclibNodeRef

public String getDoclibNodeRef(CMISBinding cmisBinding,
                               String[] authDetails,
                               String domain,
                               String siteName)

Method to get Content Node ref.

Parameters:

cmisBinding -

authDetails -

domain -

siteName -

Returns:

getObjectID

public String getObjectID(CMISBinding cmisBinding,
                          String[] authDetails,
                          String domain,
                          String siteName,
                          String parentForlderPath,
                          String ContentName)

Method to get Object ID of a content item.

Parameters:

cmisBinding -

authDetails -

domain -

siteName -

parentForlderPath -

ContentName -

Returns:

getTagNodeRef

public String getTagNodeRef(CMISBinding cmisBinding,
                            String[] authDetails,
                            String domain,
                            String nodeRef)

Method to get Tag Node ref.

Parameters:

cmisBinding -

authDetails -

domain -

nodeRef -

Returns:

getPropertyValue

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

Parameters:

propertyList -

propertyName -

Returns:

deleteContent

public void deleteContent(CMISBinding cmisBinding,
                          String[] authDetails,
                          String domain,
                          String nodeRef)

Parameters:

cmisBinding -

authDetails -

domain -

nodeRef -

getCMISRepositories

public List<org.apache.chemistry.opencmis.client.api.Repository> getCMISRepositories(CMISBinding cmisBinding,
                                                                                     String[] authDetails)

isDocument

public boolean isDocument(org.apache.chemistry.opencmis.client.api.CmisObject object)

isFolder

public boolean isFolder(org.apache.chemistry.opencmis.client.api.CmisObject object)

getObjectBaseType

public String getObjectBaseType(org.apache.chemistry.opencmis.client.api.CmisObject object)