ContentActions (Alfresco Dataprep 1.9 API)

java.lang.Object
- org.alfresco.dataprep.CMISUtil
- - org.alfresco.dataprep.ContentActions

@Service
public class ContentActions
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

ContentActions()

Constructors
Constructor and Description
`ContentActions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addComment(String userName, String password, String pathToItem, String comment)` Create a comment for a document or folder from repository
`boolean`	`addComment(String userName, String password, String siteName, String contentName, String comment)` Create a comment for a document or folder
`boolean`	`addMultipleComments(String userName, String password, String pathToItem, List<String> comments)` Create multiple comments for a document or folder in repository
`boolean`	`addMultipleComments(String userName, String password, String siteName, String contentName, List<String> comments)` Create multiple comments for a document or folder
`boolean`	`addMultipleTags(String userName, String password, String pathToItem, List<String> tags)` Create multiple tags for document or folder
`boolean`	`addMultipleTags(String userName, String password, String siteName, String contentName, List<String> tags)` Create multiple tags for document or folder
`boolean`	`addSingleTag(String userName, String password, String pathToItem, String tag)` Create tag for a document or folder from repository
`boolean`	`addSingleTag(String userName, String password, String siteName, String contentName, String tag)` Create tag for a document or folder
`void`	`cancelCheckOut(String userName, String password, String siteId, String fileName)` If this is a PWC (private working copy) the check out will be reversed.
`org.apache.chemistry.opencmis.client.api.ObjectId`	`checkIn(String userName, String password, String siteId, String docName, CMISUtil.DocumentType fileType, String newContent, boolean majorVersion, String checkinComment)` Check in document.
`org.apache.chemistry.opencmis.client.api.ObjectId`	`checkOut(String userName, String password, String siteId, String fileName)` Checks out the document and returns the object id of the PWC (private working copy).
`org.apache.chemistry.opencmis.client.api.CmisObject`	`copyTo(String userName, String password, String pathFrom, String pathTo)` Copy item by path
`org.apache.chemistry.opencmis.client.api.CmisObject`	`copyTo(String userName, String password, String sourceSite, String contentName, String targetSite, String targetFolder)` Copy file or folder
`int`	`countLikes(String userName, String password, String pathToItem)` Get the number of likes for a document or folder from repository
`int`	`countLikes(String userName, String password, String siteName, String contentName)` Get the number of likes for a document or folder
`String`	`getCommentNodeRef(String userName, String password, String pathToItem, String comment)` Get the node ref for comment from repository
`String`	`getCommentNodeRef(String userName, String password, String siteName, String contentName, String comment)` Get the node ref for comment
`List<String>`	`getComments(String userName, String password, String pathToItem)` Get list of comments that are set for a document or folder in repository
`List<String>`	`getComments(String userName, String password, String siteName, String contentName)` Get list of comments that are set for a document or folder
`List<String>`	`getTagNamesFromContent(String userName, String password, String pathToItem)` Get list of tag names that are set for a document or folder in repository
`List<String>`	`getTagNamesFromContent(String userName, String password, String siteName, String contentName)` Get list of tag names that are set for a document or folder
`String`	`getTagNodeRef(String userName, String password, String pathToItem, String tagName)` Get the node ref from a tag in repository
`String`	`getTagNodeRef(String userName, String password, String siteName, String contentName, String tagName)` Get the node ref from a tag
`String`	`getVersion(String userName, String password, String siteId, String fileName)` Get the version of a file
`boolean`	`isFavorite(String userName, String password, String siteName, String contentName)` Verify if a document or folder is marked as favorite
`boolean`	`likeContent(String userName, String password, String pathToItem)` Like a document or folder from repository
`boolean`	`likeContent(String userName, String password, String siteName, String contentName)` Like a document or folder
`org.apache.chemistry.opencmis.client.api.CmisObject`	`moveTo(String userName, String password, String pathFrom, String pathTo)` Move file or folder by path
`org.apache.chemistry.opencmis.client.api.CmisObject`	`moveTo(String userName, String password, String sourceSite, String contentName, String targetSite, String targetFolder)` Move file or folder in site
`boolean`	`removeComment(String userName, String password, String pathToItem, String comment)` Remove comment from content in repository
`boolean`	`removeComment(String userName, String password, String siteName, String contentName, String comment)` Remove comment from content
`boolean`	`removeFavorite(String userName, String password, String siteName, String contentName)` Remove favorite from document or folder
`boolean`	`removeLike(String userName, String password, String pathToItem)` Remove like from content in repository
`boolean`	`removeLike(String userName, String password, String siteName, String contentName)` Remove like from content
`boolean`	`removePermissionForGroup(String userName, String password, String siteName, String contentName, String groupToRemove, String role, boolean isInherited)` Remove permission from a group
`boolean`	`removePermissionForUser(String userName, String password, String siteName, String contentName, String userToRemove, String role, boolean isInherited)` Remove permission from a user
`boolean`	`removeTag(String userName, String password, String pathToItem, String tagName)` Remove tag from content from repository
`boolean`	`removeTag(String userName, String password, String siteName, String contentName, String tagName)` Remove tag from content
`boolean`	`setFileAsFavorite(String userName, String password, String siteName, String fileName)` Set a document as favorite
`boolean`	`setFolderAsFavorite(String userName, String password, String siteName, String folderName)` Set a folder as favorite
`boolean`	`setPermissionForGroup(String userName, String password, String siteName, String contentName, String groupName, String role, boolean isInherited)` Set permission for a group
`boolean`	`setPermissionForUser(String userName, String password, String siteName, String contentName, String userToAdd, String role, boolean isInherited)` Set permission for a user

