Package org.opencms.cmis
Interface I_CmsCmisRepository
-
- All Superinterfaces:
I_CmsConfigurationParameterHandler
,I_CmsRepository
- All Known Implementing Classes:
A_CmsCmisRepository
,CmsCmisRepository
public interface I_CmsCmisRepository extends I_CmsRepository
Base interface for OpenCms CMIS repositories.
-
-
Field Summary
-
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addObjectToFolder(CmsCmisCallContext context, java.lang.String objectId, java.lang.String folderId, boolean allVersions)
Adds an object to a folder (multifiling).org.apache.chemistry.opencmis.commons.data.Acl
applyAcl(CmsCmisCallContext context, java.lang.String objectId, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces, org.apache.chemistry.opencmis.commons.enums.AclPropagation aclPropagation)
Applies ACL to an object.org.apache.chemistry.opencmis.commons.data.Acl
applyAcl(CmsCmisCallContext context, java.lang.String objectId, org.apache.chemistry.opencmis.commons.data.Acl aces, org.apache.chemistry.opencmis.commons.enums.AclPropagation aclPropagation)
Changes the ACL for an object.void
applyPolicy(CmsCmisCallContext context, java.lang.String policyId, java.lang.String objectId)
Applies a policy to an object.void
cancelCheckOut(CmsCmisCallContext context, java.lang.String objectId)
Cancels a checkout.void
checkIn(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, boolean major, org.apache.chemistry.opencmis.commons.data.Properties properties, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream, java.lang.String checkinComment, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Checks in a document.void
checkOut(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.Boolean> contentCopied)
Checks out an object.java.lang.String
createDocument(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties propertiesObj, java.lang.String folderId, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream, org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a new document.java.lang.String
createDocumentFromSource(CmsCmisCallContext context, java.lang.String sourceId, org.apache.chemistry.opencmis.commons.data.Properties propertiesObj, java.lang.String folderId, org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Copies a document.java.lang.String
createFolder(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties propertiesObj, java.lang.String folderId, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a new folder.java.lang.String
createPolicy(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties properties, java.lang.String folderId, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a policy.java.lang.String
createRelationship(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties properties, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a relationship.void
deleteContentStream(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeToken)
Deletes the content stream of an object.void
deleteObject(CmsCmisCallContext context, java.lang.String objectId, boolean allVersions)
Deletes a CMIS object.org.apache.chemistry.opencmis.commons.data.FailedToDeleteData
deleteTree(CmsCmisCallContext context, java.lang.String folderId, boolean allVersions, org.apache.chemistry.opencmis.commons.enums.UnfileObject unfileObjects, boolean continueOnFailure)
Deletes a whole file tree.org.apache.chemistry.opencmis.commons.data.Acl
getAcl(CmsCmisCallContext context, java.lang.String objectId, boolean onlyBasicPermissions)
Gets the ACL for an object.org.apache.chemistry.opencmis.commons.data.AllowableActions
getAllowableActions(CmsCmisCallContext context, java.lang.String objectId)
Gets the allowable actions for an object.java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectData>
getAllVersions(CmsCmisCallContext context, java.lang.String objectId, java.lang.String versionSeriesId, java.lang.String filter, boolean includeAllowableActions)
Gets all versions of an object.java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectData>
getAppliedPolicies(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter)
Gets the policies for an object.org.apache.chemistry.opencmis.commons.data.ObjectList
getCheckedOutDocs(CmsCmisCallContext context, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Corresponds to CMIS getCheckedOutDocs service method.org.apache.chemistry.opencmis.commons.data.ObjectInFolderList
getChildren(CmsCmisCallContext context, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePathSegment, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the children of a folder.CmsParameterConfiguration
getConfiguration()
Returns the parameters of this configurable class instance, ornull
if the class does not need any parameters.org.apache.chemistry.opencmis.commons.data.ObjectList
getContentChanges(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeLogToken, boolean includeProperties, java.lang.String filter, boolean includePolicyIds, boolean includeAcl, java.math.BigInteger maxItems)
Gets content changes from the repository.org.apache.chemistry.opencmis.commons.data.ContentStream
getContentStream(CmsCmisCallContext context, java.lang.String objectId, java.lang.String streamId, java.math.BigInteger offset, java.math.BigInteger length)
Gets the content stream for a CMIS object.java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectInFolderContainer>
getDescendants(CmsCmisCallContext context, java.lang.String folderId, java.math.BigInteger depth, java.lang.String filter, boolean includeAllowableActions, boolean includePathSegment, boolean foldersOnly)
java.lang.String
getDescription()
Gets the description of the repository.CmsRepositoryFilter
getFilter()
Gets the repository filter.org.apache.chemistry.opencmis.commons.data.ObjectData
getFolderParent(CmsCmisCallContext context, java.lang.String folderId, java.lang.String filter)
Corresponds to CMIS getFolderParent service method.java.lang.String
getId()
Gets the repository id.java.lang.String
getName()
Gets the name of the repository.org.apache.chemistry.opencmis.commons.data.ObjectData
getObject(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePolicyIds, boolean includeAcl)
Gets the data for a CMIS object.org.apache.chemistry.opencmis.commons.data.ObjectData
getObjectByPath(CmsCmisCallContext context, java.lang.String path, java.lang.String filter, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePolicyIds, boolean includeAcl)
Reads a CMIS object by path.org.apache.chemistry.opencmis.commons.data.ObjectData
getObjectOfLatestVersion(CmsCmisCallContext context, java.lang.String objectId, java.lang.String versionSeriesId, boolean major, java.lang.String filter, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePolicyIds, boolean includeAcl)
Gets the object of the latest version.java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectParentData>
getObjectParents(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter, boolean includeAllowableActions, boolean includeRelativePathSegment)
Gets the parents of an object.org.apache.chemistry.opencmis.commons.data.ObjectList
getObjectRelationships(CmsCmisCallContext context, java.lang.String objectId, boolean includeSubRelationshipTypes, org.apache.chemistry.opencmis.commons.enums.RelationshipDirection relationshipDirection, java.lang.String typeId, java.lang.String filter, boolean includeAllowableActions, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the relationships for an object.org.apache.chemistry.opencmis.commons.data.Properties
getProperties(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter)
Gets the properties for a CMIS object.org.apache.chemistry.opencmis.commons.data.Properties
getPropertiesOfLatestVersion(CmsCmisCallContext context, java.lang.String objectId, java.lang.String versionSeriesId, boolean major, java.lang.String filter)
Gets the properties of the latest version.java.util.List<org.apache.chemistry.opencmis.commons.data.RenditionData>
getRenditions(CmsCmisCallContext context, java.lang.String objectId, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the renditions for a CMIS object.org.apache.chemistry.opencmis.commons.data.RepositoryInfo
getRepositoryInfo()
Gets the repository information for this repository.org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionList
getTypeChildren(CmsCmisCallContext context, java.lang.String typeId, boolean includePropertyDefinitions, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the children of a given type.org.apache.chemistry.opencmis.commons.definitions.TypeDefinition
getTypeDefinition(CmsCmisCallContext context, java.lang.String typeId)
Gets a type definition by id.java.util.List<org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer>
getTypeDescendants(CmsCmisCallContext context, java.lang.String typeId, java.math.BigInteger depth, boolean includePropertyDefinitions)
Gets the type descendants.void
moveObject(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, java.lang.String targetFolderId, java.lang.String sourceFolderId)
Moves an object.org.apache.chemistry.opencmis.commons.data.ObjectList
query(CmsCmisCallContext context, java.lang.String statement, boolean searchAllVersions, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Performs a query on the repository.void
removeObjectFromFolder(CmsCmisCallContext context, java.lang.String objectId, java.lang.String folderId)
Unfiles an object from a folder.void
removePolicy(CmsCmisCallContext context, java.lang.String policyId, java.lang.String objectId)
Removes a policy from an object.void
setContentStream(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, boolean overwriteFlag, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeToken, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream)
Sets the content stream of an object.void
updateProperties(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeToken, org.apache.chemistry.opencmis.commons.data.Properties properties)
Updates the properties for an object.-
Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
addConfigurationParameter, initConfiguration
-
Methods inherited from interface org.opencms.repository.I_CmsRepository
getTranslation, initializeCms, isTranslationEnabled, setFilter, setName, setTranslation
-
-
-
-
Method Detail
-
addObjectToFolder
void addObjectToFolder(CmsCmisCallContext context, java.lang.String objectId, java.lang.String folderId, boolean allVersions)
Adds an object to a folder (multifiling).- Parameters:
context
- the call contextobjectId
- the object idfolderId
- the folder idallVersions
- flag to include all versions
-
applyAcl
org.apache.chemistry.opencmis.commons.data.Acl applyAcl(CmsCmisCallContext context, java.lang.String objectId, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces, org.apache.chemistry.opencmis.commons.enums.AclPropagation aclPropagation)
Applies ACL to an object.- Parameters:
context
- the call contextobjectId
- the object idaddAces
- the ACEs to addremoveAces
- the ACEs to removeaclPropagation
- the ACL propagation- Returns:
- the new ACL
-
applyAcl
org.apache.chemistry.opencmis.commons.data.Acl applyAcl(CmsCmisCallContext context, java.lang.String objectId, org.apache.chemistry.opencmis.commons.data.Acl aces, org.apache.chemistry.opencmis.commons.enums.AclPropagation aclPropagation)
Changes the ACL for an object.- Parameters:
context
- the call contextobjectId
- the object idaces
- the access control entriesaclPropagation
- the propagation mode- Returns:
- the new ACL
-
applyPolicy
void applyPolicy(CmsCmisCallContext context, java.lang.String policyId, java.lang.String objectId)
Applies a policy to an object.- Parameters:
context
- the call contextpolicyId
- the policy idobjectId
- the object id
-
cancelCheckOut
void cancelCheckOut(CmsCmisCallContext context, java.lang.String objectId)
Cancels a checkout.- Parameters:
context
- the call contextobjectId
- the object id
-
checkIn
void checkIn(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, boolean major, org.apache.chemistry.opencmis.commons.data.Properties properties, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream, java.lang.String checkinComment, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Checks in a document.- Parameters:
context
- the call contextobjectId
- the object idmajor
- the major version flagproperties
- the propertiescontentStream
- the content streamcheckinComment
- the check-in commentpolicies
- the policiesaddAces
- the ACEs to addremoveAces
- the ACEs to remove
-
checkOut
void checkOut(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.Boolean> contentCopied)
Checks out an object.- Parameters:
context
- the call contextobjectId
- the object idcontentCopied
- indicator whether the content was copied
-
createDocument
java.lang.String createDocument(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties propertiesObj, java.lang.String folderId, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream, org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a new document.- Parameters:
context
- the call contextpropertiesObj
- the propertiesfolderId
- the parent folder idcontentStream
- the content streamversioningState
- the versioning statepolicies
- the policiesaddAces
- the access control entriesremoveAces
- the access control entries to remove- Returns:
- the object id of the new document
-
createDocumentFromSource
java.lang.String createDocumentFromSource(CmsCmisCallContext context, java.lang.String sourceId, org.apache.chemistry.opencmis.commons.data.Properties propertiesObj, java.lang.String folderId, org.apache.chemistry.opencmis.commons.enums.VersioningState versioningState, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Copies a document.- Parameters:
context
- the call contextsourceId
- the source object idpropertiesObj
- the propertiesfolderId
- the target folder idversioningState
- the versioning statepolicies
- the policiesaddAces
- the ACEs to addremoveAces
- the ACES to remove- Returns:
- the object id of the new document
-
createFolder
java.lang.String createFolder(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties propertiesObj, java.lang.String folderId, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a new folder.- Parameters:
context
- the call contextpropertiesObj
- the propertiesfolderId
- the parent folder idpolicies
- the policiesaddAces
- the ACEs to addremoveAces
- the ACEs to remove- Returns:
- the object id of the created folder
-
createPolicy
java.lang.String createPolicy(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties properties, java.lang.String folderId, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a policy.- Parameters:
context
- the call contextproperties
- the propertiesfolderId
- the folder idpolicies
- the policiesaddAces
- the ACEs to addremoveAces
- the ACEs to remove- Returns:
- the new object id
-
createRelationship
java.lang.String createRelationship(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.data.Properties properties, java.util.List<java.lang.String> policies, org.apache.chemistry.opencmis.commons.data.Acl addAces, org.apache.chemistry.opencmis.commons.data.Acl removeAces)
Creates a relationship.- Parameters:
context
- the call contextproperties
- the propertiespolicies
- the policiesaddAces
- the ACEs to addremoveAces
- the ACEs to remove- Returns:
- the new relationship id
-
deleteContentStream
void deleteContentStream(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeToken)
Deletes the content stream of an object.- Parameters:
context
- the call contextobjectId
- the object idchangeToken
- the change token
-
deleteObject
void deleteObject(CmsCmisCallContext context, java.lang.String objectId, boolean allVersions)
Deletes a CMIS object.- Parameters:
context
- the call contextobjectId
- the id of the object to deleteallVersions
- flag to delete all version
-
deleteTree
org.apache.chemistry.opencmis.commons.data.FailedToDeleteData deleteTree(CmsCmisCallContext context, java.lang.String folderId, boolean allVersions, org.apache.chemistry.opencmis.commons.enums.UnfileObject unfileObjects, boolean continueOnFailure)
Deletes a whole file tree.- Parameters:
context
- the call contextfolderId
- the folder idallVersions
- flag to include all versionsunfileObjects
- flag to unfile objectscontinueOnFailure
- flag to continue on failure- Returns:
- data containing the objects which weren'T deleted successfully
-
getAcl
org.apache.chemistry.opencmis.commons.data.Acl getAcl(CmsCmisCallContext context, java.lang.String objectId, boolean onlyBasicPermissions)
Gets the ACL for an object.- Parameters:
context
- the call contextobjectId
- the object idonlyBasicPermissions
- flag to only get basic permissions- Returns:
- the ACL for the object
-
getAllowableActions
org.apache.chemistry.opencmis.commons.data.AllowableActions getAllowableActions(CmsCmisCallContext context, java.lang.String objectId)
Gets the allowable actions for an object.- Parameters:
context
- the call contextobjectId
- the object id- Returns:
- the allowable actions
-
getAllVersions
java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectData> getAllVersions(CmsCmisCallContext context, java.lang.String objectId, java.lang.String versionSeriesId, java.lang.String filter, boolean includeAllowableActions)
Gets all versions of an object.- Parameters:
context
- the call contextobjectId
- the object idversionSeriesId
- the version series idfilter
- the property filter stringincludeAllowableActions
- the flag to include allowable actions- Returns:
- the list of versions
-
getAppliedPolicies
java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectData> getAppliedPolicies(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter)
Gets the policies for an object.- Parameters:
context
- the call contextobjectId
- the object idfilter
- the property filter- Returns:
- the policies for the object
-
getCheckedOutDocs
org.apache.chemistry.opencmis.commons.data.ObjectList getCheckedOutDocs(CmsCmisCallContext context, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Corresponds to CMIS getCheckedOutDocs service method.- Parameters:
context
-folderId
-filter
-orderBy
-includeAllowableActions
-includeRelationships
-renditionFilter
-maxItems
-skipCount
-- Returns:
- a list of CMIS objects
-
getChildren
org.apache.chemistry.opencmis.commons.data.ObjectInFolderList getChildren(CmsCmisCallContext context, java.lang.String folderId, java.lang.String filter, java.lang.String orderBy, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePathSegment, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the children of a folder.- Parameters:
context
- the call contextfolderId
- the parent folder idfilter
- the property filterorderBy
- the ordering clauseincludeAllowableActions
- flag to include allowable actionsincludeRelationships
- flag to include relationsrenditionFilter
- the rendition filter stringincludePathSegment
- flag to include the path segmentmaxItems
- the maximum number of itemsskipCount
- the index from which to start- Returns:
- the object information
-
getConfiguration
CmsParameterConfiguration getConfiguration()
Description copied from interface:I_CmsConfigurationParameterHandler
Returns the parameters of this configurable class instance, ornull
if the class does not need any parameters.- Specified by:
getConfiguration
in interfaceI_CmsConfigurationParameterHandler
- Returns:
- the parameters of this configurable class instance,
or
null
if the class does not need any parameters - See Also:
I_CmsConfigurationParameterHandler.getConfiguration()
-
getContentChanges
org.apache.chemistry.opencmis.commons.data.ObjectList getContentChanges(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeLogToken, boolean includeProperties, java.lang.String filter, boolean includePolicyIds, boolean includeAcl, java.math.BigInteger maxItems)
Gets content changes from the repository.- Parameters:
context
- the call contextchangeLogToken
- the change log tokenincludeProperties
- flag to include propertiesfilter
- filter string for propertiesincludePolicyIds
- flag to include policy idsincludeAcl
- flag to include ACLsmaxItems
- maximum number of items to return- Returns:
- the list of content changes
-
getContentStream
org.apache.chemistry.opencmis.commons.data.ContentStream getContentStream(CmsCmisCallContext context, java.lang.String objectId, java.lang.String streamId, java.math.BigInteger offset, java.math.BigInteger length)
Gets the content stream for a CMIS object.- Parameters:
context
- the call contextobjectId
- the object idstreamId
- the rendition stream idoffset
-length
-- Returns:
- the content stream
-
getDescendants
java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectInFolderContainer> getDescendants(CmsCmisCallContext context, java.lang.String folderId, java.math.BigInteger depth, java.lang.String filter, boolean includeAllowableActions, boolean includePathSegment, boolean foldersOnly)
- Parameters:
context
- the call contextfolderId
- the folder iddepth
- the maximum depthfilter
- the property filterincludeAllowableActions
- flag to include allowable actionsincludePathSegment
- flag to include path segmentsfoldersOnly
- flag to ignore documents and only return folders- Returns:
- the list of descendants
-
getDescription
java.lang.String getDescription()
Gets the description of the repository.- Returns:
- the repository description
-
getFilter
CmsRepositoryFilter getFilter()
Description copied from interface:I_CmsRepository
Gets the repository filter.- Specified by:
getFilter
in interfaceI_CmsRepository
- Returns:
- the repository filter
- See Also:
I_CmsRepository.getFilter()
-
getFolderParent
org.apache.chemistry.opencmis.commons.data.ObjectData getFolderParent(CmsCmisCallContext context, java.lang.String folderId, java.lang.String filter)
Corresponds to CMIS getFolderParent service method.- Parameters:
context
- the call contextfolderId
- the folder idfilter
- the property filter- Returns:
- the parent object data
-
getId
java.lang.String getId()
Gets the repository id.- Returns:
- the repository id
-
getName
java.lang.String getName()
Gets the name of the repository.- Specified by:
getName
in interfaceI_CmsRepository
- Returns:
- the name of the repository
-
getObject
org.apache.chemistry.opencmis.commons.data.ObjectData getObject(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePolicyIds, boolean includeAcl)
Gets the data for a CMIS object.- Parameters:
context
- the CMIS call contextobjectId
- the id of the objectfilter
- the property filterincludeAllowableActions
- flag to include allowable actionsincludeRelationships
- flag to include relationshipsrenditionFilter
- the rendition filter stringincludePolicyIds
- flag to include policy idsincludeAcl
- flag to include ACLs- Returns:
- the CMIS object data
-
getObjectByPath
org.apache.chemistry.opencmis.commons.data.ObjectData getObjectByPath(CmsCmisCallContext context, java.lang.String path, java.lang.String filter, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePolicyIds, boolean includeAcl)
Reads a CMIS object by path.- Parameters:
context
- the call contextpath
- the repository pathfilter
- the property filter stringincludeAllowableActions
- flag to include allowable actionsincludeRelationships
- flag to include relationshipsrenditionFilter
- the rendition filter stringincludePolicyIds
- flag to include policy idsincludeAcl
- flag to include ACLs- Returns:
- the object data
-
getObjectOfLatestVersion
org.apache.chemistry.opencmis.commons.data.ObjectData getObjectOfLatestVersion(CmsCmisCallContext context, java.lang.String objectId, java.lang.String versionSeriesId, boolean major, java.lang.String filter, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, boolean includePolicyIds, boolean includeAcl)
Gets the object of the latest version.- Parameters:
context
- the call contextobjectId
- the object idversionSeriesId
- the version series idmajor
- flag to get the latest major versionfilter
- the property filterincludeAllowableActions
- flag to include allowable actionsincludeRelationships
- flag to include relationshipsrenditionFilter
- filter string for renditionsincludePolicyIds
- flag to include policiesincludeAcl
- flag to include ACLs- Returns:
- the data for the latest version
-
getObjectParents
java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectParentData> getObjectParents(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter, boolean includeAllowableActions, boolean includeRelativePathSegment)
Gets the parents of an object.- Parameters:
context
- the call contextobjectId
- the object idfilter
-includeAllowableActions
-includeRelativePathSegment
-- Returns:
- the data for the object parents
-
getObjectRelationships
org.apache.chemistry.opencmis.commons.data.ObjectList getObjectRelationships(CmsCmisCallContext context, java.lang.String objectId, boolean includeSubRelationshipTypes, org.apache.chemistry.opencmis.commons.enums.RelationshipDirection relationshipDirection, java.lang.String typeId, java.lang.String filter, boolean includeAllowableActions, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the relationships for an object.- Parameters:
context
- the call contextobjectId
- the object idincludeSubRelationshipTypes
- flag to include relationship subtypesrelationshipDirection
- the direction for the relationstypeId
- the relation type idfilter
- the property filterincludeAllowableActions
- flag to include allowable actionsmaxItems
- the maximum number of items to returnskipCount
- the number of items to skip- Returns:
- the relationships for the object
-
getProperties
org.apache.chemistry.opencmis.commons.data.Properties getProperties(CmsCmisCallContext context, java.lang.String objectId, java.lang.String filter)
Gets the properties for a CMIS object.- Parameters:
context
- the call contextobjectId
- the CMIS object idfilter
- the property filter string- Returns:
- the set of properties
-
getPropertiesOfLatestVersion
org.apache.chemistry.opencmis.commons.data.Properties getPropertiesOfLatestVersion(CmsCmisCallContext context, java.lang.String objectId, java.lang.String versionSeriesId, boolean major, java.lang.String filter)
Gets the properties of the latest version.- Parameters:
context
- the call contextobjectId
- the object idversionSeriesId
- the version series idmajor
- flag to access the latest major versionfilter
- the property filter string- Returns:
- the properties from the latest version
-
getRenditions
java.util.List<org.apache.chemistry.opencmis.commons.data.RenditionData> getRenditions(CmsCmisCallContext context, java.lang.String objectId, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the renditions for a CMIS object.- Parameters:
context
- the call contextobjectId
- the object idrenditionFilter
- the rendition filtermaxItems
- the maximum number of renditionsskipCount
- the number of renditions to skip- Returns:
- the list of renditions
-
getRepositoryInfo
org.apache.chemistry.opencmis.commons.data.RepositoryInfo getRepositoryInfo()
Gets the repository information for this repository.- Returns:
- the repository info
-
getTypeChildren
org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionList getTypeChildren(CmsCmisCallContext context, java.lang.String typeId, boolean includePropertyDefinitions, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Gets the children of a given type.- Parameters:
context
- the call contexttypeId
- the parent type idincludePropertyDefinitions
- flag to include property definitionsmaxItems
- the maximum number of items to returnskipCount
- the number of items to skip- Returns:
- the list of child type definitions
-
getTypeDefinition
org.apache.chemistry.opencmis.commons.definitions.TypeDefinition getTypeDefinition(CmsCmisCallContext context, java.lang.String typeId)
Gets a type definition by id.- Parameters:
context
- the call contexttypeId
- the type id- Returns:
- the type definition for the given id
-
getTypeDescendants
java.util.List<org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer> getTypeDescendants(CmsCmisCallContext context, java.lang.String typeId, java.math.BigInteger depth, boolean includePropertyDefinitions)
Gets the type descendants.- Parameters:
context
- the call contexttypeId
- the parent type iddepth
- the maximum type depthincludePropertyDefinitions
- flag to include the property definitions for types- Returns:
- the list of type definitions
-
moveObject
void moveObject(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, java.lang.String targetFolderId, java.lang.String sourceFolderId)
Moves an object.- Parameters:
context
- the call contextobjectId
- the object idtargetFolderId
- source source folder idsourceFolderId
- the target folder id
-
query
org.apache.chemistry.opencmis.commons.data.ObjectList query(CmsCmisCallContext context, java.lang.String statement, boolean searchAllVersions, boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
Performs a query on the repository.- Parameters:
context
- the call contextstatement
- the querysearchAllVersions
- flag to search all versionsincludeAllowableActions
- flag to include allowable actionsincludeRelationships
- flag to include relationshipsrenditionFilter
- the filter string for renditionsmaxItems
- the maximum number of items to returnskipCount
- the number of items to skip- Returns:
- the query result objects
-
removeObjectFromFolder
void removeObjectFromFolder(CmsCmisCallContext context, java.lang.String objectId, java.lang.String folderId)
Unfiles an object from a folder.- Parameters:
context
- the call contextobjectId
- the id of the object to unfilefolderId
- the folder from which the object should be unfiled
-
removePolicy
void removePolicy(CmsCmisCallContext context, java.lang.String policyId, java.lang.String objectId)
Removes a policy from an object.- Parameters:
context
- the call contextpolicyId
- the policy idobjectId
- the object id
-
setContentStream
void setContentStream(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, boolean overwriteFlag, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeToken, org.apache.chemistry.opencmis.commons.data.ContentStream contentStream)
Sets the content stream of an object.- Parameters:
context
- the call contextobjectId
- the id of the objectoverwriteFlag
- flag to overwrite the content streamchangeToken
- the change tokencontentStream
- the new content stream
-
updateProperties
void updateProperties(CmsCmisCallContext context, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> objectId, org.apache.chemistry.opencmis.commons.spi.Holder<java.lang.String> changeToken, org.apache.chemistry.opencmis.commons.data.Properties properties)
Updates the properties for an object.- Parameters:
context
- the call contextobjectId
- the object idchangeToken
- the change tokenproperties
- the properties
-
-