org.alfresco.repo.cmis.ws

Class DMObjectServicePort

java.lang.Object

org.alfresco.repo.cmis.ws.DMAbstractServicePort

org.alfresco.repo.cmis.ws.DMObjectServicePort

All Implemented Interfaces:

ObjectServicePort

public class DMObjectServicePort
extends DMAbstractServicePort
implements ObjectServicePort

Port for object service

Author:

Dmitry Lazurkin, Dmitry Velichkevich

Field Summary

Fields inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort

authorityService, cmisAclService, cmisChangeLogService, cmisObjectFactory, cmisQueryService, cmisRenditionService, cmisService, descriptorService, fileFolderService, INCLUDE_RELATIONSHIPS_ENUM_MAPPING, nodeService, permissionService, propertiesUtil, searchService

Constructor Summary

Constructors

Constructor and Description
DMObjectServicePort()

Method Summary

Methods

Modifier and Type	Method and Description
void	createDocument(String repositoryId, CmisPropertiesType properties, String folderId, CmisContentStreamType contentStream, EnumVersioningState versioningState, List<String> policies, CmisAccessControlListType addACEs, CmisAccessControlListType removeACEs, Holder<CmisExtensionType> extension, Holder<String> objectId) Creates a document object of the specified type, and optionally adds the document to a folder
void	createDocumentFromSource(String repositoryId, String sourceId, CmisPropertiesType properties, String folderId, EnumVersioningState versioningState, List<String> policies, CmisAccessControlListType addACEs, CmisAccessControlListType removeACEs, Holder<CmisExtensionType> extension, Holder<String> objectId) Creates a document object as a copy of the given source document in the specified location
void	createFolder(String repositoryId, CmisPropertiesType properties, String folderId, List<String> policies, CmisAccessControlListType addACEs, CmisAccessControlListType removeACEs, Holder<CmisExtensionType> extension, Holder<String> objectId) Creates a folder object of the specified type.
void	createPolicy(String repositoryId, CmisPropertiesType properties, String folderId, List<String> policies, CmisAccessControlListType addACEs, CmisAccessControlListType removeACEs, Holder<CmisExtensionType> extension, Holder<String> objectId) Creates a policy object of the specified type, and optionally adds the policy to a folder.
void	createRelationship(String repositoryId, CmisPropertiesType properties, List<String> policies, CmisAccessControlListType addACEs, CmisAccessControlListType removeACEs, Holder<CmisExtensionType> extension, Holder<String> objectId) Creates a relationship object of the specified type.
void	deleteContentStream(String repositoryId, Holder<String> objectId, Holder<String> changeToken, Holder<CmisExtensionType> extension) Deletes the content-stream of the specified document.
void	deleteObject(String repositoryId, String objectId, Boolean allVersions, Holder<CmisExtensionType> extension) Deletes specified object.
DeleteTreeResponse.FailedToDelete	deleteTree(String repositoryId, String folderId, Boolean allVersions, EnumUnfileObject unfileObject, Boolean continueOnFailure, CmisExtensionType extension) Deletes the tree rooted at specified folder (including that folder)
CmisAllowableActionsType	getAllowableActions(String repositoryId, String objectId, CmisExtensionType extension) Gets the list of allowable actions (CMIS service calls) for an object based on the current user's context, subject to any access constraints that are currently imposed by the repository.
CmisContentStreamType	getContentStream(String repositoryId, String objectId, String streamId, BigInteger offset, BigInteger length, CmisExtensionType extension) Gets the content-stream for a document.
CmisObjectType	getObject(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, EnumIncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeACL, CmisExtensionType extension) Gets the specified object
CmisObjectType	getObjectByPath(String repositoryId, String path, String filter, Boolean includeAllowableActions, EnumIncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeACL, CmisExtensionType extension) Gets the specified object by path
CmisPropertiesType	getProperties(String repositoryId, String objectId, String filter, CmisExtensionType extension) Gets the properties of an object, and optionally the operations that the user is allowed to perform on the object.
List<CmisRenditionType>	getRenditions(String repositoryId, String objectId, String renditionFilter, BigInteger maxItems, BigInteger skipCount, CmisExtensionType extension) Gets the renditions of an object, and optionally the operations that the user is allowed to perform on the object.
void	moveObject(String repositoryId, Holder<String> objectId, String targetFolderId, String sourceFolderId, Holder<CmisExtensionType> extension) Moves the specified filed object from one folder to another
void	setContentStream(String repositoryId, Holder<String> objectId, Boolean overwriteFlag, Holder<String> changeToken, CmisContentStreamType contentStream, Holder<CmisExtensionType> extension) Sets (creates or replaces) the content-stream for the specified document object.
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setFileTypeIconRetriever(FileTypeIconRetriever iconRetriever)
void	updateProperties(String repositoryId, Holder<String> objectId, Holder<String> changeToken, CmisPropertiesType properties, Holder<CmisExtensionType> extension) Updates properties of the specified object.

