org.apache.chemistry.opencmis.client.runtime

Class SessionImpl

java.lang.Object

org.apache.chemistry.opencmis.client.runtime.SessionImpl

All Implemented Interfaces:

Serializable, Session

public class SessionImpl
extends Object
implements Session

Persistent model session.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SessionImpl(Map<String,String> parameters, ObjectFactory objectFactory, AuthenticationProvider authenticationProvider, Cache cache, TypeDefinitionCache typeDefCache) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Acl	applyAcl(ObjectId objectId, List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation) Applies ACL changes to an object and dependent objects.
void	applyPolicy(ObjectId objectId, ObjectId... policyIds) Applies a set of policies to an object.
List<BulkUpdateObjectIdAndChangeToken>	bulkUpdateProperties(List<CmisObject> objects, Map<String,?> properties, List<String> addSecondaryTypeIds, List<String> removeSecondaryTypeIds) Updates multiple objects in one request.
void	clear() Clears all cached data.
void	connect() Connect session object to the provider.
ObjectId	createDocument(Map<String,?> properties, ObjectId folderId, ContentStream contentStream, VersioningState versioningState) Creates a new document.
ObjectId	createDocument(Map<String,?> properties, ObjectId folderId, ContentStream contentStream, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new document.
ObjectId	createDocumentFromSource(ObjectId source, Map<String,?> properties, ObjectId folderId, VersioningState versioningState) Creates a new document from a source document.
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.
ObjectId	createFolder(Map<String,?> properties, ObjectId folderId) Creates a new folder.
ObjectId	createFolder(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new folder.
ObjectId	createItem(Map<String,?> properties, ObjectId folderId) Creates a new item.
ObjectId	createItem(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new item.
ObjectId	createObjectId(String id) Creates an object ID from a String.
OperationContext	createOperationContext() Creates a new operation context object.
OperationContext	createOperationContext(Set<String> filter, boolean includeAcls, boolean includeAllowableActions, boolean includePolicies, IncludeRelationships includeRelationships, Set<String> renditionFilter, boolean includePathSegments, String orderBy, boolean cacheEnabled, int maxItemsPerPage) Creates a new operation context object with the given properties.
ObjectId	createPolicy(Map<String,?> properties, ObjectId folderId) Creates a new policy.
ObjectId	createPolicy(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new policy.
QueryStatement	createQueryStatement(Collection<String> selectPropertyIds, Map<String,String> fromTypes, String whereClause, List<String> orderByPropertyIds) Creates a query statement for a query of one primary type joined by zero or more secondary types.
QueryStatement	createQueryStatement(String statement) Creates a query statement.
ObjectId	createRelationship(Map<String,?> properties) Creates a new relationship.
ObjectId	createRelationship(Map<String,?> properties, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces) Creates a new relationship.
ObjectType	createType(TypeDefinition type) Creates a new type.
void	delete(ObjectId objectId) Deletes an object and, if it is a document, all versions in the version series.
void	delete(ObjectId objectId, boolean allVersions) Deletes an object.
void	deleteType(String typeId) Deletes a type.
Acl	getAcl(ObjectId objectId, boolean onlyBasicPermissions) Fetches the ACL of an object from the repository.
CmisBinding	getBinding() Returns the underlying binding object.
Cache	getCache()
ItemIterable<Document>	getCheckedOutDocs() Returns all checked out documents.
ItemIterable<Document>	getCheckedOutDocs(OperationContext context) Returns all checked out documents with the given OperationContext .
ItemIterable<ChangeEvent>	getContentChanges(String changeLogToken, boolean includeProperties) Returns an iterator of content changes, starting from the given change log token to the latest entry in the change log.
ChangeEvents	getContentChanges(String changeLogToken, boolean includeProperties, long maxNumItems) Returns the content changes.
ChangeEvents	getContentChanges(String changeLogToken, boolean includeProperties, long maxNumItems, OperationContext context) Returns the content changes.
ItemIterable<ChangeEvent>	getContentChanges(String changeLogToken, boolean includeProperties, OperationContext context) Returns an iterator of content changes, starting from the given change log token to the latest entry in the change log.
ContentStream	getContentStream(ObjectId docId) Retrieves the main content stream of a document.
ContentStream	getContentStream(ObjectId docId, String streamId, BigInteger offset, BigInteger length) Retrieves the content stream of a document.
OperationContext	getDefaultContext() Returns the current default operation parameters for filtering, paging and caching.
String	getLatestChangeLogToken() Returns the latest change log token.
Document	getLatestDocumentVersion(ObjectId objectId) Returns the latest version in a version series.
Document	getLatestDocumentVersion(ObjectId objectId, boolean major, OperationContext context) Returns the latest version in a version series.
Document	getLatestDocumentVersion(ObjectId objectId, OperationContext context) Returns the latest version in a version series.
Document	getLatestDocumentVersion(String objectId) /** Returns the latest version in a version series.
Document	getLatestDocumentVersion(String objectId, boolean major, OperationContext context) Returns the latest version in a version series.
Document	getLatestDocumentVersion(String objectId, OperationContext context) Returns the latest version in a version series.
Locale	getLocale() Get the current locale to be used for this session.
CmisObject	getObject(ObjectId objectId) Returns a CMIS object from the session cache.
CmisObject	getObject(ObjectId objectId, OperationContext context) Returns a CMIS object from the session cache.
CmisObject	getObject(String objectId) Returns a CMIS object from the session cache.
CmisObject	getObject(String objectId, OperationContext context) Returns a CMIS object from the session cache.
CmisObject	getObjectByPath(String path) Returns a CMIS object from the session cache.
CmisObject	getObjectByPath(String path, OperationContext context) Returns a CMIS object from the session cache.
ObjectFactory	getObjectFactory() Gets a factory object that provides methods to create the objects used by this API.
ItemIterable<Relationship>	getRelationships(ObjectId objectId, boolean includeSubRelationshipTypes, RelationshipDirection relationshipDirection, ObjectType type, OperationContext context) Fetches the relationships from or to an object from the repository.
String	getRepositoryId() Returns the repository id.
RepositoryInfo	getRepositoryInfo() Returns the repository info of the repository associated with this session.
Folder	getRootFolder() Gets the root folder of the repository.
Folder	getRootFolder(OperationContext context) Gets the root folder of the repository with the given OperationContext.
ItemIterable<ObjectType>	getTypeChildren(String typeId, boolean includePropertyDefinitions) Gets the type children of a type.
ObjectType	getTypeDefinition(String typeId) Gets the definition of a type.
List<Tree<ObjectType>>	getTypeDescendants(String typeId, int depth, boolean includePropertyDefinitions) Gets the type descendants of a type.
ItemIterable<QueryResult>	query(String statement, boolean searchAllVersions) Sends a query to the repository.
ItemIterable<QueryResult>	query(String statement, boolean searchAllVersions, OperationContext context) Sends a query to the repository using the given OperationContext.
ItemIterable<CmisObject>	queryObjects(String typeId, String where, boolean searchAllVersions, OperationContext context) Builds a CMIS query and returns the query results as an iterator of CmisObject objects.
void	removeObjectFromCache(ObjectId objectId) Removes the given object from the cache.
void	removeObjectFromCache(String objectId) Removes the given object from the cache.
void	removePolicy(ObjectId objectId, ObjectId... policyIds) Removes a set of policies from an object.
Acl	setAcl(ObjectId objectId, List<Ace> aces) Removes the direct ACEs of an object and sets the provided ACEs.
void	setDefaultContext(OperationContext context) Sets the current session parameters for filtering, paging and caching.
String	toString()
ObjectType	updateType(TypeDefinition type) Updates an existing type.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionImpl

public SessionImpl(Map<String,String> parameters,
           ObjectFactory objectFactory,
           AuthenticationProvider authenticationProvider,
           Cache cache,
           TypeDefinitionCache typeDefCache)

Constructor.

Method Detail

clear

public void clear()

Description copied from interface: Session

Clears all cached data.

Specified by:

clear in interface Session

getObjectFactory

public ObjectFactory getObjectFactory()

Description copied from interface: Session

Gets a factory object that provides methods to create the objects used by this API.

Specified by:

getObjectFactory in interface Session

Returns:

the repository info, not null

getCheckedOutDocs

public ItemIterable<Document> getCheckedOutDocs()

Description copied from interface: Session

Returns all checked out documents.

Specified by:

getCheckedOutDocs in interface Session

See Also:

Folder.getCheckedOutDocs()

getCheckedOutDocs

public ItemIterable<Document> getCheckedOutDocs(OperationContext context)

Description copied from interface: Session

Returns all checked out documents with the given OperationContext .

Specified by:

getCheckedOutDocs in interface Session

See Also:

Folder.getCheckedOutDocs(OperationContext)

getContentChanges

public ChangeEvents getContentChanges(String changeLogToken,
                             boolean includeProperties,
                             long maxNumItems)

Description copied from interface: Session

Returns the content changes.

Specified by:

getContentChanges in interface Session

Parameters:

changeLogToken - the change log token to start from or null to start from the first available event in the repository

includeProperties - indicates whether changed properties should be included in the result or not

maxNumItems - maximum numbers of events

Returns:

the change events

getContentChanges

public ChangeEvents getContentChanges(String changeLogToken,
                             boolean includeProperties,
                             long maxNumItems,
                             OperationContext context)

Description copied from interface: Session

Returns the content changes.

Specified by:

getContentChanges in interface Session

Parameters:

changeLogToken - the change log token to start from or null to start from the first available event in the repository

includeProperties - indicates whether changed properties should be included in the result or not

maxNumItems - maximum numbers of events

context - the OperationContext

Returns:

the change events

getContentChanges

public ItemIterable<ChangeEvent> getContentChanges(String changeLogToken,
                                          boolean includeProperties)

Description copied from interface: Session

Returns an iterator of content changes, starting from the given change log token to the latest entry in the change log.

Note: Paging and skipping are not supported.

Specified by:

getContentChanges in interface Session

Parameters:

changeLogToken - the change log token to start from or null to start from the first available event in the repository

includeProperties - indicates whether changed properties should be included in the result or not

getContentChanges

public ItemIterable<ChangeEvent> getContentChanges(String changeLogToken,
                                          boolean includeProperties,
                                          OperationContext context)

Description copied from interface: Session

Returns an iterator of content changes, starting from the given change log token to the latest entry in the change log.

Note: Paging and skipping are not supported.

Specified by:

getContentChanges in interface Session

Parameters:

changeLogToken - the change log token to start from or null to start from the first available event in the repository

includeProperties - indicates whether changed properties should be included in the result or not

context - the OperationContext

getLatestChangeLogToken

public String getLatestChangeLogToken()

Description copied from interface: Session

Returns the latest change log token.

In contrast to the repository info, this change log token is not cached. This method requests the token from the repository every single time it is called.

Specified by:

getLatestChangeLogToken in interface Session

Returns:

the latest change log token or null if the repository doesn't provide one

getDefaultContext

public OperationContext getDefaultContext()

Description copied from interface: Session

Returns the current default operation parameters for filtering, paging and caching.

Please note: The returned object is not thread-safe and should only be modified right after the session has been created and before the session object has been used. In order to change the default context in thread-safe manner, create a new OperationContext object and use Session.setDefaultContext(OperationContext) to apply it.

Specified by:

getDefaultContext in interface Session

Returns:

the default operation context, not null

setDefaultContext

public void setDefaultContext(OperationContext context)

Description copied from interface: Session

Sets the current session parameters for filtering, paging and caching.

Specified by:

setDefaultContext in interface Session

Parameters:

context - the OperationContext to be used for the session; if null, a default context is used

createOperationContext

public OperationContext createOperationContext(Set<String> filter,
                                      boolean includeAcls,
                                      boolean includeAllowableActions,
                                      boolean includePolicies,
                                      IncludeRelationships includeRelationships,
                                      Set<String> renditionFilter,
                                      boolean includePathSegments,
                                      String orderBy,
                                      boolean cacheEnabled,
                                      int maxItemsPerPage)

Description copied from interface: Session

Creates a new operation context object with the given properties.

Specified by:

createOperationContext in interface Session

Parameters:

filter - the property filter, a comma separated string of query names or "*" for all properties or null to let the repository determine a set of properties

includeAcls - indicates whether ACLs should be included or not

includeAllowableActions - indicates whether Allowable Actions should be included or not

includePolicies - indicates whether policies should be included or not

includeRelationships - enum that indicates if and which relationships should be includes

renditionFilter - the rendition filter or null for no renditions

includePathSegments - indicates whether path segment or the relative path segment should be included or not

orderBy - the object order, a comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name

cacheEnabled - flag that indicates if the object cache should be used

maxItemsPerPage - the max items per batch

Returns:

the newly created operation context object

See Also:

OperationContext

createOperationContext

public OperationContext createOperationContext()

Description copied from interface: Session

Creates a new operation context object.

Specified by:

createOperationContext in interface Session

Returns:

the newly created operation context object

createObjectId

public ObjectId createObjectId(String id)

Description copied from interface: Session

Creates an object ID from a String.

Specified by:

createObjectId in interface Session

Returns:

the object ID object

getLocale

public Locale getLocale()

Description copied from interface: Session

Get the current locale to be used for this session.

Specified by:

getLocale in interface Session

Returns:

the current locale, may be null

getObject

public CmisObject getObject(ObjectId objectId)

Description copied from interface: Session

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.

Specified by:

getObject in interface Session

Parameters:

objectId - the object ID

Returns:

the requested object

See Also:

Session.getObject(String)

getObject

public CmisObject getObject(ObjectId objectId,
                   OperationContext context)

Description copied from interface: Session

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.

Specified by:

getObject in interface Session

Parameters:

objectId - the object ID

context - the OperationContext to use

Returns:

the requested object

See Also:

Session.getObject(String, OperationContext)

getObject

public CmisObject getObject(String objectId)

Description copied from interface: Session

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.

Specified by:

getObject in interface Session

Parameters:

objectId - the object ID

Returns:

the requested object

See Also:

Session.getObject(ObjectId)

getObject

public CmisObject getObject(String objectId,
                   OperationContext context)

Description copied from interface: Session

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.

Specified by:

getObject in interface Session

Parameters:

objectId - the object ID

context - the OperationContext to use

Returns:

the requested object

See Also:

Session.getObject(ObjectId, OperationContext)

getObjectByPath

public CmisObject getObjectByPath(String path)

Description copied from interface: Session

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.

Specified by:

getObjectByPath in interface Session

Parameters:

path - the object path

Returns:

the requested object

getObjectByPath

public CmisObject getObjectByPath(String path,
                         OperationContext context)

Description copied from interface: Session

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.

Specified by:

getObjectByPath in interface Session

Parameters:

path - the object path

context - the OperationContext to use

Returns:

the requested object

getLatestDocumentVersion

public Document getLatestDocumentVersion(ObjectId objectId)

Description copied from interface: Session

Returns the latest version in a version series.

Specified by:

getLatestDocumentVersion in interface Session

Parameters:

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

Returns:

the latest document version

getLatestDocumentVersion

public Document getLatestDocumentVersion(String objectId,
                                OperationContext context)

Description copied from interface: Session

Returns the latest version in a version series.

Specified by:

getLatestDocumentVersion in interface Session

Parameters:

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

context - the OperationContext to use

Returns:

the latest document version

getLatestDocumentVersion

public Document getLatestDocumentVersion(String objectId,
                                boolean major,
                                OperationContext context)

Description copied from interface: Session

Returns the latest version in a version series.

Specified by:

getLatestDocumentVersion in interface Session

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

getLatestDocumentVersion

public Document getLatestDocumentVersion(String objectId)

Description copied from interface: Session

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

Specified by:

getLatestDocumentVersion in interface Session

Parameters:

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

Returns:

the latest document version

getLatestDocumentVersion

public Document getLatestDocumentVersion(ObjectId objectId,
                                OperationContext context)

Description copied from interface: Session

Returns the latest version in a version series.

Specified by:

getLatestDocumentVersion in interface Session

Parameters:

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

context - the OperationContext to use

Returns:

the latest document version

getLatestDocumentVersion

public Document getLatestDocumentVersion(ObjectId objectId,
                                boolean major,
                                OperationContext context)

Description copied from interface: Session

Returns the latest version in a version series.

Specified by:

getLatestDocumentVersion in interface Session

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

removeObjectFromCache

public void removeObjectFromCache(ObjectId objectId)

Description copied from interface: Session

Removes the given object from the cache.

Specified by:

removeObjectFromCache in interface Session

Parameters:

objectId - object ID

See Also:

Session.removeObjectFromCache(String)

removeObjectFromCache

public void removeObjectFromCache(String objectId)

Description copied from interface: Session

Removes the given object from the cache.

Specified by:

removeObjectFromCache in interface Session

Parameters:

objectId - object ID

getRepositoryInfo

public RepositoryInfo getRepositoryInfo()

Description copied from interface: Session

Returns the repository info of the repository associated with this session.

Specified by:

getRepositoryInfo in interface Session

Returns:

the repository info, not null

getRootFolder

public Folder getRootFolder()

Description copied from interface: Session

Gets the root folder of the repository.

Specified by:

getRootFolder in interface Session

Returns:

the root folder object, not null

getRootFolder

public Folder getRootFolder(OperationContext context)

Description copied from interface: Session

Gets the root folder of the repository with the given OperationContext.

Specified by:

getRootFolder in interface Session

Returns:

the root folder object, not null

getTypeChildren

public ItemIterable<ObjectType> getTypeChildren(String typeId,
                                       boolean includePropertyDefinitions)

Description copied from interface: Session

Gets the type children of a type.

Specified by:

getTypeChildren in interface Session

Parameters:

typeId - the type ID or null to request the base types

includePropertyDefinitions - indicates whether the property definitions should be included or not

Returns:

the type iterator, not null

getTypeDefinition

public ObjectType getTypeDefinition(String typeId)

Description copied from interface: Session

Gets the definition of a type.

Specified by:

getTypeDefinition in interface Session

Parameters:

typeId - the ID of the type

Returns:

the type definition

getTypeDescendants

public List<Tree<ObjectType>> getTypeDescendants(String typeId,
                                        int depth,
                                        boolean includePropertyDefinitions)

Description copied from interface: Session

Gets the type descendants of a type.

Specified by:

getTypeDescendants in interface Session

Parameters:

typeId - the type ID or null to request the base types

depth - the tree depth, must be greater than 0 or -1 for infinite depth

includePropertyDefinitions - indicates whether the property definitions should be included or not

createType

public ObjectType createType(TypeDefinition type)

Description copied from interface: Session

Creates a new type.

Specified by:

createType in interface Session

Parameters:

type - the type definition

Returns:

the new type definition

updateType

public ObjectType updateType(TypeDefinition type)

Description copied from interface: Session

Updates an existing type.

Specified by:

updateType in interface Session

Parameters:

type - the type definition updates

Returns:

the updated type definition

deleteType

public void deleteType(String typeId)

Description copied from interface: Session

Deletes a type.

Specified by:

deleteType in interface Session

Parameters:

typeId - the ID of the type to delete

query

public ItemIterable<QueryResult> query(String statement,
                              boolean searchAllVersions)

Description copied from interface: Session

Sends a query to the repository. Refer to the CMIS specification for the CMIS query language syntax.

Specified by:

query in interface Session

Parameters:

statement - the query statement (CMIS query language)

searchAllVersions - specifies whether non-latest document versions should be included or not, true searches all document versions, false only searches latest document versions

query

public ItemIterable<QueryResult> query(String statement,
                              boolean searchAllVersions,
                              OperationContext context)

Description copied from interface: Session

Sends a query to the repository using the given OperationContext. (See CMIS spec "2.1.10 Query".)

Specified by:

query in interface Session

Parameters:

statement - the query statement (CMIS query language)

searchAllVersions - specifies whether non-latest document versions should be included or not, true searches all document versions, false only searches latest document versions

context - the operation context to use

queryObjects

public ItemIterable<CmisObject> queryObjects(String typeId,
                                    String where,
                                    boolean searchAllVersions,
                                    OperationContext context)

Description copied from interface: Session

Builds a CMIS query and returns the query results as an iterator of CmisObject objects.

Specified by:

queryObjects in interface Session

where - the WHERE part of the query

searchAllVersions - specifies whether non-latest document versions should be included or not, true searches all document versions, false only searches latest document versions

context - the operation context to use

createQueryStatement

public QueryStatement createQueryStatement(String statement)

Description copied from interface: Session

Creates a query statement.

Sample code:

 QueryStatement stmt = session
         .createQueryStatement("SELECT ?, ? FROM ? WHERE ? > TIMESTAMP ? AND IN_FOLDER(?) OR ? IN (?)");
 

Specified by:

createQueryStatement in interface Session

Parameters:

statement - the query statement with placeholders ('?'), see QueryStatement for details

Returns:

a new query statement object

See Also:

QueryStatement

createQueryStatement

public QueryStatement createQueryStatement(Collection<String> selectPropertyIds,
                                  Map<String,String> fromTypes,
                                  String whereClause,
                                  List<String> orderByPropertyIds)

Description copied from interface: Session

Creates a query statement for a query of one primary type joined by zero or more secondary types.

Sample code:

 List<String> select = new ArrayList<String>();
 select.add("cmis:name");
 select.add("SecondaryStringProp");
 
 Map<String, String> from = new HashMap<String, String>();
 from.put("d", "cmis:document");
 from.put("s", "MySecondaryType");
 
 String where = "d.cmis:name LIKE ?";
 
 List<String> orderBy = new ArrayList<String>();
 orderBy.add("cmis:name");
 orderBy.add("SecondaryIntegerProp");
 
 QueryStatement stmt = session.createQueryStatement(select, from, where, orderBy);
 

Generates something like this:

 SELECT d.cmis:name,s.SecondaryStringProp FROM cmis:document AS d JOIN MySecondaryType AS s ON d.cmis:objectId=s.cmis:objectId WHERE d.cmis:name LIKE ? ORDER BY d.cmis:name,s.SecondaryIntegerProp
 

Specified by:

createQueryStatement in interface Session

Parameters:

selectPropertyIds - the property IDs in the SELECT statement, if null all properties are selected

fromTypes - a Map of type aliases (keys) and type IDs (values), the Map must contain exactly one primary type and zero or more secondary types

whereClause - an optional WHERE clause with placeholders ('?'), see QueryStatement for details

orderByPropertyIds - an optional list of properties IDs for the ORDER BY clause

Returns:

a new query statement object

See Also:

QueryStatement

connect

public void connect()

Connect session object to the provider. This is the very first call after a session is created.

In dependency of the parameter set an AtomPub, a WebService or an InMemory provider is selected.

getBinding

public CmisBinding getBinding()

Description copied from interface: Session

Returns the underlying binding object.

Specified by:

getBinding in interface Session

Returns:

the binding object, not null

getCache

public Cache getCache()

getRepositoryId

public String getRepositoryId()

Returns the repository id.

createDocument

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

Description copied from interface: Session

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

Specified by:

createDocument in interface Session

Returns:

the object ID of the new document

See Also:

Folder.createDocument(Map, ContentStream, VersioningState, List, List, List, OperationContext)

createDocumentFromSource

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

Description copied from interface: Session

Creates a new document from a source document.

Specified by:

createDocumentFromSource in interface Session

Returns:

the object ID of the new document

See Also:

Folder.createDocumentFromSource(ObjectId, Map, VersioningState, List, List, List, OperationContext)

createFolder

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

Description copied from interface: Session

Creates a new folder.

Specified by:

createFolder in interface Session

Returns:

the object ID of the new folder

See Also:

Folder.createFolder(Map, List, List, List, OperationContext)

createPolicy

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

Description copied from interface: Session

Creates a new policy.

Specified by:

createPolicy in interface Session

Returns:

the object ID of the new policy

See Also:

Folder.createPolicy(Map, List, List, List, OperationContext)

createItem

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

Description copied from interface: Session

Creates a new item.

Specified by:

createItem in interface Session

Returns:

the object ID of the new policy

See Also:

Folder.createItem(Map, List, List, List, OperationContext)

createRelationship

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

Description copied from interface: Session

Creates a new relationship.

Specified by:

createRelationship in interface Session

Returns:

the object ID of the new relationship

createDocument

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

Description copied from interface: Session

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

Specified by:

createDocument in interface Session

Returns:

the object ID of the new document

See Also:

Folder.createDocument(Map, ContentStream, VersioningState, List, List, List, OperationContext)

createDocumentFromSource

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

Description copied from interface: Session

Creates a new document from a source document.

Specified by:

createDocumentFromSource in interface Session

Returns:

the object ID of the new document

See Also:

Folder.createDocumentFromSource(ObjectId, Map, VersioningState, List, List, List, OperationContext)

createFolder

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

Description copied from interface: Session

Creates a new folder.

Specified by:

createFolder in interface Session

Returns:

the object ID of the new folder

See Also:

Folder.createFolder(Map, List, List, List, OperationContext)

createPolicy

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

Description copied from interface: Session

Creates a new policy.

Specified by:

createPolicy in interface Session

Returns:

the object ID of the new policy

See Also:

Folder.createPolicy(Map, List, List, List, OperationContext)

createItem

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

Description copied from interface: Session

Creates a new item.

Specified by:

createItem in interface Session

Returns:

the object ID of the new item

See Also:

Folder.createItem(Map, List, List, List, OperationContext)

createRelationship

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

Description copied from interface: Session

Creates a new relationship.

Specified by:

createRelationship in interface Session

Returns:

the object ID of the new relationship

getRelationships

public ItemIterable<Relationship> getRelationships(ObjectId objectId,
                                          boolean includeSubRelationshipTypes,
                                          RelationshipDirection relationshipDirection,
                                          ObjectType type,
                                          OperationContext context)

Description copied from interface: Session

Fetches the relationships from or to an object from the repository.

Specified by:

getRelationships in interface Session

bulkUpdateProperties

public List<BulkUpdateObjectIdAndChangeToken> bulkUpdateProperties(List<CmisObject> objects,
                                                          Map<String,?> properties,
                                                          List<String> addSecondaryTypeIds,
                                                          List<String> removeSecondaryTypeIds)

Description copied from interface: Session

Updates multiple objects in one request.

Specified by:

bulkUpdateProperties in interface Session

delete

public void delete(ObjectId objectId)

Description copied from interface: Session

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

Specified by:

delete in interface Session

Parameters:

objectId - the ID of the object

delete

public void delete(ObjectId objectId,
          boolean allVersions)

Description copied from interface: Session

Deletes an object.

Specified by:

delete in interface Session

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

getContentStream

public ContentStream getContentStream(ObjectId docId)

Description copied from interface: Session

Retrieves the main content stream of a document.

Specified by:

getContentStream in interface Session

Parameters:

docId - the ID of the document

Returns:

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

getContentStream

public ContentStream getContentStream(ObjectId docId,
                             String streamId,
                             BigInteger offset,
                             BigInteger length)

Description copied from interface: Session

Retrieves the content stream of a document.

Specified by:

getContentStream in interface Session

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

getAcl

public Acl getAcl(ObjectId objectId,
         boolean onlyBasicPermissions)

Description copied from interface: Session

Fetches the ACL of an object from the repository.

Specified by:

getAcl in interface Session

Parameters:

objectId - the ID the object

onlyBasicPermissions - if true the repository should express the ACL only with the basic permissions defined in the CMIS specification; if false the repository can express the ACL with basic and repository specific permissions

Returns:

the ACL of the object

applyAcl

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

Description copied from interface: Session

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

Specified by:

applyAcl in interface Session

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

setAcl

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

Description copied from interface: Session

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.

Specified by:

setAcl in interface Session

Parameters:

objectId - the ID the object

aces - list of ACEs to be set

Returns:

the new ACL of the object

applyPolicy

public void applyPolicy(ObjectId objectId,
               ObjectId... policyIds)

Description copied from interface: Session

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

Specified by:

applyPolicy in interface Session

Parameters:

objectId - the ID the object

policyIds - the IDs of the policies to be applied

removePolicy

public void removePolicy(ObjectId objectId,
                ObjectId... policyIds)

Description copied from interface: Session

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

Specified by:

removePolicy in interface Session

Parameters:

objectId - the ID the object

policyIds - the IDs of the policies to be removed

toString

public String toString()

Overrides:

toString in class Object