org.alfresco.dataprep

Class ContentService

java.lang.Object

org.alfresco.dataprep.CMISUtil

org.alfresco.dataprep.ContentService

@Service
public class ContentService
extends CMISUtil

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.dataprep.CMISUtil

CMISUtil.DocumentAspect, CMISUtil.DocumentType, CMISUtil.Priority, CMISUtil.Status

Field Summary

Fields inherited from class org.alfresco.dataprep.CMISUtil

alfrescoHttpClientFactory

Constructor Summary

Constructors

Constructor and Description
ContentService()

Method Summary

Modifier and Type	Method and Description
org.apache.chemistry.opencmis.client.api.Document	createDocument(String userName, String password, String siteName, CMISUtil.DocumentType fileType, File docName, String docContent) Create a new document in site
org.apache.chemistry.opencmis.client.api.Document	createDocument(String userName, String password, String siteName, CMISUtil.DocumentType fileType, String docName, String docContent) Create a new document in site
org.apache.chemistry.opencmis.client.api.Document	createDocumentInFolder(String userName, String password, String siteName, String folderName, CMISUtil.DocumentType fileType, String docName, String docContent) Create a new document into a folder
org.apache.chemistry.opencmis.client.api.Document	createDocumentInRepository(String userName, String password, String path, CMISUtil.DocumentType fileType, File docName, String docContent) Create a new document in repository If path is NULL, document will be created in ROOT of repository.
org.apache.chemistry.opencmis.client.api.Document	createDocumentInRepository(String userName, String password, String path, CMISUtil.DocumentType fileType, String docName, String docContent) Create a new document in repository If path is NULL, document will be created in ROOT of repository.
org.apache.chemistry.opencmis.client.api.Folder	createFolder(String userName, String password, String folderName, String siteName) Create a new folder in site
org.apache.chemistry.opencmis.client.api.Folder	createFolderInRepository(String userName, String password, String folderName, String path) Create a new folder by path in repository If path is NULL, folder will be created in ROOT of repository.
void	deleteDocument(String userName, String password, String siteName, String docName) Delete a document
void	deleteDocumentRepository(String userName, String password, String path, String docName) Delete a document created in repository.
void	deleteFiles(String userName, String password, String siteName, String... fileNames) Delete multiple files (from root or from folder) using CMIS (in root or in folder)
void	deleteFolder(String userName, String password, String siteName, String folderName) Delete a folder from site
void	deleteFolderFromRepository(String userName, String password, String folderName, String path) Delete a folder from site.
void	deleteTree(String userName, String password, String siteName, String folderName) Delete a parent folder that has children in site
void	deleteTreeRepository(String userName, String password, String path, String folderName) Delete a parent folder that has children in repository If folder is in root of repository, set PATH to NULL.
String	getDocumentContent(String userName, String password, String siteName, String docName) Get the content from a document
boolean	updateDocumentContent(String userName, String password, String siteName, CMISUtil.DocumentType docType, String docName, String newContent) Update content of a document
org.apache.chemistry.opencmis.client.api.Document	uploadFileInRepository(String userName, String password, String pathInRepo, String pathToFile) Upload a single file in repository from a location on disk.
org.apache.chemistry.opencmis.client.api.Document	uploadFileInSite(String userName, String password, String siteName, String pathToFile) Upload a single file in site from a location on disk.
List<org.apache.chemistry.opencmis.client.api.Document>	uploadFiles(String filesPath, String userName, String password, String siteName) Upload files from a physical location
List<org.apache.chemistry.opencmis.client.api.Document>	uploadFilesInFolder(String filesPath, String userName, String password, String siteName, String folderName) Upload files in a folder from a physical location

Methods inherited from class org.alfresco.dataprep.CMISUtil

addAspect, addProperties, attachDocuments, getCategoryNodeRef, getCMISSession, getNodeRef, getNodeRefFromRepo, getProperties, getPropertyValue, getUserNodeRef, getValues, waitInSeconds

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentService

public ContentService()

Method Detail

createFolder

public org.apache.chemistry.opencmis.client.api.Folder createFolder(String userName,
                                                                    String password,
                                                                    String folderName,
                                                                    String siteName)
                                                             throws Exception