Methods inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort

appendWithAce, appendWithRelationships, applyAclCarefully, applyPolicies, checkRepositoryId, convertAclReportToCmisAclType, createCmisObject, createCmisObject, createCmisObjectList, createCursor, createPropertyFilter, createPropertyFilter, determineObjectAllowableActions, getRenditions, isObjectInFolder, setAuthorityService, setCmisAclService, setCmisChangeLogService, setCmisQueryService, setCmisRenditionService, setCmisService, setDescriptorService, setFileFolderService, setNodeService, setPermissionService, setPropertiesUtil, setSearchService

Methods inherited from class java.lang.Object

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

Constructor Detail

DMObjectServicePort

public DMObjectServicePort()

Method Detail

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

createDocument

public void createDocument(String repositoryId,
                  CmisPropertiesType properties,
                  String folderId,
                  CmisContentStreamType contentStream,
                  EnumVersioningState versioningState,
                  List<String> policies,
                  CmisAccessControlListType addACEs,
                  CmisAccessControlListType removeACEs,
                  Holder<CmisExtensionType> extension,
                  Holder<String> objectId)
                    throws CmisException

Creates a document object of the specified type, and optionally adds the document to a folder

Specified by:

createDocument in interface ObjectServicePort

Parameters:

repositoryId - repository Id

properties - CMIS properties

folderId - parent folder for this new document

contentStream - content stream

versioningState - versioning state (checkedout, minor, major)

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE, STREAM_NOT_SUPPORTED)

createDocumentFromSource

public void createDocumentFromSource(String repositoryId,
                            String sourceId,
                            CmisPropertiesType properties,
                            String folderId,
                            EnumVersioningState versioningState,
                            List<String> policies,
                            CmisAccessControlListType addACEs,
                            CmisAccessControlListType removeACEs,
                            Holder<CmisExtensionType> extension,
                            Holder<String> objectId)
                              throws CmisException

Creates a document object as a copy of the given source document in the specified location

Specified by:

createDocumentFromSource in interface ObjectServicePort

Parameters:

repositoryId - repository Id

properties - CMIS properties

folderId - parent folder for this new document

contentStream - content stream

versioningState - versioning state (checkedout, minor, major)

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE, STREAM_NOT_SUPPORTED)

createFolder

public void createFolder(String repositoryId,
                CmisPropertiesType properties,
                String folderId,
                List<String> policies,
                CmisAccessControlListType addACEs,
                CmisAccessControlListType removeACEs,
                Holder<CmisExtensionType> extension,
                Holder<String> objectId)
                  throws CmisException

Creates a folder object of the specified type.

Specified by:

createFolder in interface ObjectServicePort

Parameters:

repositoryId - repository Id

properties - CMIS properties

folderId - parent folder for this new folder

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE)

createPolicy

