org.alfresco.dataprep

Class ContentAspects

java.lang.Object

org.alfresco.dataprep.CMISUtil

org.alfresco.dataprep.ContentAspects

@Service
public class ContentAspects
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
ContentAspects()

Method Summary

Modifier and Type	Method and Description
void	addAspect(org.apache.chemistry.opencmis.client.api.Session session, String pathToContent, String... aspectsPropertyName) Add aspect for document or folder
void	addAspect(org.apache.chemistry.opencmis.client.api.Session session, String siteName, String contentName, CMISUtil.DocumentAspect aspect) Add aspect for document or folder
void	addAspect(String userName, String password, String pathToContent, String... aspectPropertiesName) Add aspect for document or folder
void	addAspect(String userName, String password, String siteName, String contentName, CMISUtil.DocumentAspect aspect) Add aspect for document or folder
void	addClasifiable(String userName, String password, String siteName, String contentName, List<String> categoryName) Method to add Clasifiable Aspect
void	addComplianceable(String userName, String password, String siteName, String contentName, Date removeAfter) Method to add Complianceable aspect
void	addDublinCore(String userName, String password, String siteName, String contentName, String publisher, String contributor, String type, String identifier, String source, String coverage, String rights, String subject) Method to add Dublin Core aspect
void	addEffectivity(String userName, String password, String siteName, String contentName, Date fromDate, Date toDate) Method to add Effectivity aspect
void	addEmailAlias(String userName, String password, String siteName, String contentName, String addressee) Add Email Alias aspect (emailserver:aliasable)
void	addEmailed(String userName, String password, String siteName, String contentName, String addressee, List<String> addressees, String subject, String originator, Date sentDate) Add Emailed Aspect
void	addGeographicAspect(String userName, String password, String siteName, String contentName, double longitude, double latitude) Method to add Geographic Aspect
void	addIndexControl(String userName, String password, String siteName, String contentName, boolean isIndexed, boolean contentIndexed) Method to add Index Control Aspect
void	addRestrictable(String userName, String password, String siteName, String contentName, int hours) Method to add Restrictable Aspect
void	addSummarizable(String userName, String password, String siteName, String contentName, String summary) Method to add Summarizable Aspect
void	addTemplatable(String userName, String password, String siteName, String contentName, String templateContent) Method to add Templatable Aspect
Map<String,Object>	getBasicProperties(String userName, String password, String siteName, String contentName) Method to read all basic Properties of a file
void	removeAspect(org.apache.chemistry.opencmis.client.api.Session session, String pathToContent, CMISUtil.DocumentAspect aspectToRemove) Remove aspect from document or folder by path
void	removeAspect(org.apache.chemistry.opencmis.client.api.Session session, String pathToContent, String... aspectsPropertyName) Remove aspect from document or folder by path
void	removeAspect(org.apache.chemistry.opencmis.client.api.Session session, String siteName, String contentName, CMISUtil.DocumentAspect aspectToRemove) Remove aspect from document or folder
void	removeAspect(String userName, String password, String siteName, String contentName, CMISUtil.DocumentAspect aspectToRemove) Remove aspect from document or folder
void	setBasicProperties(String userName, String password, String siteName, String contentName, String docName, String docTitle, String docDescription, String author) Method to update basic Properties of a file

Methods inherited from class org.alfresco.dataprep.CMISUtil

addAspect, addProperties, addProperties, addPropertiesByPath, attachDocuments, closeStreams, getCategoryNodeRef, getCmisObject, getCmisObject, getCmisObject, getCMISSession, getDocumentObject, getDocumentObject, getDocumentObject, getFolderObject, getFolderObject, getFolderObject, getNodeRef, getNodeRef, getNodeRefByPath, getNodeRefByPath, getProperties, getProperties, getProperties, 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

ContentAspects

public ContentAspects()

Method Detail

addAspect

public void addAspect(org.apache.chemistry.opencmis.client.api.Session session,
                      String siteName,
                      String contentName,
                      CMISUtil.DocumentAspect aspect)

Add aspect for document or folder

Parameters:

session - cmis session

siteName - site name

contentName - file or folder name

aspect - DocumentAspect aspect to add

addAspect

public void addAspect(String userName,
                      String password,
                      String siteName,
                      String contentName,
                      CMISUtil.DocumentAspect aspect)

Add aspect for document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

aspect - DocumentAspect aspect to add

addAspect

public void addAspect(String userName,
                      String password,
                      String pathToContent,
                      String... aspectPropertiesName)

Add aspect for document or folder

Parameters:

userName - String user name

password - String password

pathToContent - String path to content document or folder

aspectPropertyName - String aspect property name (e.g. P:cm:dublincore)

addAspect

public void addAspect(org.apache.chemistry.opencmis.client.api.Session session,
                      String pathToContent,
                      String... aspectsPropertyName)

Add aspect for document or folder

Overrides:

addAspect in class CMISUtil

Parameters:

