org.apache.chemistry.opencmis.fileshare

Class FileShareCmisService

java.lang.Object

org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisService

org.apache.chemistry.opencmis.fileshare.FileShareCmisService

All Implemented Interfaces:

CmisService, ObjectInfoHandler, AclService, DiscoveryService, MultiFilingService, NavigationService, ObjectService, PolicyService, RelationshipService, RepositoryService, VersioningService, CallContextAwareCmisService

public class FileShareCmisService
extends AbstractCmisService
implements CallContextAwareCmisService

FileShare Service implementation.

Constructor Summary

Constructors

Constructor and Description
FileShareCmisService(FileShareRepositoryManager repositoryManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	appendContentStream(String repositoryId, Holder<String> objectId, Holder<String> changeToken, ContentStream contentStream, boolean isLastChunk, ExtensionsData extension) Appends the content stream to the content of the document.
List<BulkUpdateObjectIdAndChangeToken>	bulkUpdateProperties(String repositoryId, List<BulkUpdateObjectIdAndChangeToken> objectIdAndChangeToken, Properties properties, List<String> addSecondaryTypeIds, List<String> removeSecondaryTypeIds, ExtensionsData extension) Updates properties and secondary types of one or more objects.
String	create(String repositoryId, Properties properties, String folderId, ContentStream contentStream, VersioningState versioningState, List<String> policies, ExtensionsData extension) Creates a new document, folder, policy, or item.
String	createDocument(String repositoryId, Properties properties, String folderId, ContentStream contentStream, VersioningState versioningState, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension) Creates a document object of the specified type (given by the cmis:objectTypeId property) in the (optionally) specified location.
String	createDocumentFromSource(String repositoryId, String sourceId, Properties properties, String folderId, VersioningState versioningState, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension) Creates a document object as a copy of the given source document in the (optionally) specified location.
String	createFolder(String repositoryId, Properties properties, String folderId, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension) Creates a folder object of the specified type (given by the cmis:objectTypeId property) in the specified location.
void	deleteContentStream(String repositoryId, Holder<String> objectId, Holder<String> changeToken, ExtensionsData extension) Deletes the content stream for the specified document object.
void	deleteObjectOrCancelCheckOut(String repositoryId, String objectId, Boolean allVersions, ExtensionsData extension) Deletes an object or cancels a check out.
FailedToDeleteData	deleteTree(String repositoryId, String folderId, Boolean allVersions, UnfileObject unfileObjects, Boolean continueOnFailure, ExtensionsData extension) Deletes the specified folder object and all of its child- and descendant-objects.
Acl	getAcl(String repositoryId, String objectId, Boolean onlyBasicPermissions, ExtensionsData extension) Get the ACL currently applied to the specified object.
AllowableActions	getAllowableActions(String repositoryId, String objectId, ExtensionsData extension) Gets the list of allowable actions for an object.
List<ObjectData>	getAllVersions(String repositoryId, String objectId, String versionSeriesId, String filter, Boolean includeAllowableActions, ExtensionsData extension) Returns the list of all document objects in the specified version series, sorted by the property "cmis:creationDate" descending.
CallContext	getCallContext() Gets the call context.
ObjectList	getCheckedOutDocs(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) Gets the list of documents that are checked out that the user has access to.
ObjectInFolderList	getChildren(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) Gets the list of child objects contained in the specified folder.
ContentStream	getContentStream(String repositoryId, String objectId, String streamId, BigInteger offset, BigInteger length, ExtensionsData extension) Gets the content stream for the specified document object, or gets a rendition stream for a specified rendition of a document or folder object.
List<ObjectInFolderContainer>	getDescendants(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension) Gets the set of descendant objects contained in the specified folder or any of its child folders.
ObjectData	getFolderParent(String repositoryId, String folderId, String filter, ExtensionsData extension) Gets the parent folder object for the specified folder object.
List<ObjectInFolderContainer>	getFolderTree(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension) Gets the set of descendant folder objects contained in the specified folder.
ObjectData	getObject(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension) Gets the specified information for the object specified by id.
ObjectData	getObjectByPath(String repositoryId, String path, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension) Gets the specified information for the object specified by path.
ObjectData	getObjectOfLatestVersion(String repositoryId, String objectId, String versionSeriesId, Boolean major, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension) Get the latest document object in the version series.
List<ObjectParentData>	getObjectParents(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includeRelativePathSegment, ExtensionsData extension) Gets the parent folder(s) for the specified non-folder, fileable object.
Properties	getProperties(String repositoryId, String objectId, String filter, ExtensionsData extension) Gets the list of properties for an object.
Properties	getPropertiesOfLatestVersion(String repositoryId, String objectId, String versionSeriesId, Boolean major, String filter, ExtensionsData extension) Get a subset of the properties for the latest document object in the version series.
List<RenditionData>	getRenditions(String repositoryId, String objectId, String renditionFilter, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) Gets the list of associated renditions for the specified object.
FileShareRepository	getRepository() Gets the repository for the current call.
RepositoryInfo	getRepositoryInfo(String repositoryId, ExtensionsData extension) Returns information about the CMIS repository, the optional capabilities it supports and its access control information if applicable.
List<RepositoryInfo>	getRepositoryInfos(ExtensionsData extension) Returns a list of CMIS repository information available from this CMIS service endpoint.
TypeDefinitionList	getTypeChildren(String repositoryId, String typeId, Boolean includePropertyDefinitions, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) Returns the list of object types defined for the repository that are children of the specified type.
TypeDefinition	getTypeDefinition(String repositoryId, String typeId, ExtensionsData extension) Gets the definition of the specified object type.
List<TypeDefinitionContainer>	getTypeDescendants(String repositoryId, String typeId, BigInteger depth, Boolean includePropertyDefinitions, ExtensionsData extension) Returns the set of descendant object type defined for the repository under the specified type.
void	moveObject(String repositoryId, Holder<String> objectId, String targetFolderId, String sourceFolderId, ExtensionsData extension) Moves the specified file-able object from one folder to another.
void	setCallContext(CallContext context) Sets the call context.
void	setContentStream(String repositoryId, Holder<String> objectId, Boolean overwriteFlag, Holder<String> changeToken, ContentStream contentStream, ExtensionsData extension) Sets the content stream for the specified document object.
void	updateProperties(String repositoryId, Holder<String> objectId, Holder<String> changeToken, Properties properties, ExtensionsData extension) Updates properties of the specified object.

Methods inherited from class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisService

addObjectInfo, addObjectToFolder, applyAcl, applyAcl, applyPolicy, cancelCheckOut, checkIn, checkOut, clearObjectInfos, close, createItem, createPolicy, createRelationship, createType, deleteObject, deleteType, getAppliedPolicies, getBooleanProperty, getContentChanges, getDateTimeProperty, getIdProperty, getIntegerProperty, getObjectInfo, getObjectInfoIntern, getObjectRelationships, getStringProperty, query, removeObjectFromFolder, removePolicy, updateType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.chemistry.opencmis.commons.server.CmisService

applyAcl, close, getObjectInfo

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.RepositoryService

createType, deleteType, updateType

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.ObjectService

createItem, createPolicy, createRelationship, deleteObject

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.VersioningService

cancelCheckOut, checkIn, checkOut

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.DiscoveryService

getContentChanges, query

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.MultiFilingService

addObjectToFolder, removeObjectFromFolder

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.RelationshipService

getObjectRelationships

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.AclService

applyAcl

Methods inherited from interface org.apache.chemistry.opencmis.commons.spi.PolicyService

applyPolicy, getAppliedPolicies, removePolicy

Constructor Detail

FileShareCmisService

public FileShareCmisService(FileShareRepositoryManager repositoryManager)

Method Detail

setCallContext

public void setCallContext(CallContext context)

Sets the call context. This method should only be called by the service factory.

Specified by:

setCallContext in interface CallContextAwareCmisService

Parameters:

context - the new call context

getCallContext

public CallContext getCallContext()

Gets the call context.

Specified by:

getCallContext in interface CallContextAwareCmisService

Returns:

the call context

getRepository

public FileShareRepository getRepository()

Gets the repository for the current call.

getRepositoryInfo

public RepositoryInfo getRepositoryInfo(String repositoryId,
                               ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns information about the CMIS repository, the optional capabilities it supports and its access control information if applicable.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required. Convenience implementation is present.

Specified by:

getRepositoryInfo in interface RepositoryService

Overrides:

getRepositoryInfo in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

getRepositoryInfos

public List<RepositoryInfo> getRepositoryInfos(ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns a list of CMIS repository information available from this CMIS service endpoint. In contrast to the CMIS specification this method returns repository infos not only repository ids.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.

Specified by:

getRepositoryInfos in interface RepositoryService

Specified by:

getRepositoryInfos in class AbstractCmisService

getTypeChildren

public TypeDefinitionList getTypeChildren(String repositoryId,
                                 String typeId,
                                 Boolean includePropertyDefinitions,
                                 BigInteger maxItems,
                                 BigInteger skipCount,
                                 ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns the list of object types defined for the repository that are children of the specified type.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.

Specified by:

getTypeChildren in interface RepositoryService

Specified by:

getTypeChildren in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

typeId - (optional) the typeId of an object type specified in the repository (if not specified the repository MUST return all base object types)

includePropertyDefinitions - (optional) if true the repository MUST return the property definitions for each object type returned (default is false)

maxItems - (optional) the maximum number of items to return in a response (default is repository specific)

skipCount - (optional) number of potential results that the repository MUST skip/page over before returning any results (default is 0)

getTypeDefinition

public TypeDefinition getTypeDefinition(String repositoryId,
                               String typeId,
                               ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the definition of the specified object type.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.

Specified by:

getTypeDefinition in interface RepositoryService

Specified by:

getTypeDefinition in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

typeId - typeId of an object type specified in the repository

getTypeDescendants

public List<TypeDefinitionContainer> getTypeDescendants(String repositoryId,
                                               String typeId,
                                               BigInteger depth,
                                               Boolean includePropertyDefinitions,
                                               ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns the set of descendant object type defined for the repository under the specified type.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional. Convenience implementation is present.

Specified by:

getTypeDescendants in interface RepositoryService

Overrides:

getTypeDescendants in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

typeId - (optional) the typeId of an object type specified in the repository (if not specified the repository MUST return all types and MUST ignore the value of the depth parameter)

depth - (optional) the number of levels of depth in the type hierarchy from which to return results (default is repository specific)

includePropertyDefinitions - (optional) if true the repository MUST return the property definitions for each object type returned (default is false)

getChildren

public ObjectInFolderList getChildren(String repositoryId,
                             String folderId,
                             String filter,
                             String orderBy,
                             Boolean includeAllowableActions,
                             IncludeRelationships includeRelationships,
                             String renditionFilter,
                             Boolean includePathSegment,
                             BigInteger maxItems,
                             BigInteger skipCount,
                             ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the list of child objects contained in the specified folder.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.
• Object infos should contain the folder and all returned children.

Specified by:

getChildren in interface NavigationService

Specified by:

getChildren in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

folderId - the identifier for the folder

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

orderBy - (optional) a comma-separated list of query names that define the order of the result set. Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC" (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)

includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includePathSegment - (optional) if true, returns a path segment for each child object for use in constructing that object's path (default is false)

maxItems - (optional) the maximum number of items to return in a response (default is repository specific)

skipCount - (optional) number of potential results that the repository MUST skip/page over before returning any results (default is 0)

getDescendants

public List<ObjectInFolderContainer> getDescendants(String repositoryId,
                                           String folderId,
                                           BigInteger depth,
                                           String filter,
                                           Boolean includeAllowableActions,
                                           IncludeRelationships includeRelationships,
                                           String renditionFilter,
                                           Boolean includePathSegment,
                                           ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the set of descendant objects contained in the specified folder or any of its child folders.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the folder and all returned descendants.

Specified by:

getDescendants in interface NavigationService

Overrides:

getDescendants in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

folderId - the identifier for the folder

depth - the number of levels of depth in the folder hierarchy from which to return results

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)

includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includePathSegment - (optional) if true, returns a path segment for each child object for use in constructing that object's path (default is false)

getFolderParent

public ObjectData getFolderParent(String repositoryId,
                         String folderId,
                         String filter,
                         ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the parent folder object for the specified folder object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the returned parent folder.

Specified by:

getFolderParent in interface NavigationService

Overrides:

getFolderParent in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

folderId - the identifier for the folder

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

getFolderTree

public List<ObjectInFolderContainer> getFolderTree(String repositoryId,
                                          String folderId,
                                          BigInteger depth,
                                          String filter,
                                          Boolean includeAllowableActions,
                                          IncludeRelationships includeRelationships,
                                          String renditionFilter,
                                          Boolean includePathSegment,
                                          ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the set of descendant folder objects contained in the specified folder.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the folder and all returned descendants.

Specified by:

getFolderTree in interface NavigationService

Overrides:

getFolderTree in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

folderId - the identifier for the folder

depth - the number of levels of depth in the folder hierarchy from which to return results

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)

includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includePathSegment - (optional) if true, returns a path segment for each child object for use in constructing that object's path (default is false)

getObjectParents

public List<ObjectParentData> getObjectParents(String repositoryId,
                                      String objectId,
                                      String filter,
                                      Boolean includeAllowableActions,
                                      IncludeRelationships includeRelationships,
                                      String renditionFilter,
                                      Boolean includeRelativePathSegment,
                                      ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the parent folder(s) for the specified non-folder, fileable object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.
• Object infos should contain the object and all returned parents.

Specified by:

getObjectParents in interface NavigationService

Specified by:

getObjectParents in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)

includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includeRelativePathSegment - (optional) if true, returns a relative path segment for each parent object for use in constructing that object's path (default is false)

getCheckedOutDocs

public ObjectList getCheckedOutDocs(String repositoryId,
                           String folderId,
                           String filter,
                           String orderBy,
                           Boolean includeAllowableActions,
                           IncludeRelationships includeRelationships,
                           String renditionFilter,
                           BigInteger maxItems,
                           BigInteger skipCount,
                           ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the list of documents that are checked out that the user has access to.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the folder and the returned objects.

Specified by:

getCheckedOutDocs in interface NavigationService

Overrides:

getCheckedOutDocs in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

folderId - the identifier for the folder

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

orderBy - (optional) a comma-separated list of query names that define the order of the result set. Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC" (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the available actions for each object in the result set (default is false)

includeRelationships - (optional) indicates what relationships in which the objects participate must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

maxItems - (optional) the maximum number of items to return in a response (default is repository specific)

skipCount - (optional) number of potential results that the repository MUST skip/page over before returning any results (default is 0)

create

public String create(String repositoryId,
            Properties properties,
            String folderId,
            ContentStream contentStream,
            VersioningState versioningState,
            List<String> policies,
            ExtensionsData extension)

Description copied from class: AbstractCmisService

Creates a new document, folder, policy, or item. The property "cmis:objectTypeId" defines the type and implicitly the base type.

Implementation Hints:

• Bindings: AtomPub
• Implementation is optional. Convenience implementation is present.
• Object infos should contain the newly created object.

Specified by:

create in interface CmisService

Overrides:

create in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

properties - the property values that MUST be applied to the newly created object

folderId - (optional) if specified, the identifier for the folder that MUST be the parent folder for the newly created object

contentStream - (optional) if the object to create is a document object, the content stream that MUST be stored for the newly created document object

versioningState - (optional) if the object to create is a document object, it specifies what the versioning state of the newly created object MUST be (default is VersioningState.MAJOR)

policies - (optional) a list of policy IDs that MUST be applied to the newly created object

createDocument

public String createDocument(String repositoryId,
                    Properties properties,
                    String folderId,
                    ContentStream contentStream,
                    VersioningState versioningState,
                    List<String> policies,
                    Acl addAces,
                    Acl removeAces,
                    ExtensionsData extension)

Description copied from class: AbstractCmisService

Creates a document object of the specified type (given by the cmis:objectTypeId property) in the (optionally) specified location. The stream in contentStream is consumed but not closed by this method.

Implementation Hints:

• Bindings: Web Services, Browser, Local
• Implementation is optional.

Specified by:

createDocument in interface ObjectService

Overrides:

createDocument in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

properties - the property values that must be applied to the newly created document object

folderId - (optional) if specified, the identifier for the folder that must be the parent folder for the newly created document object

contentStream - (optional) the content stream that must be stored for the newly created document object

versioningState - (optional) specifies what the versioning state of the newly created object must be (default is VersioningState.MAJOR)

policies - (optional) a list of policy IDs that must be applied to the newly created document object

addAces - (optional) a list of ACEs that must be added to the newly created document object, either using the ACL from folderId if specified, or being applied if no folderId is specified

removeAces - (optional) a list of ACEs that must be removed from the newly created document object, either using the ACL from folderId if specified, or being ignored if no folderId is specified

createDocumentFromSource

public String createDocumentFromSource(String repositoryId,
                              String sourceId,
                              Properties properties,
                              String folderId,
                              VersioningState versioningState,
                              List<String> policies,
                              Acl addAces,
                              Acl removeAces,
                              ExtensionsData extension)

Description copied from class: AbstractCmisService

Creates a document object as a copy of the given source document in the (optionally) specified location.

Implementation Hints:

• Bindings: Web Services, Browser, Local
• Implementation is optional.

Specified by:

createDocumentFromSource in interface ObjectService

Overrides:

createDocumentFromSource in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

sourceId - the identifier for the source document

properties - the property values that must be applied to the newly created document object

folderId - (optional) if specified, the identifier for the folder that must be the parent folder for the newly created document object

versioningState - (optional) specifies what the versioning state of the newly created object must be (default is VersioningState.MAJOR)

policies - (optional) a list of policy IDs that must be applied to the newly created document object

addAces - (optional) a list of ACEs that must be added to the newly created document object, either using the ACL from folderId if specified, or being applied if no folderId is specified

removeAces - (optional) a list of ACEs that must be removed from the newly created document object, either using the ACL from folderId if specified, or being ignored if no folderId is specified

createFolder

public String createFolder(String repositoryId,
                  Properties properties,
                  String folderId,
                  List<String> policies,
                  Acl addAces,
                  Acl removeAces,
                  ExtensionsData extension)

Description copied from class: AbstractCmisService

Creates a folder object of the specified type (given by the cmis:objectTypeId property) in the specified location.

Implementation Hints:

• Bindings: Web Services, Browser, Local
• Implementation is optional.

Specified by:

createFolder in interface ObjectService

Overrides:

createFolder in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

properties - the property values that must be applied to the newly created folder object

folderId - the identifier for the parent folder

policies - (optional) a list of policy IDs that must be applied to the newly created folder object

addAces - (optional) a list of ACEs that must be added to the newly created folder object, either using the ACL from folderId if specified, or being applied if no folderId is specified

removeAces - (optional) a list of ACEs that must be removed from the newly created folder object, either using the ACL from folderId if specified, or being ignored if no folderId is specified

deleteObjectOrCancelCheckOut

public void deleteObjectOrCancelCheckOut(String repositoryId,
                                String objectId,
                                Boolean allVersions,
                                ExtensionsData extension)

Description copied from class: AbstractCmisService

Deletes an object or cancels a check out. For the Web Services binding this is always an object deletion. For the AtomPub it depends on the referenced object. If it is a checked out document then the check out must be canceled. If the object is not a checked out document then the object must be deleted.

Implementation Hints:

• Bindings: AtomPub
• Implementation is optional.

Specified by:

deleteObjectOrCancelCheckOut in interface CmisService

Overrides:

deleteObjectOrCancelCheckOut in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

allVersions - (optional) If true then delete all versions of the document, otherwise delete only the document object specified (default is true)

deleteTree

public FailedToDeleteData deleteTree(String repositoryId,
                            String folderId,
                            Boolean allVersions,
                            UnfileObject unfileObjects,
                            Boolean continueOnFailure,
                            ExtensionsData extension)

Description copied from class: AbstractCmisService

Deletes the specified folder object and all of its child- and descendant-objects.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.

Specified by:

deleteTree in interface ObjectService

Overrides:

deleteTree in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

folderId - the identifier for the folder

allVersions - (optional) If true then delete all versions of the document, otherwise delete only the document object specified (default is true)

unfileObjects - (optional) defines how the repository must process file-able child- or descendant-objects (default is UnfileObject.DELETE)

continueOnFailure - (optional) If true, then the repository should continue attempting to perform this operation even if deletion of a child- or descendant-object in the specified folder cannot be deleted (default is false)

getAllowableActions

public AllowableActions getAllowableActions(String repositoryId,
                                   String objectId,
                                   ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the list of allowable actions for an object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional. Convenience implementation is present.

Specified by:

getAllowableActions in interface ObjectService

Overrides:

getAllowableActions in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

getContentStream

public ContentStream getContentStream(String repositoryId,
                             String objectId,
                             String streamId,
                             BigInteger offset,
                             BigInteger length,
                             ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the content stream for the specified document object, or gets a rendition stream for a specified rendition of a document or folder object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.

Specified by:

getContentStream in interface ObjectService

Overrides:

getContentStream in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

getObject

public ObjectData getObject(String repositoryId,
                   String objectId,
                   String filter,
                   Boolean includeAllowableActions,
                   IncludeRelationships includeRelationships,
                   String renditionFilter,
                   Boolean includePolicyIds,
                   Boolean includeAcl,
                   ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the specified information for the object specified by id.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is required.
• Object infos should contain the returned object.

Specified by:

getObject in interface ObjectService

Specified by:

getObject in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the allowable actions for the object (default is false)

includeRelationships - (optional) indicates what relationships in which the object participates must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includePolicyIds - (optional) if true, then the repository must return the policy ids for the object (default is false)

includeAcl - (optional) if true, then the repository must return the ACL for the object (default is false)

getObjectByPath

public ObjectData getObjectByPath(String repositoryId,
                         String path,
                         String filter,
                         Boolean includeAllowableActions,
                         IncludeRelationships includeRelationships,
                         String renditionFilter,
                         Boolean includePolicyIds,
                         Boolean includeAcl,
                         ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the specified information for the object specified by path.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the returned object.

Specified by:

getObjectByPath in interface ObjectService

Overrides:

getObjectByPath in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

path - the path to the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the allowable actions for the object (default is false)

includeRelationships - (optional) indicates what relationships in which the object participates must be returned (default is IncludeRelationships.NONE)

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

includePolicyIds - (optional) if true, then the repository must return the policy ids for the object (default is false)

includeAcl - (optional) if true, then the repository must return the ACL for the object (default is false)

getProperties

public Properties getProperties(String repositoryId,
                       String objectId,
                       String filter,
                       ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the list of properties for an object.

Implementation Hints:

• Bindings: Web Services, Browser, Local
• Implementation is optional. Convenience implementation is present.

Specified by:

getProperties in interface ObjectService

Overrides:

getProperties in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

getRenditions

public List<RenditionData> getRenditions(String repositoryId,
                                String objectId,
                                String renditionFilter,
                                BigInteger maxItems,
                                BigInteger skipCount,
                                ExtensionsData extension)

Description copied from class: AbstractCmisService

Gets the list of associated renditions for the specified object. Only rendition attributes are returned, not rendition stream.

Implementation Hints:

• Bindings: Web Services, Browser, Local
• Implementation is optional.

Specified by:

getRenditions in interface ObjectService

Overrides:

getRenditions in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

renditionFilter - (optional) indicates what set of renditions the repository must return whose kind matches this filter (default is "cmis:none")

maxItems - (optional) the maximum number of items to return in a response (default is repository specific)

skipCount - (optional) number of potential results that the repository must skip/page over before returning any results (default is 0)

moveObject

public void moveObject(String repositoryId,
              Holder<String> objectId,
              String targetFolderId,
              String sourceFolderId,
              ExtensionsData extension)

Description copied from class: AbstractCmisService

Moves the specified file-able object from one folder to another.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the moved object.

Specified by:

moveObject in interface ObjectService

Overrides:

moveObject in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object. The repository might return a different/new object id

targetFolderId - the identifier for the target folder

sourceFolderId - the identifier for the source folder

setContentStream

public void setContentStream(String repositoryId,
                    Holder<String> objectId,
                    Boolean overwriteFlag,
                    Holder<String> changeToken,
                    ContentStream contentStream,
                    ExtensionsData extension)

Description copied from class: AbstractCmisService

Sets the content stream for the specified document object. The stream in contentStream is consumed but not closed by this method.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.

Specified by:

setContentStream in interface ObjectService

Overrides:

setContentStream in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object. The repository might return a different/new object id

overwriteFlag - (optional) If true, then the repository must replace the existing content stream for the object (if any) with the input content stream. If If false, then the repository must only set the input content stream for the object if the object currently does not have a content stream (default is true)

changeToken - (optional) the last change token of this object that the client received. The repository might return a new change token (default is null)

contentStream - the content stream

appendContentStream

public void appendContentStream(String repositoryId,
                       Holder<String> objectId,
                       Holder<String> changeToken,
                       ContentStream contentStream,
                       boolean isLastChunk,
                       ExtensionsData extension)

Description copied from class: AbstractCmisService

Appends the content stream to the content of the document.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Introduced in CMIS 1.1

Specified by:

appendContentStream in interface ObjectService

Overrides:

appendContentStream in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object. The repository might return a different/new object id

changeToken - (optional) the last change token of this object that the client received. The repository might return a new change token (default is null)

contentStream - the content stream to append

isLastChunk - indicates if this content stream is the last chunk

deleteContentStream

public void deleteContentStream(String repositoryId,
                       Holder<String> objectId,
                       Holder<String> changeToken,
                       ExtensionsData extension)

Description copied from class: AbstractCmisService

Deletes the content stream for the specified document object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.

Specified by:

deleteContentStream in interface ObjectService

Overrides:

deleteContentStream in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object. The repository might return a different/new object id

changeToken - (optional) the last change token of this object that the client received. The repository might return a new change token (default is null)

updateProperties

public void updateProperties(String repositoryId,
                    Holder<String> objectId,
                    Holder<String> changeToken,
                    Properties properties,
                    ExtensionsData extension)

Description copied from class: AbstractCmisService

Updates properties of the specified object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the updated object.

Specified by:

updateProperties in interface ObjectService

Overrides:

updateProperties in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object. The repository might return a different/new object id

changeToken - (optional) the last change token of this object that the client received. The repository might return a new change token (default is null)

properties - the updated property values that must be applied to the object

bulkUpdateProperties

public List<BulkUpdateObjectIdAndChangeToken> bulkUpdateProperties(String repositoryId,
                                                          List<BulkUpdateObjectIdAndChangeToken> objectIdAndChangeToken,
                                                          Properties properties,
                                                          List<String> addSecondaryTypeIds,
                                                          List<String> removeSecondaryTypeIds,
                                                          ExtensionsData extension)

Description copied from class: AbstractCmisService

Updates properties and secondary types of one or more objects.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Introduced in CMIS 1.1

Specified by:

bulkUpdateProperties in interface ObjectService

Overrides:

bulkUpdateProperties in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectIdAndChangeToken - the ids and change tokens of the objects to update

properties - the properties to set

addSecondaryTypeIds - the secondary types to apply

removeSecondaryTypeIds - the secondary types to remove

getAllVersions

public List<ObjectData> getAllVersions(String repositoryId,
                              String objectId,
                              String versionSeriesId,
                              String filter,
                              Boolean includeAllowableActions,
                              ExtensionsData extension)

Description copied from class: AbstractCmisService

Returns the list of all document objects in the specified version series, sorted by the property "cmis:creationDate" descending. Either the objectId or the versionSeriesId parameter must be set.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the returned objects.

Specified by:

getAllVersions in interface VersioningService

Overrides:

getAllVersions in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

versionSeriesId - the identifier for the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the allowable actions for the objects (default is false)

Returns:

the complete version history of the version series

getObjectOfLatestVersion

public ObjectData getObjectOfLatestVersion(String repositoryId,
                                  String objectId,
                                  String versionSeriesId,
                                  Boolean major,
                                  String filter,
                                  Boolean includeAllowableActions,
                                  IncludeRelationships includeRelationships,
                                  String renditionFilter,
                                  Boolean includePolicyIds,
                                  Boolean includeAcl,
                                  ExtensionsData extension)

Description copied from class: AbstractCmisService

Get the latest document object in the version series.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.
• Object infos should contain the returned object.

Specified by:

getObjectOfLatestVersion in interface VersioningService

Overrides:

getObjectOfLatestVersion in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

getPropertiesOfLatestVersion

public Properties getPropertiesOfLatestVersion(String repositoryId,
                                      String objectId,
                                      String versionSeriesId,
                                      Boolean major,
                                      String filter,
                                      ExtensionsData extension)

Description copied from class: AbstractCmisService

Get a subset of the properties for the latest document object in the version series.

Implementation Hints:

• Bindings: Web Services, Local
• Implementation is optional. Convenience implementation is present, if AbstractCmisService.getObjectOfLatestVersion(String, String, String, Boolean, String, Boolean, IncludeRelationships, String, Boolean, Boolean, ExtensionsData) is implemented.

Specified by:

getPropertiesOfLatestVersion in interface VersioningService

Overrides:

getPropertiesOfLatestVersion in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

getAcl

public Acl getAcl(String repositoryId,
         String objectId,
         Boolean onlyBasicPermissions,
         ExtensionsData extension)

Description copied from class: AbstractCmisService

Get the ACL currently applied to the specified object.

Implementation Hints:

• Bindings: AtomPub, Web Services, Browser, Local
• Implementation is optional.

Specified by:

getAcl in interface AclService

Overrides:

getAcl in class AbstractCmisService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

onlyBasicPermissions - (optional) an indicator if only basic permissions should be returned (default is true)

Returns:

the ACL of the object