public void createPolicy(String repositoryId,
                CmisPropertiesType properties,
                String folderId,
                List<String> policies,
                CmisAccessControlListType addACEs,
                CmisAccessControlListType removeACEs,
                Holder<CmisExtensionType> extension,
                Holder<String> objectId)
                  throws CmisException

Creates a policy object of the specified type, and optionally adds the policy to a folder.

Specified by:

createPolicy in interface ObjectServicePort

Parameters:

repositoryId - repository Id

properties - CMIS properties

folderId - parent folder for this new policy

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE)

createRelationship

public void createRelationship(String repositoryId,
                      CmisPropertiesType properties,
                      List<String> policies,
                      CmisAccessControlListType addACEs,
                      CmisAccessControlListType removeACEs,
                      Holder<CmisExtensionType> extension,
                      Holder<String> objectId)
                        throws CmisException

Creates a relationship object of the specified type.

Specified by:

createRelationship in interface ObjectServicePort

Parameters:

repositoryId - repository Id

typeId - relationship type

properties - CMIS properties

sourceObjectId - source object Id

targetObjectId - target object Id

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE)

deleteContentStream

public void deleteContentStream(String repositoryId,
                       Holder<String> objectId,
                       Holder<String> changeToken,
                       Holder<CmisExtensionType> extension)
                         throws CmisException

Deletes the content-stream of the specified document. This does not delete properties. If there are other versions this does not affect them, their properties or content. This does not change the ID of the document.

Specified by:

deleteContentStream in interface ObjectServicePort

Parameters:

repositoryId - repository Id

objectId - document Id

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE, UPDATE_CONFLICT, VERSIONING)

deleteObject

public void deleteObject(String repositoryId,
                String objectId,
                Boolean allVersions,
                Holder<CmisExtensionType> extension)
                  throws CmisException

Deletes specified object.

Specified by:

deleteObject in interface ObjectServicePort

Parameters:

repositoryId - repository Id

objectId - object Id

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, UPDATE_CONFLICT)

deleteTree

public DeleteTreeResponse.FailedToDelete deleteTree(String repositoryId,
                                           String folderId,
                                           Boolean allVersions,
                                           EnumUnfileObject unfileObject,
                                           Boolean continueOnFailure,
                                           CmisExtensionType extension)
                                             throws CmisException

Deletes the tree rooted at specified folder (including that folder)

Specified by:

deleteTree in interface ObjectServicePort

Parameters:

repositoryId - repository Id

folderId - folder Id

unfileNonfolderObjects - unfile : unfile all non-folder objects from folders in this tree. They may remain filed in other folders, or may become unfiled, deletesinglefiled : delete non-folder objects filed only in this tree, and unfile the others so they remain filed in other folders, delete : delete all non-folder objects in this tree (Default)

continueOnFailure - flag

Returns:

collection of object IDs that failed to delete (if continueOnFailure is FALSE, then single object ID)

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, UPDATE_CONFLICT)

getObject

public CmisObjectType getObject(String repositoryId,
                       String objectId,
                       String filter,
                       Boolean includeAllowableActions,
                       EnumIncludeRelationships includeRelationships,
                       String renditionFilter,
                       Boolean includePolicyIds,
                       Boolean includeACL,
                       CmisExtensionType extension)
                         throws CmisException

Gets the specified object

Specified by:

getObject in interface ObjectServicePort

Parameters:

repositoryId - repository Id

folderPath - The path to the folder

filter - property filter

Returns:

list of properties for the Folder

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND)

getObjectByPath

public CmisObjectType getObjectByPath(String repositoryId,
                             String path,
                             String filter,
                             Boolean includeAllowableActions,
                             EnumIncludeRelationships includeRelationships,
                             String renditionFilter,
                             Boolean includePolicyIds,
                             Boolean includeACL,
                             CmisExtensionType extension)
                               throws CmisException

Gets the specified object by path

Specified by:

getObjectByPath in interface ObjectServicePort

