org.apache.chemistry.opencmis.client.api

Interface AsyncSession

public interface AsyncSession

This interface provides asynchronous CMIS operations.

Method Summary

Modifier and Type	Method and Description
Future<Acl>	applyAcl(ObjectId objectId, List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation) Applies ACL changes to an object and dependent objects.
Future<?>	applyPolicy(ObjectId objectId, ObjectId... policyIds) Applies a set of policies to an object.
Future<ObjectId>	createDocument(Map<String,?> properties, ObjectId folderId, ContentStream contentStream, VersioningState versioningState) Creates a new document.
Future<ObjectId>	createDocument(Map<String,?> properties, ObjectId folderId, ContentStream contentStream, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new document.
Future<ObjectId>	createDocumentFromSource(ObjectId source, Map<String,?> properties, ObjectId folderId, VersioningState versioningState) Creates a new document from a source document.
Future<ObjectId>	createDocumentFromSource(ObjectId source, Map<String,?> properties, ObjectId folderId, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new document from a source document.
Future<ObjectId>	createFolder(Map<String,?> properties, ObjectId folderId) Creates a new folder.
Future<ObjectId>	createFolder(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new folder.
Future<ObjectId>	createItem(Map<String,?> properties, ObjectId folderId) Creates a new item.
Future<ObjectId>	createItem(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new item.
Future<ObjectId>	createPolicy(Map<String,?> properties, ObjectId folderId) Creates a new policy.
Future<ObjectId>	createPolicy(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new policy.
Future<ObjectId>	createRelationship(Map<String,?> properties) Creates a new relationship.
Future<ObjectId>	createRelationship(Map<String,?> properties, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new relationship.
Future<ObjectType>	createType(TypeDefinition type) Creates a new type.
Future<?>	delete(ObjectId objectId) Deletes an object and, if it is a document, all versions in the version series.
Future<?>	delete(ObjectId objectId, boolean allVersions) Deletes an object.
Future<List<String>>	deleteTree(ObjectId folderId, boolean allVersions, UnfileObject unfile, boolean continueOnFailure) Deletes a folder and all subfolders.
Future<?>	deleteType(String typeId) Deletes a type.
Future<ContentStream>	getContentStream(ObjectId docId) Retrieves the main content stream of a document.
Future<ContentStream>	getContentStream(ObjectId docId, String streamId, BigInteger offset, BigInteger length) Retrieves the content stream of a document.
Future<Document>	getLatestDocumentVersion(ObjectId objectId) Returns the latest version in a version series.
Future<Document>	getLatestDocumentVersion(ObjectId objectId, boolean major, OperationContext context) Returns the latest version in a version series.
Future<Document>	getLatestDocumentVersion(ObjectId objectId, OperationContext context) Returns the latest version in a version series.
Future<Document>	getLatestDocumentVersion(String objectId) /** Returns the latest version in a version series.
Future<Document>	getLatestDocumentVersion(String objectId, boolean major, OperationContext context) Returns the latest version in a version series.
Future<Document>	getLatestDocumentVersion(String objectId, OperationContext context) Returns the latest version in a version series.
Future<CmisObject>	getObject(ObjectId objectId) Returns a CMIS object from the session cache.
Future<CmisObject>	getObject(ObjectId objectId, OperationContext context) Returns a CMIS object from the session cache.
Future<CmisObject>	getObject(String objectId) Returns a CMIS object from the session cache.
Future<CmisObject>	getObject(String objectId, OperationContext context) Returns a CMIS object from the session cache.
Future<CmisObject>	getObjectByPath(String path) Returns a CMIS object from the session cache.
Future<CmisObject>	getObjectByPath(String path, OperationContext context) Returns a CMIS object from the session cache.
Future<CmisObject>	getObjectByPath(String parentPath, String name) Returns a CMIS object from the session cache.
Future<CmisObject>	getObjectByPath(String parentPath, String name, OperationContext context) Returns a CMIS object from the session cache.
Session	getSession() Returns the session object.
Future<ObjectType>	getTypeDefinition(String typeId) Gets the definition of a type.
Future<?>	removePolicy(ObjectId objectId, ObjectId... policyIds) Removes a set of policies from an object.
Future<Acl>	setAcl(ObjectId objectId, List<Ace> aces) Removes the direct ACEs of an object and sets the provided ACEs.
Future<ContentStream>	storeContentStream(ObjectId docId, OutputStream target) Reads the document content and writes it to an output stream.
Future<ContentStream>	storeContentStream(ObjectId docId, String streamId, BigInteger offset, BigInteger length, OutputStream target) Reads the document content and writes it to an output stream.
Future<ObjectType>	updateType(TypeDefinition type) Updates an existing type.

Method Detail

getSession

Session getSession()

Returns the session object.

Returns:

the session object, not null

getTypeDefinition

Future<ObjectType> getTypeDefinition(String typeId)

Gets the definition of a type.

Parameters:

typeId - the ID of the type

Returns:

the type definition

Throws:

CmisObjectNotFoundException - if a type with the given type ID doesn't exist

CMIS:

1.0

createType

Future<ObjectType> createType(TypeDefinition type)

Creates a new type.

Parameters:

type - the type definition

Returns:

the new type definition

CMIS:

1.1

updateType

Future<ObjectType> updateType(TypeDefinition type)

Updates an existing type.

Parameters:

type - the type definition updates

Returns:

the updated type definition

CMIS:

1.1

deleteType

Future<?> deleteType(String typeId)

Deletes a type.

Parameters:

typeId - the ID of the type to delete

CMIS:

1.1

getObject

Future<CmisObject> getObject(ObjectId objectId)

Returns a CMIS object from the session cache. If the object is not in the cache or the cache is turned off per default OperationContext, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

objectId - the object ID

Returns:

the requested object

CMIS:

1.0

getObject

Future<CmisObject> getObject(ObjectId objectId,
                             OperationContext context)

Returns a CMIS object from the session cache. If the object is not in the cache or the given OperationContext has caching turned off, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

objectId - the object ID

context - the OperationContext to use

Returns:

the requested object

CMIS:

1.0

getObject

Future<CmisObject> getObject(String objectId)

Returns a CMIS object from the session cache. If the object is not in the cache or the cache is turned off per default OperationContext, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

objectId - the object ID

Returns:

the requested object

CMIS:

1.0

getObject

Future<CmisObject> getObject(String objectId,
                             OperationContext context)

Returns a CMIS object from the session cache. If the object is not in the cache or the given OperationContext has caching turned off, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

objectId - the object ID

context - the OperationContext to use

Returns:

the requested object

CMIS:

1.0

getObjectByPath

Future<CmisObject> getObjectByPath(String path)

Returns a CMIS object from the session cache. If the object is not in the cache or the cache is turned off per default OperationContext, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

path - the object path

CMIS:

1.0

getObjectByPath

Future<CmisObject> getObjectByPath(String path,
                                   OperationContext context)

Returns a CMIS object from the session cache. If the object is not in the cache or the given OperationContext has caching turned off, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

path - the object path

context - the OperationContext to use

Returns:

the requested object

CMIS:

1.0

getObjectByPath

Future<CmisObject> getObjectByPath(String parentPath,
                                   String name)

Returns a CMIS object from the session cache. If the object is not in the cache or the cache is turned off per default OperationContext, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

parentPath - the path of the parent folder

name - the (path segment) name of the object in the folder

Returns:

the requested object

CMIS:

1.0

getObjectByPath

Future<CmisObject> getObjectByPath(String parentPath,
                                   String name,
                                   OperationContext context)

Returns a CMIS object from the session cache. If the object is not in the cache or the given OperationContext has caching turned off, it will load the object from the repository and puts it into the cache.

This method might return a stale object if the object has been found in the cache and has been changed in or removed from the repository. Use CmisObject.refresh() and CmisObject.refreshIfOld(long) to update the object if necessary.

Parameters:

parentPath - the path of the parent folder

name - the (path segment) name of the object in the folder

context - the OperationContext to use

Returns:

the requested object

CMIS:

1.0

getLatestDocumentVersion

Future<Document> getLatestDocumentVersion(ObjectId objectId)

Returns the latest version in a version series.

Parameters:

objectId - the document ID of an arbitrary version in the version series

Returns:

the latest document version

CMIS:

1.0

getLatestDocumentVersion

Future<Document> getLatestDocumentVersion(ObjectId objectId,
                                          OperationContext context)

Returns the latest version in a version series.

Parameters:

objectId - the document ID of an arbitrary version in the version series

context - the OperationContext to use

Returns:

the latest document version

CMIS:

1.0

getLatestDocumentVersion

Future<Document> getLatestDocumentVersion(ObjectId objectId,
                                          boolean major,
                                          OperationContext context)

Returns the latest version in a version series.

Parameters:

objectId - the document ID of an arbitrary version in the version series

major - if true the latest major version will be returned, otherwise the very last version will be returned

context - the OperationContext to use

Returns:

the latest document version

CMIS:

1.0

getLatestDocumentVersion

Future<Document> getLatestDocumentVersion(String objectId)

/** Returns the latest version in a version series.

Parameters:

objectId - the document ID of an arbitrary version in the version series

Returns:

the latest document version

CMIS:

1.0

getLatestDocumentVersion

Future<Document> getLatestDocumentVersion(String objectId,
                                          OperationContext context)

Returns the latest version in a version series.

Parameters:

objectId - the document ID of an arbitrary version in the version series

context - the OperationContext to use

Returns:

the latest document version

CMIS:

1.0

getLatestDocumentVersion

Future<Document> getLatestDocumentVersion(String objectId,
                                          boolean major,
                                          OperationContext context)

Returns the latest version in a version series.

Parameters:

objectId - the document ID of an arbitrary version in the version series

major - if true the latest major version will be returned, otherwise the very last version will be returned

context - the OperationContext to use

Returns:

the latest document version

CMIS:

1.0

createDocument

Future<ObjectId> createDocument(Map<String,?> properties,
                                ObjectId folderId,
                                ContentStream contentStream,
                                VersioningState versioningState,
                                List<Policy> policies,
                                List<Ace> addAces,
                                List<Ace> removeAces)

Creates a new document. The stream in contentStream is consumed but not closed by this method.

Returns:

the object ID of the new document

CMIS:

1.0

createDocument

Future<ObjectId> createDocument(Map<String,?> properties,
                                ObjectId folderId,
                                ContentStream contentStream,
                                VersioningState versioningState)

Creates a new document. The stream in contentStream is consumed but not closed by this method.

Returns:

the object ID of the new document

CMIS:

1.0

createDocumentFromSource

Future<ObjectId> createDocumentFromSource(ObjectId source,
                                          Map<String,?> properties,
                                          ObjectId folderId,
                                          VersioningState versioningState,
                                          List<Policy> policies,
                                          List<Ace> addAces,
                                          List<Ace> removeAces)

Creates a new document from a source document.

Returns:

the object ID of the new document

CMIS:

1.0

createDocumentFromSource

Future<ObjectId> createDocumentFromSource(ObjectId source,
                                          Map<String,?> properties,
                                          ObjectId folderId,
                                          VersioningState versioningState)

Creates a new document from a source document.

Returns:

the object ID of the new document

CMIS:

1.0

createFolder

Future<ObjectId> createFolder(Map<String,?> properties,
                              ObjectId folderId,
                              List<Policy> policies,
                              List<Ace> addAces,
                              List<Ace> removeAces)

Creates a new folder.

Returns:

the object ID of the new folder

CMIS:

1.0

createFolder

Future<ObjectId> createFolder(Map<String,?> properties,
                              ObjectId folderId)

Creates a new folder.

Returns:

the object ID of the new folder

CMIS:

1.0

createPolicy

Future<ObjectId> createPolicy(Map<String,?> properties,
                              ObjectId folderId,
                              List<Policy> policies,
                              List<Ace> addAces,
                              List<Ace> removeAces)

Creates a new policy.

Returns:

the object ID of the new policy

CMIS:

1.0

createPolicy

Future<ObjectId> createPolicy(Map<String,?> properties,
                              ObjectId folderId)

Creates a new policy.

Returns:

the object ID of the new policy

CMIS:

1.0

createItem

Future<ObjectId> createItem(Map<String,?> properties,
                            ObjectId folderId,
                            List<Policy> policies,
                            List<Ace> addAces,
                            List<Ace> removeAces)

Creates a new item.

Returns:

the object ID of the new policy

CMIS:

1.1

createItem

Future<ObjectId> createItem(Map<String,?> properties,
                            ObjectId folderId)

Creates a new item.

Returns:

the object ID of the new item

CMIS:

1.1

createRelationship

Future<ObjectId> createRelationship(Map<String,?> properties,
                                    List<Policy> policies,
                                    List<Ace> addAces,
                                    List<Ace> removeAces)

Creates a new relationship.

Returns:

the object ID of the new relationship

CMIS:

1.0

createRelationship

Future<ObjectId> createRelationship(Map<String,?> properties)

Creates a new relationship.

Returns:

the object ID of the new relationship

CMIS:

1.0

getContentStream

Future<ContentStream> getContentStream(ObjectId docId,
                                       String streamId,
                                       BigInteger offset,
                                       BigInteger length)

Retrieves the content stream of a document.

Parameters:

docId - the ID of the document

streamId - the stream ID

offset - the offset of the stream or null to read the stream from the beginning

length - the maximum length of the stream or null to read to the end of the stream

Returns:

the content stream or null if the document has no content stream

CMIS:

1.0

getContentStream

Future<ContentStream> getContentStream(ObjectId docId)

Retrieves the main content stream of a document.

Parameters:

docId - the ID of the document

Returns:

the content stream or null if the document has no content stream

CMIS:

1.0

storeContentStream

Future<ContentStream> storeContentStream(ObjectId docId,
                                         String streamId,
                                         BigInteger offset,
                                         BigInteger length,
                                         OutputStream target)

Reads the document content and writes it to an output stream. The output stream is not closed.

Parameters:

docId - the ID of the document

streamId - the stream ID

offset - the offset of the stream or null to read the stream from the beginning

length - the maximum length of the stream or null to read to the end of the stream

Returns:

the content stream object (the input stream is closed) or null if the document has no content stream

CMIS:

1.0

storeContentStream

Future<ContentStream> storeContentStream(ObjectId docId,
                                         OutputStream target)

Reads the document content and writes it to an output stream. The output stream is not closed.

Parameters:

docId - the ID of the document

Returns:

the content stream object (the input stream is closed) or null if the document has no content stream

CMIS:

1.0

delete

Future<?> delete(ObjectId objectId,
                 boolean allVersions)

Deletes an object.

Parameters:

objectId - the ID of the object

allVersions - if this object is a document this parameter defines if only this version or all versions should be deleted

CMIS:

1.0

delete

Future<?> delete(ObjectId objectId)

Deletes an object and, if it is a document, all versions in the version series.

Parameters:

objectId - the ID of the object

CMIS:

1.0

deleteTree

Future<List<String>> deleteTree(ObjectId folderId,
                                boolean allVersions,
                                UnfileObject unfile,
                                boolean continueOnFailure)

Deletes a folder and all subfolders.

Parameters:

folderId - the ID of the folder

allVersions - if this object is a document this parameter defines if only this version or all versions should be deleted

unfile - defines how objects should be unfiled

continueOnFailure - if true the repository tries to delete as many objects as possible; if false the repository stops at the first object that could not be deleted

Returns:

a list of object IDs which failed to be deleted

CMIS:

1.0

applyAcl

Future<Acl> applyAcl(ObjectId objectId,
                     List<Ace> addAces,
                     List<Ace> removeAces,
                     AclPropagation aclPropagation)

Applies ACL changes to an object and dependent objects. Only direct ACEs can be added and removed.

Parameters:

objectId - the ID the object

addAces - list of ACEs to be added or null if no ACEs should be added

removeAces - list of ACEs to be removed or null if no ACEs should be removed

aclPropagation - value that defines the propagation of the ACE changes; null is equal to AclPropagation.REPOSITORYDETERMINED

Returns:

the new ACL of the object

CMIS:

1.0

setAcl

Future<Acl> setAcl(ObjectId objectId,
                   List<Ace> aces)

Removes the direct ACEs of an object and sets the provided ACEs. The changes are local to the given object and are not propagated to dependent objects.

Parameters:

objectId - the ID the object

aces - list of ACEs to be set

Returns:

the new ACL of the object

CMIS:

1.0

applyPolicy

Future<?> applyPolicy(ObjectId objectId,
                      ObjectId... policyIds)

Applies a set of policies to an object. This operation is not atomic. If it fails some policies might already be applied.

Parameters:

objectId - the ID the object

policyIds - the IDs of the policies to be applied

CMIS:

1.0

removePolicy

Future<?> removePolicy(ObjectId objectId,
                       ObjectId... policyIds)

Removes a set of policies from an object. This operation is not atomic. If it fails some policies might already be removed.

Parameters:

objectId - the ID the object

policyIds - the IDs of the policies to be removed

CMIS:

1.0