Methods inherited from class org.alfresco.dataprep.CMISUtil
addAspect, addProperties, attachDocuments, closeStreams, getCategoryNodeRef, getCmisObject, getCmisObject, getCMISSession, getDocumentObject, getFolderObject, getNodeRef, getNodeRef, getNodeRefByPath, getNodeRefByPath, 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
- ContentActions
```
public ContentActions()
```

Method Detail

addSingleTag

public boolean addSingleTag(String userName,
                            String password,
                            String siteName,
                            String contentName,
                            String tag)

Create tag for a document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; tag - tag for file or folder
Returns:: true if request is successful

addSingleTag

public boolean addSingleTag(String userName,
                            String password,
                            String pathToItem,
                            String tag)

Create tag for a document or folder from repository

Parameters:: userName - login username; password - login password; pathToItem - path to document or folder; tag - tag for file or folder
Returns:: true if request is successful

addMultipleTags

public boolean addMultipleTags(String userName,
                               String password,
                               String siteName,
                               String contentName,
                               List<String> tags)

Create multiple tags for document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; tags - list of tags for a file or folder
Returns:: true if request is successful

addMultipleTags

public boolean addMultipleTags(String userName,
                               String password,
                               String pathToItem,
                               List<String> tags)

Create multiple tags for document or folder

Parameters:: userName - login username; password - login password; pathToItem - path to document or folder; tags - list of tags for a file or folder
Returns:: true if request is successful

getTagNamesFromContent

public List<String> getTagNamesFromContent(String userName,
                                           String password,
                                           String siteName,
                                           String contentName)

Get list of tag names that are set for a document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: List list of tags for a file or folder

getTagNamesFromContent

public List<String> getTagNamesFromContent(String userName,
                                           String password,
                                           String pathToItem)

Get list of tag names that are set for a document or folder in repository

Parameters:: userName - login username; password - login password; pathToItem - path to item in repository
Returns:: List list of tags for a file or folder

getTagNodeRef

public String getTagNodeRef(String userName,
                            String password,
                            String siteName,
                            String contentName,
                            String tagName)

Get the node ref from a tag

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; tagName - tag of a file of folder
Returns:: String nodeRef

getTagNodeRef

public String getTagNodeRef(String userName,
                            String password,
                            String pathToItem,
                            String tagName)

Get the node ref from a tag in repository

Parameters:: userName - login username; password - login password; pathToItem - path to document or folder in repository; tagName - tag of a file of folder
Returns:: String nodeRef

removeTag

public boolean removeTag(String userName,
                         String password,
                         String siteName,
                         String contentName,
                         String tagName)

Remove tag from content

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; tagName - tag of a file or folder
Returns:: true if deleted

removeTag

public boolean removeTag(String userName,
                         String password,
                         String pathToItem,
                         String tagName)

Remove tag from content from repository

Parameters:: userName - login username; password - login password; pathToItem - path to item in repository; tagName - tag of a file or folder
Returns:: true if deleted

addComment

public boolean addComment(String userName,
                          String password,
                          String siteName,
                          String contentName,
                          String comment)

Create a comment for a document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; comment - comment for a file or folder
Returns:: true if request is successful

addComment

public boolean addComment(String userName,
                          String password,
                          String pathToItem,
                          String comment)

Create a comment for a document or folder from repository

Parameters:: userName - login username; password - login password; pathToItem - path to item in repository; comment - comment for a file or folder
Returns:: true if request is successful

addMultipleComments

public boolean addMultipleComments(String userName,
                                   String password,
                                   String siteName,
                                   String contentName,
                                   List<String> comments)

Create multiple comments for a document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; comments - list of comments
Returns:: true if request is successful

addMultipleComments

public boolean addMultipleComments(String userName,
                                   String password,
                                   String pathToItem,
                                   List<String> comments)