Parameters:

repositoryId - repository Id

folderPath - The path to the folder

filter - property filter

Returns:

list of properties for the Folder

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND)

getAllowableActions

public CmisAllowableActionsType getAllowableActions(String repositoryId,
                                           String objectId,
                                           CmisExtensionType extension)
                                             throws CmisException

Gets the list of allowable actions (CMIS service calls) for an object based on the current user's context, subject to any access constraints that are currently imposed by the repository.

Specified by:

getAllowableActions in interface ObjectServicePort

Parameters:

repositoryId - repository Id

objectId - object Id

Returns:

list of allowable actions

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME)

getContentStream

public CmisContentStreamType getContentStream(String repositoryId,
                                     String objectId,
                                     String streamId,
                                     BigInteger offset,
                                     BigInteger length,
                                     CmisExtensionType extension)
                                       throws CmisException

Gets the content-stream for a document.

Specified by:

getContentStream in interface ObjectServicePort

Parameters:

repositoryId - repository Id

documentId - document to return the content-stream

Returns:

content stream

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, STREAM_NOT_SUPPORTED)

moveObject

public void moveObject(String repositoryId,
              Holder<String> objectId,
              String targetFolderId,
              String sourceFolderId,
              Holder<CmisExtensionType> extension)
                throws CmisException

Moves the specified filed object from one folder to another

Specified by:

moveObject in interface ObjectServicePort

Parameters:

repositoryId - repository Id

objectId - object Id

targetFolderId - the target folder to be moved into

sourceFolderId - the source folder to be moved out of

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE, UPDATE_CONFLICT, VERSIONING)

setContentStream

public void setContentStream(String repositoryId,
                    Holder<String> objectId,
                    Boolean overwriteFlag,
                    Holder<String> changeToken,
                    CmisContentStreamType contentStream,
                    Holder<CmisExtensionType> extension)
                      throws CmisException

Sets (creates or replaces) the content-stream for the specified document object.

Specified by:

setContentStream in interface ObjectServicePort

Parameters:

repositoryId - repository Id

objectId - document Id

overwriteFlag - flag

contentStream - content stream

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, CONTENT_ALREADY_EXISTS, STORAGE, STREAM_NOT_SUPPORTED, UPDATE_CONFLICT, VERSIONING)

updateProperties

public void updateProperties(String repositoryId,
                    Holder<String> objectId,
                    Holder<String> changeToken,
                    CmisPropertiesType properties,
                    Holder<CmisExtensionType> extension)
                      throws CmisException

Updates properties of the specified object. As per the data model, content-streams are not properties.

Specified by:

updateProperties in interface ObjectServicePort

Parameters:

repositoryId - repository Id

objectId - object Id

changeToken - change token

properties - list of properties to update

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, UPDATE_CONFLICT, VERSIONING)

getProperties

public CmisPropertiesType getProperties(String repositoryId,
                               String objectId,
                               String filter,
                               CmisExtensionType extension)
                                 throws CmisException

Gets the properties of an object, and optionally the operations that the user is allowed to perform on the object.

Specified by:

getProperties in interface ObjectServicePort

Parameters:

parameters -

Returns:

collection collection of CmisObjectType

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FOLDER_NOT_VALID)

getRenditions

public List<CmisRenditionType> getRenditions(String repositoryId,
                                    String objectId,
                                    String renditionFilter,
                                    BigInteger maxItems,
                                    BigInteger skipCount,
                                    CmisExtensionType extension)
                                      throws CmisException

Gets the renditions of an object, and optionally the operations that the user is allowed to perform on the object.

Specified by:

getRenditions in interface ObjectServicePort

Parameters:

parameters -

Returns:

collection collection of CmisObjectType

Throws:

CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FOLDER_NOT_VALID)

setFileTypeIconRetriever

public void setFileTypeIconRetriever(FileTypeIconRetriever iconRetriever)