Create a new folder in site

Parameters:

userName - login username

password - login password

folderName - folder name

siteName - site name

Returns:

Folder CMIS folder object

Throws:

Exception - if error

createFolderInRepository

public org.apache.chemistry.opencmis.client.api.Folder createFolderInRepository(String userName,
                                                                                String password,
                                                                                String folderName,
                                                                                String path)
                                                                         throws Exception

Create a new folder by path in repository If path is NULL, folder will be created in ROOT of repository.

Parameters:

userName - login username

password - login password

folderName - folder name

path - (e.g: 'Shared', 'Data Dictionary/Scripts)

Returns:

Folder CMIS folder object

Throws:

Exception - if error

deleteFolder

public void deleteFolder(String userName,
                         String password,
                         String siteName,
                         String folderName)
                  throws Exception

Delete a folder from site

Parameters:

userName - login username

password - login password

siteName - site name

folderName - folder name

Throws:

Exception - if error

deleteFolderFromRepository

public void deleteFolderFromRepository(String userName,
                                       String password,
                                       String folderName,
                                       String path)
                                throws Exception

Delete a folder from site. If the folder is in ROOT(Company Home) set path to NULL.

Parameters:

userName - login username

password - login password

folderName - folder name

path - String path to folder(e.g.: Shared, Guest Home)

Throws:

Exception - if error

createDocument

public org.apache.chemistry.opencmis.client.api.Document createDocument(String userName,
                                                                        String password,
                                                                        String siteName,
                                                                        CMISUtil.DocumentType fileType,
                                                                        File docName,
                                                                        String docContent)
                                                                 throws Exception

Create a new document in site

Parameters:

userName - login username

password - login password

siteName - site name

fileType - DocumentType file type

docName - String file name

docContent - file content

Returns:

Document CMIS document object

Throws:

Exception - if error

createDocument

public org.apache.chemistry.opencmis.client.api.Document createDocument(String userName,
                                                                        String password,
                                                                        String siteName,
                                                                        CMISUtil.DocumentType fileType,
                                                                        String docName,
                                                                        String docContent)
                                                                 throws Exception

Create a new document in site

Parameters:

userName - login username

password - login password

siteName - site name

fileType - DocumentType file type

docName - file name

docContent - file content

Returns:

Document CMIS document object

Throws:

Exception - if error

createDocumentInRepository

public org.apache.chemistry.opencmis.client.api.Document createDocumentInRepository(String userName,
                                                                                    String password,
                                                                                    String path,
                                                                                    CMISUtil.DocumentType fileType,
                                                                                    String docName,
                                                                                    String docContent)
                                                                             throws Exception

Create a new document in repository If path is NULL, document will be created in ROOT of repository.

Parameters:

userName - login username

password - login password

path - where to create the document(e.g.: Shared, Data Dictionary/Messages)

fileType - DocumentType file type

docName - file name

docContent - file content

Returns:

Document CMIS document object

Throws:

Exception - if error

createDocumentInRepository

public org.apache.chemistry.opencmis.client.api.Document createDocumentInRepository(String userName,
                                                                                    String password,
                                                                                    String path,
                                                                                    CMISUtil.DocumentType fileType,
                                                                                    File docName,
                                                                                    String docContent)
                                                                             throws Exception

Create a new document in repository If path is NULL, document will be created in ROOT of repository.

Parameters:

userName - login username

password - login password

path - where to create the document(e.g.: Shared, Data Dictionary/Messages)

fileType - DocumentType file type

docName - File file name

docContent - file content

Returns:

Document CMIS document object

Throws:

Exception - if error

createDocumentInFolder

public org.apache.chemistry.opencmis.client.api.Document createDocumentInFolder(String userName,
                                                                                String password,
                                                                                String siteName,
                                                                                String folderName,
                                                                                CMISUtil.DocumentType fileType,
                                                                                String docName,
                                                                                String docContent)
                                                                         throws Exception

Create a new document into a folder

Parameters:

userName - login username

password - login password

siteName - site name

folderName - folder name

fileType - DocumentType file type

docName - file name

docContent - file content

Returns:

Document CMIS document object

Throws:

Exception - if error

deleteDocument

public void deleteDocument(String userName,
                           String password,
                           String siteName,
                           String docName)
                    throws Exception

Delete a document

Parameters:

userName - login username

password - login password

siteName - site name

docName - file name

Throws:

Exception - if error

deleteDocumentRepository

public void deleteDocumentRepository(String userName,
                                     String password,
                                     String path,
                                     String docName)
                              throws Exception

Delete a document created in repository. If the document is in ROOT (Company Home) set path to NULL.

Parameters:

userName - username

password - password

path - path in repository

docName - file name

Throws:

Exception - if error

deleteTree

public void deleteTree(String userName,
                       String password,
                       String siteName,
                       String folderName)
                throws Exception

Delete a parent folder that has children in site

Parameters:

userName - login username

password - login password

siteName - site name

folderName - folder name

Throws:

Exception - if error

deleteTreeRepository

public void deleteTreeRepository(String userName,
                                 String password,
                                 String path,
                                 String folderName)
                          throws Exception

Delete a parent folder that has children in repository If folder is in root of repository, set PATH to NULL.

Parameters:

userName - login username

password - login password

path - path to folder (e.g. 'Shared')

folderName - folder name

Throws:

Exception - if error

uploadFileInSite

public org.apache.chemistry.opencmis.client.api.Document uploadFileInSite(String userName,
                                                                          String password,
                                                                          String siteName,
                                                                          String pathToFile)
                                                                   throws Exception

Upload a single file in site from a location on disk.

Parameters:

userName - login username

password - user password

siteName - site name

pathToFile - path to file

Returns:

Document uploaded file

Throws:

Exception - if error

uploadFileInRepository

public org.apache.chemistry.opencmis.client.api.Document uploadFileInRepository(String userName,
                                                                                String password,
                                                                                String pathInRepo,
                                                                                String pathToFile)
                                                                         throws Exception

Upload a single file in repository from a location on disk. If pathInRepo is NULL, document will be uploaded in ROOT of repository.

Parameters:

userName - login username

password - user password

pathInRepo - path in repository. If NULL, ROOT is set!

pathToFile - path to file

Returns:

Document uploaded file

Throws:

Exception - if error

uploadFiles

public List<org.apache.chemistry.opencmis.client.api.Document> uploadFiles(String filesPath,
                                                                           String userName,
                                                                           String password,
                                                                           String siteName)
                                                                    throws Exception

Upload files from a physical location

Parameters:

filesPath - physical path where the files are stored

userName - login username

password - user password

siteName - site name

Returns:

list of uploaded documents

Throws:

Exception - if error

uploadFilesInFolder

public List<org.apache.chemistry.opencmis.client.api.Document> uploadFilesInFolder(String filesPath,
                                                                                   String userName,
                                                                                   String password,
                                                                                   String siteName,
                                                                                   String folderName)
                                                                            throws Exception

Upload files in a folder from a physical location

Parameters:

filesPath - physical path where the files are stored

userName - login username

password - user password

siteName - site name

folderName - folder name where files are uploaded

Returns:

list of uploaded documents

Throws:

Exception - if error

deleteFiles

public void deleteFiles(String userName,
                        String password,
                        String siteName,
                        String... fileNames)
                 throws Exception

Delete multiple files (from root or from folder) using CMIS (in root or in folder)

Parameters:

userName - login username

password - user password

siteName - site name

fileNames - names of files to be deleted

Throws:

Exception - if error

getDocumentContent

public String getDocumentContent(String userName,
                                 String password,
                                 String siteName,
                                 String docName)
                          throws Exception

Get the content from a document

Parameters:

userName - login username

password - login password

siteName - site name

docName - file name

Returns:

String content of document

Throws:

Exception - if error

updateDocumentContent

public boolean updateDocumentContent(String userName,
                                     String password,
                                     String siteName,
                                     CMISUtil.DocumentType docType,
                                     String docName,
                                     String newContent)
                              throws Exception

Update content of a document

Parameters:

userName - login username

password - login password

siteName - site name

docType - file type

docName - file name

newContent - new content of the file

Returns:

if updated

Throws:

Exception - if error