Create multiple comments for a document or folder in repository

Parameters:: userName - login username; password - login password; pathToItem - path to item in repository; comments - list of comments
Returns:: true if request is successful

getComments

public List<String> getComments(String userName,
                                String password,
                                String siteName,
                                String contentName)

Get list of comments that are set for a document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: List list of comments

getComments

public List<String> getComments(String userName,
                                String password,
                                String pathToItem)

Get list of comments that are set for a document or folder in repository

Parameters:: userName - login username; password - login password; pathToItem - path to item in repository
Returns:: List list of comments

getCommentNodeRef

public String getCommentNodeRef(String userName,
                                String password,
                                String siteName,
                                String contentName,
                                String comment)

Get the node ref for comment

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; comment - comment of a file or folder
Returns:: String nodeRef

getCommentNodeRef

public String getCommentNodeRef(String userName,
                                String password,
                                String pathToItem,
                                String comment)

Get the node ref for comment from repository

Parameters:: userName - login username; password - login password; pathToItem - path to item in repository; comment - comment of a file or folder
Returns:: String nodeRef

removeComment

public boolean removeComment(String userName,
                             String password,
                             String siteName,
                             String contentName,
                             String comment)

Remove comment from content

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name; comment - comment of a file or folder
Returns:: true if deleted

removeComment

public boolean removeComment(String userName,
                             String password,
                             String pathToItem,
                             String comment)

Remove comment from content in repository

Parameters:: userName - login username; password - login password; pathToItem - path to item in repository; comment - comment of a file or folder
Returns:: true if deleted

likeContent

public boolean likeContent(String userName,
                           String password,
                           String siteName,
                           String contentName)

Like a document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: true if request is successful

likeContent

public boolean likeContent(String userName,
                           String password,
                           String pathToItem)

Like a document or folder from repository

Parameters:: userName - login username; password - login password; pathToItem - path to document or folder
Returns:: true if request is successful

countLikes

public int countLikes(String userName,
                      String password,
                      String siteName,
                      String contentName)

Get the number of likes for a document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: int likes

countLikes
```
public int countLikes(String userName,
                      String password,
                      String pathToItem)
```
Get the number of likes for a document or folder from repository

Parameters:

userName - login username

password - login password

pathToItem - path to document or folder

Returns:

int likes

removeLike

public boolean removeLike(String userName,
                          String password,
                          String siteName,
                          String contentName)

Remove like from content

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: true if removed

removeLike

public boolean removeLike(String userName,
                          String password,
                          String pathToItem)

Remove like from content in repository

Parameters:: userName - login username; password - login password; pathToItem - path to document or folder
Returns:: true if removed

setFileAsFavorite

public boolean setFileAsFavorite(String userName,
                                 String password,
                                 String siteName,
                                 String fileName)

Set a document as favorite

Parameters:: userName - login username; password - login password; siteName - site name; fileName - file name
Returns:: true if marked as favorite

setFolderAsFavorite

public boolean setFolderAsFavorite(String userName,
                                   String password,
                                   String siteName,
                                   String folderName)

Set a folder as favorite

Parameters:: userName - login username; password - login password; siteName - site name; folderName - folder name
Returns:: true if marked as favorite

removeFavorite

public boolean removeFavorite(String userName,
                              String password,
                              String siteName,
                              String contentName)

Remove favorite from document or folder

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: true if favorite is removed

isFavorite

public boolean isFavorite(String userName,
                          String password,
                          String siteName,
                          String contentName)

Verify if a document or folder is marked as favorite

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: true if marked as favorite

checkOut

public org.apache.chemistry.opencmis.client.api.ObjectId checkOut(String userName,
                                                                  String password,
                                                                  String siteId,
                                                                  String fileName)

Checks out the document and returns the object id of the PWC (private working copy).

Parameters:: userName - login username; password - login password; siteId - site name; fileName - file
Returns:: ObjectId object id of PWC

cancelCheckOut

public void cancelCheckOut(String userName,
                           String password,
                           String siteId,
                           String fileName)

If this is a PWC (private working copy) the check out will be reversed. If this is not a PWC it an exception will be thrown.

Parameters:: userName - login username; password - login password; siteId - site name; fileName - file

checkIn

public org.apache.chemistry.opencmis.client.api.ObjectId checkIn(String userName,
                                                                 String password,
                                                                 String siteId,
                                                                 String docName,
                                                                 CMISUtil.DocumentType fileType,
                                                                 String newContent,
                                                                 boolean majorVersion,
                                                                 String checkinComment)

Check in document. If this is not a PWC(private working copy) check out for the file will be made.

