public abstract class FilterCmisService extends org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisService implements Serializable
| Constructor and Description |
|---|
FilterCmisService() |
| Modifier and Type | Method and Description |
|---|---|
void |
addObjectToFolder(String repositoryId,
String objectId,
String folderId,
Boolean allVersions,
ExtensionsData extension)
Adds an existing fileable non-folder object to a folder.
|
Acl |
applyAcl(String repositoryId,
String objectId,
Acl addAces,
Acl removeAces,
AclPropagation aclPropagation,
ExtensionsData extension)
Adds or removes the given ACEs to or from the ACL of the object.
|
Acl |
applyAcl(String repositoryId,
String objectId,
Acl aces,
AclPropagation aclPropagation)
Applies a new ACL to an object.
|
void |
applyPolicy(String repositoryId,
String policyId,
String objectId,
ExtensionsData extension)
Applies a specified policy to an object.
|
void |
cancelCheckOut(String repositoryId,
String objectId,
ExtensionsData extension)
Reverses the effect of a check-out.
|
void |
checkIn(String repositoryId,
Holder<String> objectId,
Boolean major,
Properties properties,
ContentStream contentStream,
String checkinComment,
List<String> policies,
Acl addAces,
Acl removeAces,
ExtensionsData extension)
Checks-in the private working copy (PWC) document.
|
void |
checkOut(String repositoryId,
Holder<String> objectId,
ExtensionsData extension,
Holder<Boolean> contentCopied)
Create a private working copy of the document.
|
void |
close()
Signals that this object will not be used anymore and resources can
released.
|
String |
create(String repositoryId,
Properties properties,
String folderId,
ContentStream contentStream,
VersioningState versioningState,
List<String> policies,
ExtensionsData extension)
Creates a new document, folder or policy.
|
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.
|
String |
createPolicy(String repositoryId,
Properties properties,
String folderId,
List<String> policies,
Acl addAces,
Acl removeAces,
ExtensionsData extension)
Creates a policy object of the specified type (given by the
cmis:objectTypeId property).
|
String |
createRelationship(String repositoryId,
Properties properties,
List<String> policies,
Acl addAces,
Acl removeAces,
ExtensionsData extension)
Creates a relationship object of the specified type (given by the
cmis:objectTypeId property).
|
void |
deleteContentStream(String repositoryId,
Holder<String> objectId,
Holder<String> changeToken,
ExtensionsData extension)
Deletes the content stream for the specified document object.
|
void |
deleteObject(String repositoryId,
String objectId,
Boolean allVersions,
ExtensionsData extension)
Deletes the specified 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.
|
abstract AclService |
getAclService()
Returns a client ACL service.
|
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.
|
List<ObjectData> |
getAppliedPolicies(String repositoryId,
String objectId,
String filter,
ExtensionsData extension)
Gets the list of policies currently applied to the specified object.
|
CallContext |
getCallContext()
Returns the current 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.
|
ObjectList |
getContentChanges(String repositoryId,
Holder<String> changeLogToken,
Boolean includeProperties,
String filter,
Boolean includePolicyIds,
Boolean includeAcl,
BigInteger maxItems,
ExtensionsData extension)
Gets a list of content changes.
|
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.
|
abstract DiscoveryService |
getDiscoveryService()
Returns a client discovery service.
|
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.
|
abstract MultiFilingService |
getMultiFilingService()
Returns a client multifiling service.
|
abstract NavigationService |
getNavigationService()
Returns a client navigation service.
|
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.
|
ObjectInfo |
getObjectInfo(String repositoryId,
String objectId)
Returns the
ObjectInfo of the given object id or
null if no object info exists. |
protected ObjectInfo |
getObjectInfoIntern(String repositoryId,
ObjectData object)
Collects the
ObjectInfo about an object. |
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.
|
ObjectList |
getObjectRelationships(String repositoryId,
String objectId,
Boolean includeSubRelationshipTypes,
RelationshipDirection relationshipDirection,
String typeId,
String filter,
Boolean includeAllowableActions,
BigInteger maxItems,
BigInteger skipCount,
ExtensionsData extension)
Gets all or a subset of relationships associated with an independent
object.
|
abstract ObjectService |
getObjectService()
Returns a client object service.
|
abstract PolicyService |
getPolicyService()
Returns a client policy service.
|
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.
|
abstract RelationshipService |
getRelationshipService()
Returns a client relationship service.
|
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.
|
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.
|
abstract RepositoryService |
getRepositoryService()
Returns a client repository service.
|
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.
|
abstract VersioningService |
getVersioningService()
Returns a client versioning service.
|
void |
init(Map<String,String> parameters)
Called after the object has been created.
|
void |
moveObject(String repositoryId,
Holder<String> objectId,
String targetFolderId,
String sourceFolderId,
ExtensionsData extension)
Moves the specified file-able object from one folder to another.
|
ObjectList |
query(String repositoryId,
String statement,
Boolean searchAllVersions,
Boolean includeAllowableActions,
IncludeRelationships includeRelationships,
String renditionFilter,
BigInteger maxItems,
BigInteger skipCount,
ExtensionsData extension)
Executes a CMIS query statement against the contents of the repository.
|
void |
removeObjectFromFolder(String repositoryId,
String objectId,
String folderId,
ExtensionsData extension)
Removes an existing fileable non-folder object from a folder.
|
void |
removePolicy(String repositoryId,
String policyId,
String objectId,
ExtensionsData extension)
Removes a specified policy from an object.
|
void |
setCallContext(CallContext context)
Called at the beginning of a request.
|
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.
|
public void init(Map<String,String> parameters)
parameters - the parameters provided to bridge service factorylock - a lock object shared by all service instancespublic void setCallContext(CallContext context)
public CallContext getCallContext()
public abstract RepositoryService getRepositoryService()
public abstract NavigationService getNavigationService()
public abstract ObjectService getObjectService()
public abstract VersioningService getVersioningService()
public abstract DiscoveryService getDiscoveryService()
public abstract MultiFilingService getMultiFilingService()
public abstract RelationshipService getRelationshipService()
public abstract AclService getAclService()
public abstract PolicyService getPolicyService()
public RepositoryInfo getRepositoryInfo(String repositoryId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getRepositoryInfo in interface RepositoryServicegetRepositoryInfo in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorypublic List<RepositoryInfo> getRepositoryInfos(ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getRepositoryInfos in interface RepositoryServicegetRepositoryInfos in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic TypeDefinitionList getTypeChildren(String repositoryId, String typeId, Boolean includePropertyDefinitions, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getTypeChildren in interface RepositoryServicegetTypeChildren in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorytypeId - (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)public List<TypeDefinitionContainer> getTypeDescendants(String repositoryId, String typeId, BigInteger depth, Boolean includePropertyDefinitions, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getTypeDescendants in interface RepositoryServicegetTypeDescendants in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorytypeId - (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)public TypeDefinition getTypeDefinition(String repositoryId, String typeId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getTypeDefinition in interface RepositoryServicegetTypeDefinition in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorytypeId - typeId of an object type specified in the repositorypublic ObjectInFolderList getChildren(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getChildren in interface NavigationServicegetChildren in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryfolderId - the identifier for the folderfilter - (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)public List<ObjectInFolderContainer> getDescendants(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getDescendants in interface NavigationServicegetDescendants in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryfolderId - the identifier for the folderdepth - the number of levels of depth in the folder hierarchy from
which to return resultsfilter - (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)public List<ObjectInFolderContainer> getFolderTree(String repositoryId, String folderId, BigInteger depth, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePathSegment, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getFolderTree in interface NavigationServicegetFolderTree in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryfolderId - the identifier for the folderdepth - the number of levels of depth in the folder hierarchy from
which to return resultsfilter - (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)public List<ObjectParentData> getObjectParents(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includeRelativePathSegment, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getObjectParents in interface NavigationServicegetObjectParents in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectfilter - (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)public ObjectData getFolderParent(String repositoryId, String folderId, String filter, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getFolderParent in interface NavigationServicegetFolderParent in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryfolderId - the identifier for the folderfilter - (optional) a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)public ObjectList getCheckedOutDocs(String repositoryId, String folderId, String filter, String orderBy, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getCheckedOutDocs in interface NavigationServicegetCheckedOutDocs in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryfolderId - the identifier for the folderfilter - (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)public String create(String repositoryId, Properties properties, String folderId, ContentStream contentStream, VersioningState versioningState, List<String> policies, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
create in interface CmisServicecreate in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryproperties - the property values that MUST be applied to the newly created
objectfolderId - (optional) if specified, the identifier for the
folder that MUST be the parent folder for the newly created
objectcontentStream - (optional) if the object to create is a document
object, the content stream that MUST be stored for the newly
created document objectversioningState - (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 objectpublic String createDocument(String repositoryId, Properties properties, String folderId, ContentStream contentStream, VersioningState versioningState, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicecontentStream is consumed but not closed by
this method.
Implementation Hints:
createDocument in interface ObjectServicecreateDocument in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryproperties - the property values that must be applied to the newly created
document objectfolderId - (optional) if specified, the identifier for the
folder that must be the parent folder for the newly created
document objectcontentStream - (optional) the content stream that must be stored for
the newly created document objectversioningState - (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 objectaddAces - (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 specifiedremoveAces - (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 specifiedpublic String createDocumentFromSource(String repositoryId, String sourceId, Properties properties, String folderId, VersioningState versioningState, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
createDocumentFromSource in interface ObjectServicecreateDocumentFromSource in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorysourceId - the identifier for the source documentproperties - the property values that must be applied to the newly created
document objectfolderId - (optional) if specified, the identifier for the
folder that must be the parent folder for the newly created
document objectversioningState - (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 objectaddAces - (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 specifiedremoveAces - (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 specifiedpublic String createFolder(String repositoryId, Properties properties, String folderId, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
createFolder in interface ObjectServicecreateFolder in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryproperties - the property values that must be applied to the newly created
folder objectfolderId - the identifier for the parent folderpolicies - (optional) a list of policy IDs that must be applied
to the newly created folder objectaddAces - (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 specifiedremoveAces - (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 specifiedpublic String createRelationship(String repositoryId, Properties properties, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
createRelationship in interface ObjectServicecreateRelationship in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryproperties - the property values that must be applied to the newly created
relationship objectpolicies - (optional) a list of policy IDs that must be applied
to the newly created relationship objectaddAces - (optional) a list of ACEs that must be added to the
newly created relationship object, either using the ACL from
folderId if specified, or being applied if no
folderId is specifiedremoveAces - (optional) a list of ACEs that must be removed from
the newly created relationship object, either using the ACL
from folderId if specified, or being ignored if
no folderId is specifiedpublic String createPolicy(String repositoryId, Properties properties, String folderId, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
createPolicy in interface ObjectServicecreatePolicy in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryproperties - the property values that must be applied to the newly created
policy objectfolderId - (optional) if specified, the identifier for the
folder that must be the parent folder for the newly created
policy objectpolicies - (optional) a list of policy IDs that must be applied
to the newly created policy objectaddAces - (optional) a list of ACEs that must be added to the
newly created policy object, either using the ACL from
folderId if specified, or being applied if no
folderId is specifiedremoveAces - (optional) a list of ACEs that must be removed from
the newly created policy object, either using the ACL from
folderId if specified, or being ignored if no
folderId is specifiedpublic AllowableActions getAllowableActions(String repositoryId, String objectId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getAllowableActions in interface ObjectServicegetAllowableActions in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectpublic ObjectData getObject(String repositoryId, String objectId, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getObject in interface ObjectServicegetObject in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectfilter - (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)public Properties getProperties(String repositoryId, String objectId, String filter, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getProperties in interface ObjectServicegetProperties in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectfilter - (optional) a comma-separated list of query names that
defines which properties must be returned by the repository
(default is repository specific)public List<RenditionData> getRenditions(String repositoryId, String objectId, String renditionFilter, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getRenditions in interface ObjectServicegetRenditions in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectrenditionFilter - (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)public ObjectData getObjectByPath(String repositoryId, String path, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getObjectByPath in interface ObjectServicegetObjectByPath in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorypath - the path to the objectfilter - (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)public ContentStream getContentStream(String repositoryId, String objectId, String streamId, BigInteger offset, BigInteger length, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getContentStream in interface ObjectServicegetContentStream in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectpublic void updateProperties(String repositoryId, Holder<String> objectId, Holder<String> changeToken, Properties properties, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
updateProperties in interface ObjectServiceupdateProperties in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the object. The repository might return a
different/new object idchangeToken - (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 objectpublic void moveObject(String repositoryId, Holder<String> objectId, String targetFolderId, String sourceFolderId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
moveObject in interface ObjectServicemoveObject in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the object. The repository might return a
different/new object idtargetFolderId - the identifier for the target foldersourceFolderId - the identifier for the source folderpublic void deleteObject(String repositoryId, String objectId, Boolean allVersions, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
deleteObject in interface ObjectServicedeleteObject in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectallVersions - (optional) If true then delete all
versions of the document, otherwise delete only the document
object specified (default is true)public void deleteObjectOrCancelCheckOut(String repositoryId, String objectId, Boolean allVersions, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
deleteObjectOrCancelCheckOut in interface CmisServicedeleteObjectOrCancelCheckOut in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectallVersions - (optional) If true then delete all
versions of the document, otherwise delete only the document
object specified (default is true)public FailedToDeleteData deleteTree(String repositoryId, String folderId, Boolean allVersions, UnfileObject unfileObjects, Boolean continueOnFailure, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
deleteTree in interface ObjectServicedeleteTree in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryfolderId - the identifier for the folderallVersions - (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)public void setContentStream(String repositoryId, Holder<String> objectId, Boolean overwriteFlag, Holder<String> changeToken, ContentStream contentStream, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicecontentStream is consumed but not closed by
this method.
Implementation Hints:
setContentStream in interface ObjectServicesetContentStream in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the object. The repository might return a
different/new object idoverwriteFlag - (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 streampublic void deleteContentStream(String repositoryId, Holder<String> objectId, Holder<String> changeToken, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
deleteContentStream in interface ObjectServicedeleteContentStream in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the object. The repository might return a
different/new object idchangeToken - (optional) the last change token of this object that
the client received. The repository might return a new change
token (default is null)public void checkOut(String repositoryId, Holder<String> objectId, ExtensionsData extension, Holder<Boolean> contentCopied)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
checkOut in interface VersioningServicecheckOut in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorypublic void cancelCheckOut(String repositoryId, String objectId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
cancelCheckOut in interface VersioningServicecancelCheckOut in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorypublic void checkIn(String repositoryId, Holder<String> objectId, Boolean major, Properties properties, ContentStream contentStream, String checkinComment, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicecontentStream is consumed but not closed by
this method.
Implementation Hints:
checkIn in interface VersioningServicecheckIn in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorypublic ObjectData getObjectOfLatestVersion(String repositoryId, String objectId, String versionSeriesId, Boolean major, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getObjectOfLatestVersion in interface VersioningServicegetObjectOfLatestVersion in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorypublic Properties getPropertiesOfLatestVersion(String repositoryId, String objectId, String versionSeriesId, Boolean major, String filter, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getPropertiesOfLatestVersion in interface VersioningServicegetPropertiesOfLatestVersion in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositorypublic List<ObjectData> getAllVersions(String repositoryId, String objectId, String versionSeriesId, String filter, Boolean includeAllowableActions, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceobjectId or the versionSeriesId
parameter must be set.
Implementation Hints:
getAllVersions in interface VersioningServicegetAllVersions in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectversionSeriesId - the identifier for the objectfilter - (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)public ObjectList getContentChanges(String repositoryId, Holder<String> changeLogToken, Boolean includeProperties, String filter, Boolean includePolicyIds, Boolean includeAcl, BigInteger maxItems, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getContentChanges in interface DiscoveryServicegetContentChanges in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic ObjectList query(String repositoryId, String statement, Boolean searchAllVersions, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
query in interface DiscoveryServicequery in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic void addObjectToFolder(String repositoryId, String objectId, String folderId, Boolean allVersions, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
addObjectToFolder in interface MultiFilingServiceaddObjectToFolder in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic void removeObjectFromFolder(String repositoryId, String objectId, String folderId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
removeObjectFromFolder in interface MultiFilingServiceremoveObjectFromFolder in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic ObjectList getObjectRelationships(String repositoryId, String objectId, Boolean includeSubRelationshipTypes, RelationshipDirection relationshipDirection, String typeId, String filter, Boolean includeAllowableActions, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getObjectRelationships in interface RelationshipServicegetObjectRelationships in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic Acl applyAcl(String repositoryId, String objectId, Acl addAces, Acl removeAces, AclPropagation aclPropagation, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
applyAcl in interface AclServiceapplyAcl in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectaddAces - (optional) the ACEs to be addedremoveAces - (optional) the ACEs to be removedaclPropagation - (optional) specifies how ACEs should be handled
(default is AclPropagation.REPOSITORYDETERMINED)public Acl applyAcl(String repositoryId, String objectId, Acl aces, AclPropagation aclPropagation)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
applyAcl in interface CmisServiceapplyAcl in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectaces - the ACEs that should replace the current ACL of the objectaclPropagation - (optional) specifies how ACEs should be handled
(default is AclPropagation.REPOSITORYDETERMINED)public Acl getAcl(String repositoryId, String objectId, Boolean onlyBasicPermissions, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getAcl in interface AclServicegetAcl in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectonlyBasicPermissions - (optional) an indicator if only basic permissions
should be returned (default is true)public void applyPolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
applyPolicy in interface PolicyServiceapplyPolicy in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic List<ObjectData> getAppliedPolicies(String repositoryId, String objectId, String filter, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
getAppliedPolicies in interface PolicyServicegetAppliedPolicies in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic void removePolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceImplementation Hints:
removePolicy in interface PolicyServiceremovePolicy in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicepublic ObjectInfo getObjectInfo(String repositoryId, String objectId)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceObjectInfo of the given object id or
null if no object info exists.
Only AtomPub requests will require object infos.
Implementation Hints:
getObjectInfo in interface CmisServicegetObjectInfo in interface ObjectInfoHandlergetObjectInfo in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the identifier for the repositoryobjectId - the identifier for the objectprotected ObjectInfo getObjectInfoIntern(String repositoryId, ObjectData object)
org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceObjectInfo about an object.getObjectInfoIntern in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServicerepositoryId - the repository idobject - the objectpublic void close()
CmisServiceclose in interface CmisServiceclose in class org.apache.chemistry.opencmis.commons.impl.server.AbstractCmisServiceCopyright © 2009-2012 The Apache Software Foundation. All Rights Reserved.