Package | Description |
---|---|
org.apache.chemistry.opencmis.client.api |
The OpenCMIS Client API.
|
org.apache.chemistry.opencmis.tck.impl |
Modifier and Type | Interface and Description |
---|---|
interface |
CmisObject
Base interface for all CMIS objects.
|
interface |
Document
CMIS document interface.
|
interface |
FileableCmisObject
Fileable CMIS object.
|
interface |
Folder
CMIS folder interface.
|
interface |
Item
CMIS item interface.
|
interface |
Policy
CMIS policy interface.
|
interface |
Relationship
CMIS relationship interface.
|
Modifier and Type | Method and Description |
---|---|
ObjectId |
Document.appendContentStream(ContentStream contentStream,
boolean isLastChunk,
boolean refresh)
Appends a content stream to the content stream of the document.
|
ObjectId |
Document.checkIn(boolean major,
Map<String,?> properties,
ContentStream contentStream,
String checkinComment)
If this is a PWC (private working copy) it performs a check in.
|
ObjectId |
Document.checkIn(boolean major,
Map<String,?> properties,
ContentStream contentStream,
String checkinComment,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
If this is a PWC (private working copy) it performs a check in.
|
ObjectId |
Document.checkOut()
Checks out the document and returns the object ID of the PWC (private
working copy).
|
ObjectId |
Session.createDocument(Map<String,?> properties,
ObjectId folderId,
ContentStream contentStream,
VersioningState versioningState)
Creates a new document.
|
ObjectId |
Session.createDocument(Map<String,?> properties,
ObjectId folderId,
ContentStream contentStream,
VersioningState versioningState,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new document.
|
ObjectId |
Session.createDocumentFromSource(ObjectId source,
Map<String,?> properties,
ObjectId folderId,
VersioningState versioningState)
Creates a new document from a source document.
|
ObjectId |
Session.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.
|
ObjectId |
Session.createFolder(Map<String,?> properties,
ObjectId folderId)
Creates a new folder.
|
ObjectId |
Session.createFolder(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new folder.
|
ObjectId |
Session.createItem(Map<String,?> properties,
ObjectId folderId)
Creates a new item.
|
ObjectId |
Session.createItem(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new item.
|
ObjectId |
Session.createObjectId(String id)
Creates an object ID from a String.
|
ObjectId |
Session.createPath(ObjectId startFolderId,
String newPath,
Map<String,?> properties)
Creates a folder path.
|
ObjectId |
Session.createPath(ObjectId startFolderId,
String newPath,
Map<String,?> properties,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a folder path.
|
ObjectId |
Session.createPath(ObjectId startFolderId,
String newPath,
String typeId)
Creates a folder path.
|
ObjectId |
Session.createPath(String newPath,
Map<String,?> properties)
Creates a folder path.
|
ObjectId |
Session.createPath(String newPath,
String typeId)
Creates a folder path.
|
ObjectId |
Session.createPolicy(Map<String,?> properties,
ObjectId folderId)
Creates a new policy.
|
ObjectId |
Session.createPolicy(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new policy.
|
ObjectId |
Session.createRelationship(Map<String,?> properties)
Creates a new relationship.
|
ObjectId |
Session.createRelationship(Map<String,?> properties,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new relationship.
|
ObjectId |
Document.deleteContentStream(boolean refresh)
Removes the current content stream from the document.
|
ObjectId |
RelationshipProperties.getSourceId()
Returns the source ID of this CMIS relationship (CMIS property
cmis:sourceId ). |
ObjectId |
RelationshipProperties.getTargetId()
Returns the target ID of this CMIS relationship (CMIS property
cmis:targetId ). |
ObjectId |
CmisObject.rename(String newName,
boolean refresh)
Renames this object (changes the value of
cmis:name ). |
ObjectId |
Document.setContentStream(ContentStream contentStream,
boolean overwrite,
boolean refresh)
Sets a new content stream for the document.
|
ObjectId |
CmisObject.updateProperties(Map<String,?> properties,
boolean refresh)
Updates the provided properties.
|
ObjectId |
CmisObject.updateProperties(Map<String,?> properties,
List<String> addSecondaryTypeIds,
List<String> removeSecondaryTypeIds,
boolean refresh)
Updates the provided properties.
|
Modifier and Type | Method and Description |
---|---|
Future<ObjectId> |
AsyncSession.createDocument(Map<String,?> properties,
ObjectId folderId,
ContentStream contentStream,
VersioningState versioningState)
Creates a new document.
|
Future<ObjectId> |
AsyncSession.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> |
AsyncSession.createDocumentFromSource(ObjectId source,
Map<String,?> properties,
ObjectId folderId,
VersioningState versioningState)
Creates a new document from a source document.
|
Future<ObjectId> |
AsyncSession.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> |
AsyncSession.createFolder(Map<String,?> properties,
ObjectId folderId)
Creates a new folder.
|
Future<ObjectId> |
AsyncSession.createFolder(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new folder.
|
Future<ObjectId> |
AsyncSession.createItem(Map<String,?> properties,
ObjectId folderId)
Creates a new item.
|
Future<ObjectId> |
AsyncSession.createItem(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new item.
|
Future<ObjectId> |
AsyncSession.createPolicy(Map<String,?> properties,
ObjectId folderId)
Creates a new policy.
|
Future<ObjectId> |
AsyncSession.createPolicy(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new policy.
|
Future<ObjectId> |
AsyncSession.createRelationship(Map<String,?> properties)
Creates a new relationship.
|
Future<ObjectId> |
AsyncSession.createRelationship(Map<String,?> properties,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new relationship.
|
List<ObjectId> |
CmisObject.getPolicyIds()
Returns the applied policy IDs if they have been fetched for this object.
|
Modifier and Type | Method and Description |
---|---|
void |
FileableCmisObject.addToFolder(ObjectId folderId,
boolean allVersions)
Adds this object to a folder.
|
Acl |
Session.applyAcl(ObjectId objectId,
List<Ace> addAces,
List<Ace> removeAces,
AclPropagation aclPropagation)
Applies ACL changes to an object and dependent objects.
|
Future<Acl> |
AsyncSession.applyAcl(ObjectId objectId,
List<Ace> addAces,
List<Ace> removeAces,
AclPropagation aclPropagation)
Applies ACL changes to an object and dependent objects.
|
void |
CmisObject.applyPolicy(ObjectId... policyIds)
Applies the provided policies and refreshes this object afterwards.
|
void |
CmisObject.applyPolicy(ObjectId policyId,
boolean refresh)
Applies the provided policy.
|
void |
Session.applyPolicy(ObjectId objectId,
ObjectId... policyIds)
Applies a set of policies to an object.
|
void |
Session.applyPolicy(ObjectId objectId,
ObjectId... policyIds)
Applies a set of policies to an object.
|
Future<?> |
AsyncSession.applyPolicy(ObjectId objectId,
ObjectId... policyIds)
Applies a set of policies to an object.
|
Future<?> |
AsyncSession.applyPolicy(ObjectId objectId,
ObjectId... policyIds)
Applies a set of policies to an object.
|
Document |
Document.copy(ObjectId targetFolderId)
Creates a copy of this document, including content.
|
Document |
Document.copy(ObjectId targetFolderId,
Map<String,?> properties,
VersioningState versioningState,
List<Policy> policies,
List<Ace> addACEs,
List<Ace> removeACEs,
OperationContext context)
Creates a copy of this document, including content.
|
ObjectId |
Session.createDocument(Map<String,?> properties,
ObjectId folderId,
ContentStream contentStream,
VersioningState versioningState)
Creates a new document.
|
Future<ObjectId> |
AsyncSession.createDocument(Map<String,?> properties,
ObjectId folderId,
ContentStream contentStream,
VersioningState versioningState)
Creates a new document.
|
ObjectId |
Session.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> |
AsyncSession.createDocument(Map<String,?> properties,
ObjectId folderId,
ContentStream contentStream,
VersioningState versioningState,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new document.
|
ObjectId |
Session.createDocumentFromSource(ObjectId source,
Map<String,?> properties,
ObjectId folderId,
VersioningState versioningState)
Creates a new document from a source document.
|
Future<ObjectId> |
AsyncSession.createDocumentFromSource(ObjectId source,
Map<String,?> properties,
ObjectId folderId,
VersioningState versioningState)
Creates a new document from a source document.
|
ObjectId |
Session.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> |
AsyncSession.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.
|
Document |
Folder.createDocumentFromSource(ObjectId source,
Map<String,?> properties,
VersioningState versioningState)
Creates a new document from a source document in this folder.
|
Document |
Folder.createDocumentFromSource(ObjectId source,
Map<String,?> properties,
VersioningState versioningState,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces,
OperationContext context)
Creates a new document from a source document in this folder.
|
ObjectId |
Session.createFolder(Map<String,?> properties,
ObjectId folderId)
Creates a new folder.
|
Future<ObjectId> |
AsyncSession.createFolder(Map<String,?> properties,
ObjectId folderId)
Creates a new folder.
|
ObjectId |
Session.createFolder(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new folder.
|
Future<ObjectId> |
AsyncSession.createFolder(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new folder.
|
ObjectId |
Session.createItem(Map<String,?> properties,
ObjectId folderId)
Creates a new item.
|
Future<ObjectId> |
AsyncSession.createItem(Map<String,?> properties,
ObjectId folderId)
Creates a new item.
|
ObjectId |
Session.createItem(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new item.
|
Future<ObjectId> |
AsyncSession.createItem(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new item.
|
ObjectId |
Session.createPath(ObjectId startFolderId,
String newPath,
Map<String,?> properties)
Creates a folder path.
|
ObjectId |
Session.createPath(ObjectId startFolderId,
String newPath,
Map<String,?> properties,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a folder path.
|
ObjectId |
Session.createPath(ObjectId startFolderId,
String newPath,
String typeId)
Creates a folder path.
|
ObjectId |
Session.createPolicy(Map<String,?> properties,
ObjectId folderId)
Creates a new policy.
|
Future<ObjectId> |
AsyncSession.createPolicy(Map<String,?> properties,
ObjectId folderId)
Creates a new policy.
|
ObjectId |
Session.createPolicy(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new policy.
|
Future<ObjectId> |
AsyncSession.createPolicy(Map<String,?> properties,
ObjectId folderId,
List<Policy> policies,
List<Ace> addAces,
List<Ace> removeAces)
Creates a new policy.
|
void |
Session.delete(ObjectId objectId)
Deletes an object and, if it is a document, all versions in the version
series.
|
Future<?> |
AsyncSession.delete(ObjectId objectId)
Deletes an object and, if it is a document, all versions in the version
series.
|
void |
Session.delete(ObjectId objectId,
boolean allVersions)
Deletes an object.
|
Future<?> |
AsyncSession.delete(ObjectId objectId,
boolean allVersions)
Deletes an object.
|
List<String> |
Session.deleteTree(ObjectId folderId,
boolean allVersions,
UnfileObject unfile,
boolean continueOnFailure)
Deletes a folder and all subfolders.
|
Future<List<String>> |
AsyncSession.deleteTree(ObjectId folderId,
boolean allVersions,
UnfileObject unfile,
boolean continueOnFailure)
Deletes a folder and all subfolders.
|
boolean |
Session.exists(ObjectId objectId)
Checks if an object with given object ID exists in the repository and is
visible for the current user.
|
Acl |
Session.getAcl(ObjectId objectId,
boolean onlyBasicPermissions)
Fetches the ACL of an object from the repository.
|
ContentStream |
Session.getContentStream(ObjectId docId)
Retrieves the main content stream of a document.
|
Future<ContentStream> |
AsyncSession.getContentStream(ObjectId docId)
Retrieves the main content stream of a document.
|
ContentStream |
Session.getContentStream(ObjectId docId,
String streamId,
BigInteger offset,
BigInteger length)
Retrieves the content stream of a document.
|
Future<ContentStream> |
AsyncSession.getContentStream(ObjectId docId,
String streamId,
BigInteger offset,
BigInteger length)
Retrieves the content stream of a document.
|
Document |
Session.getLatestDocumentVersion(ObjectId objectId)
Returns the latest version in a version series.
|
Future<Document> |
AsyncSession.getLatestDocumentVersion(ObjectId objectId)
Returns the latest version in a version series.
|
Document |
Session.getLatestDocumentVersion(ObjectId objectId,
boolean major,
OperationContext context)
Returns the latest version in a version series.
|
Future<Document> |
AsyncSession.getLatestDocumentVersion(ObjectId objectId,
boolean major,
OperationContext context)
Returns the latest version in a version series.
|
Document |
Session.getLatestDocumentVersion(ObjectId objectId,
OperationContext context)
Returns the latest version in a version series.
|
Future<Document> |
AsyncSession.getLatestDocumentVersion(ObjectId objectId,
OperationContext context)
Returns the latest version in a version series.
|
CmisObject |
Session.getObject(ObjectId objectId)
Returns a CMIS object from the session cache.
|
Future<CmisObject> |
AsyncSession.getObject(ObjectId objectId)
Returns a CMIS object from the session cache.
|
CmisObject |
Session.getObject(ObjectId objectId,
OperationContext context)
Returns a CMIS object from the session cache.
|
Future<CmisObject> |
AsyncSession.getObject(ObjectId objectId,
OperationContext context)
Returns a CMIS object from the session cache.
|
ItemIterable<Relationship> |
Session.getRelationships(ObjectId objectId,
boolean includeSubRelationshipTypes,
RelationshipDirection relationshipDirection,
ObjectType type,
OperationContext context)
Fetches the relationships from or to an object from the repository.
|
FileableCmisObject |
FileableCmisObject.move(ObjectId sourceFolderId,
ObjectId targetFolderId)
Moves this object.
|
FileableCmisObject |
FileableCmisObject.move(ObjectId sourceFolderId,
ObjectId targetFolderId,
OperationContext context)
Moves this object.
|
void |
FileableCmisObject.removeFromFolder(ObjectId folderId)
Removes this object from a folder.
|
void |
Session.removeObjectFromCache(ObjectId objectId)
Removes the given object from the cache.
|
void |
CmisObject.removePolicy(ObjectId... policyIds)
Removes the provided policies and refreshes this object afterwards.
|
void |
CmisObject.removePolicy(ObjectId policyId,
boolean refresh)
Removes the provided policy.
|
void |
Session.removePolicy(ObjectId objectId,
ObjectId... policyIds)
Removes a set of policies from an object.
|
void |
Session.removePolicy(ObjectId objectId,
ObjectId... policyIds)
Removes a set of policies from an object.
|
Future<?> |
AsyncSession.removePolicy(ObjectId objectId,
ObjectId... policyIds)
Removes a set of policies from an object.
|
Future<?> |
AsyncSession.removePolicy(ObjectId objectId,
ObjectId... policyIds)
Removes a set of policies from an object.
|
Acl |
Session.setAcl(ObjectId objectId,
List<Ace> aces)
Removes the direct ACEs of an object and sets the provided ACEs.
|
Future<Acl> |
AsyncSession.setAcl(ObjectId objectId,
List<Ace> aces)
Removes the direct ACEs of an object and sets the provided ACEs.
|
void |
QueryStatement.setId(int parameterIndex,
ObjectId... id)
Sets the designated parameter to the given object ID.
|
Future<ContentStream> |
AsyncSession.storeContentStream(ObjectId docId,
OutputStream target)
Reads the document content and writes it to an output stream.
|
Future<ContentStream> |
AsyncSession.storeContentStream(ObjectId docId,
String streamId,
BigInteger offset,
BigInteger length,
OutputStream target)
Reads the document content and writes it to an output stream.
|
Modifier and Type | Method and Description |
---|---|
protected Relationship |
AbstractSessionTest.createRelationship(Session session,
String name,
ObjectId source,
ObjectId target)
Creates a relationship.
|
protected Relationship |
AbstractSessionTest.createRelationship(Session session,
String name,
ObjectId source,
ObjectId target,
String objectTypeId)
Creates a relationship.
|
Copyright © 2009–2017 The Apache Software Foundation. All rights reserved.