Parameters:: userName - login username; password - login password; siteId - site name; docName - document name; fileType - DocumentType type of document; newContent - String new content to be set; majorVersion - boolean true to set major version; checkinComment - String check in comment
Returns:: ObjectId object id of PWC

getVersion

public String getVersion(String userName,
                         String password,
                         String siteId,
                         String fileName)

Get the version of a file

Parameters:: userName - login username; password - login password; siteId - site name; fileName - file
Returns:: String file version

copyTo

public org.apache.chemistry.opencmis.client.api.CmisObject copyTo(String userName,
                                                                  String password,
                                                                  String sourceSite,
                                                                  String contentName,
                                                                  String targetSite,
                                                                  String targetFolder)

Copy file or folder

Parameters:: userName - user name; password - password; siteName - source site; contentName - content to be copied; targetSite - tartget site; targetFolder - target folder. If null document library is set
Returns:: CmisObject of new created object

copyTo

public org.apache.chemistry.opencmis.client.api.CmisObject copyTo(String userName,
                                                                  String password,
                                                                  String pathFrom,
                                                                  String pathTo)

Copy item by path

Parameters:: userName - String user name; password - String password; pathFrom - String path from; pathTo - String path to
Returns:

moveTo

public org.apache.chemistry.opencmis.client.api.CmisObject moveTo(String userName,
                                                                  String password,
                                                                  String sourceSite,
                                                                  String contentName,
                                                                  String targetSite,
                                                                  String targetFolder)

Move file or folder in site

Parameters:: userName - user name; password - password; siteName - source site; contentName - content to be moved; targetSite - tartget site; targetFolder - target folder. If null document library is set
Returns:: CmisObject of new created object

moveTo

public org.apache.chemistry.opencmis.client.api.CmisObject moveTo(String userName,
                                                                  String password,
                                                                  String pathFrom,
                                                                  String pathTo)

Move file or folder by path

Parameters:: userName - user name; password - password; pathFrom - path to source; pathTo - path to content
Returns:: CmisObject of new created object

setPermissionForUser

public boolean setPermissionForUser(String userName,
                                    String password,
                                    String siteName,
                                    String contentName,
                                    String userToAdd,
                                    String role,
                                    boolean isInherited)

Set permission for a user

Parameters:: userName - String user name; password - String password; siteName - String site name; contentName - String content name; userToAdd - user to set the permission; role - String role; isInherited - boolean is inherited
Returns:: true (200 OK) if permission is set

setPermissionForGroup

public boolean setPermissionForGroup(String userName,
                                     String password,
                                     String siteName,
                                     String contentName,
                                     String groupName,
                                     String role,
                                     boolean isInherited)

Set permission for a group

Parameters:: userName - String user name; password - String password; siteName - String site name; contentName - String content name; groupName - group to set the permission; role - String role; isInherited - boolean is inherited
Returns:: true (200 OK) if permission is set

removePermissionForUser

public boolean removePermissionForUser(String userName,
                                       String password,
                                       String siteName,
                                       String contentName,
                                       String userToRemove,
                                       String role,
                                       boolean isInherited)

Remove permission from a user

Parameters:: userName - String user name; password - String password; siteName - String site name; contentName - String content name; userToAdd - user to set the permission; role - String role; isInherited - boolean is inherited
Returns:: true (200 OK) if permission is set

removePermissionForGroup

public boolean removePermissionForGroup(String userName,
                                        String password,
                                        String siteName,
                                        String contentName,
                                        String groupToRemove,
                                        String role,
                                        boolean isInherited)

Remove permission from a group

Parameters:: userName - String user name; password - String password; siteName - String site name; contentName - String content name; groupName - group to set the permission; role - String role; isInherited - boolean is inherited
Returns:: true (200 OK) if permission is set

Class ContentActions

Nested Class Summary

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

Field Summary

Fields inherited from class org.alfresco.dataprep.CMISUtil

Constructor Summary

Method Summary

Methods inherited from class org.alfresco.dataprep.CMISUtil

Methods inherited from class java.lang.Object

Constructor Detail

ContentActions

Method Detail

addSingleTag

addSingleTag

addMultipleTags

addMultipleTags

getTagNamesFromContent

getTagNamesFromContent

getTagNodeRef

getTagNodeRef

removeTag

removeTag

addComment

addComment

addMultipleComments

addMultipleComments

getComments

getComments

getCommentNodeRef

getCommentNodeRef

removeComment

removeComment

likeContent

likeContent

countLikes

countLikes

removeLike

removeLike

setFileAsFavorite

setFolderAsFavorite

removeFavorite

isFavorite

checkOut

cancelCheckOut

checkIn

getVersion

copyTo

copyTo

moveTo

moveTo

setPermissionForUser

setPermissionForGroup

removePermissionForUser

removePermissionForGroup