userName - String user name

password - String password

pathToContent - String path to content document or folder

aspectsPropertyName - String aspect property name (e.g. P:cm:dublincore)

removeAspect

public void removeAspect(org.apache.chemistry.opencmis.client.api.Session session,
                         String siteName,
                         String contentName,
                         CMISUtil.DocumentAspect aspectToRemove)

Remove aspect from document or folder

Parameters:

session - Session

siteName - site name

contentName - file or folder name

aspectToRemove - aspect to be removed

removeAspect

public void removeAspect(org.apache.chemistry.opencmis.client.api.Session session,
                         String pathToContent,
                         CMISUtil.DocumentAspect aspectToRemove)

Remove aspect from document or folder by path

Parameters:

session - Session

pathToContent -

aspectToRemove - aspect to be removed

removeAspect

public void removeAspect(org.apache.chemistry.opencmis.client.api.Session session,
                         String pathToContent,
                         String... aspectsPropertyName)

Remove aspect from document or folder by path

Parameters:

session -

pathToContent -

aspectsPropertyName - aspects property name (e.g. P:cm:dublincore, P:cm:generalclassifiable)

removeAspect

public void removeAspect(String userName,
                         String password,
                         String siteName,
                         String contentName,
                         CMISUtil.DocumentAspect aspectToRemove)

Remove aspect from document or folder

Parameters:

session - Session

siteName - site name

contentName - file or folder name

aspectToRemove - aspect to be removed

addComplianceable

public void addComplianceable(String userName,
                              String password,
                              String siteName,
                              String contentName,
                              Date removeAfter)

Method to add Complianceable aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

removeAfter - date value for RemoveAfter property

addDublinCore

public void addDublinCore(String userName,
                          String password,
                          String siteName,
                          String contentName,
                          String publisher,
                          String contributor,
                          String type,
                          String identifier,
                          String source,
                          String coverage,
                          String rights,
                          String subject)

Method to add Dublin Core aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

publisher - value for publisher property

contributor - value for contributor property

type - value for type property

identifier - value for identifier property

source - value for source property

coverage - value for coverage property

rights - value for rights property

subject - value for subject property

addEffectivity

public void addEffectivity(String userName,
                           String password,
                           String siteName,
                           String contentName,
                           Date fromDate,
                           Date toDate)

Method to add Effectivity aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

fromDate - date value for From property

toDate - date value for To property

addGeographicAspect

public void addGeographicAspect(String userName,
                                String password,
                                String siteName,
                                String contentName,
                                double longitude,
                                double latitude)

Method to add Geographic Aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

longitude - value for longitude property

latitude - value for latitude property

addSummarizable

public void addSummarizable(String userName,
                            String password,
                            String siteName,
                            String contentName,
                            String summary)

Method to add Summarizable Aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

summary - value for summary property

addTemplatable

public void addTemplatable(String userName,
                           String password,
                           String siteName,
                           String contentName,
                           String templateContent)

Method to add Templatable Aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

templateContent - name of template

Throws:

org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException - if invalid template

addEmailed

public void addEmailed(String userName,
                       String password,
                       String siteName,
                       String contentName,
                       String addressee,
                       List<String> addressees,
                       String subject,
                       String originator,
                       Date sentDate)

Add Emailed Aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

addressee - value of addressee property

addressees - list of values for addressees property

subject - value of subject

originator - value for originator

sentDate - date for sentDate property

addEmailAlias

public void addEmailAlias(String userName,
                          String password,
                          String siteName,
                          String contentName,
                          String addressee)

Add Email Alias aspect (emailserver:aliasable)

Parameters:

userName - login username

password - login password

siteName - site name

contentName - folder name

addressee - value of addressee property

addIndexControl

public void addIndexControl(String userName,
                            String password,
                            String siteName,
                            String contentName,
                            boolean isIndexed,
                            boolean contentIndexed)

Method to add Index Control Aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

isIndexed - value of IsIndexed property

contentIndexed - value of ContentIndexed property

addRestrictable

public void addRestrictable(String userName,
                            String password,
                            String siteName,
                            String contentName,
                            int hours)

Method to add Restrictable Aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

hours - no of hours for OfflineExpiresAfter property

addClasifiable

public void addClasifiable(String userName,
                           String password,
                           String siteName,
                           String contentName,
                           List<String> categoryName)

Method to add Clasifiable Aspect

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

categoryName - list of categories

getBasicProperties

public Map<String,Object> getBasicProperties(String userName,
                                             String password,
                                             String siteName,
                                             String contentName)

Method to read all basic Properties of a file

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

Map return map of the basic properties

setBasicProperties

public void setBasicProperties(String userName,
                               String password,
                               String siteName,
                               String contentName,
                               String docName,
                               String docTitle,
                               String docDescription,
                               String author)

Method to update basic Properties of a file

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

docName - new value for name of document

docTitle - new value for title of document

docDescription - new value for description of document

author - new value for author od the document