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

Modifier and Type	Method and Description
Acl	applyAcl(ObjectId objectId, List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation)
void	applyPolicy(ObjectId objectId, ObjectId... policyIds)
protected String	buildPath(String parentPath, String name)
List<BulkUpdateObjectIdAndChangeToken>	bulkUpdateProperties(List<CmisObject> objects, Map<String,?> properties, List<String> addSecondaryTypeIds, List<String> removeSecondaryTypeIds)
protected void	checkCmisVersion()
protected void	checkContext(OperationContext context)
protected void	checkDocumentId(ObjectId docId)
protected void	checkDocumentId(String docId)
protected void	checkFolderId(ObjectId folderId)
protected void	checkObjectId(ObjectId objectId)
protected void	checkObjectId(String objectId)
protected void	checkPath(String path)
protected void	checkProperties(Map<String,?> properties)
void	clear()
void	connect() Connect session object to the provider.
ObjectId	createDocument(Map<String,?> properties, ObjectId folderId, ContentStream contentStream, VersioningState versioningState)
ObjectId	createDocument(Map<String,?> properties, ObjectId folderId, ContentStream contentStream, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces)
ObjectId	createDocumentFromSource(ObjectId source, Map<String,?> properties, ObjectId folderId, VersioningState versioningState)
ObjectId	createDocumentFromSource(ObjectId source, Map<String,?> properties, ObjectId folderId, VersioningState versioningState, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces)
ObjectId	createFolder(Map<String,?> properties, ObjectId folderId)
ObjectId	createFolder(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces)
ObjectId	createItem(Map<String,?> properties, ObjectId folderId)
ObjectId	createItem(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces)
ObjectId	createObjectId(String id)
OperationContext	createOperationContext()
OperationContext	createOperationContext(Set<String> filter, boolean includeAcls, boolean includeAllowableActions, boolean includePolicies, IncludeRelationships includeRelationships, Set<String> renditionFilter, boolean includePathSegments, String orderBy, boolean cacheEnabled, int maxItemsPerPage)
ObjectId	createPath(ObjectId startFolderId, String newPath, Map<String,?> properties)
ObjectId	createPath(ObjectId startFolderId, String newPath, Map<String,?> properties, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces)
ObjectId	createPath(ObjectId startFolderId, String newPath, String typeId)
ObjectId	createPath(String newPath, Map<String,?> properties)
ObjectId	createPath(String newPath, String typeId)
ObjectId	createPolicy(Map<String,?> properties, ObjectId folderId)
ObjectId	createPolicy(Map<String,?> properties, ObjectId folderId, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces)
QueryStatement	createQueryStatement(Collection<String> selectPropertyIds, Map<String,String> fromTypes, String whereClause, List<String> orderByPropertyIds)
QueryStatement	createQueryStatement(String statement)
ObjectId	createRelationship(Map<String,?> properties)
ObjectId	createRelationship(Map<String,?> properties, List<Policy> policies, List<Ace> addAces, List<Ace> removeAces)
ObjectType	createType(TypeDefinition type)
void	delete(ObjectId objectId)
void	delete(ObjectId objectId, boolean allVersions)
void	deleteByPath(String path)
void	deleteByPath(String path, boolean allVersions)
void	deleteByPath(String parentPath, String name)
List<String>	deleteTree(ObjectId folderId, boolean allVersions, UnfileObject unfile, boolean continueOnFailure)
List<String>	deleteTreebyPath(String path, boolean allVersions, UnfileObject unfile, boolean continueOnFailure)
List<String>	deleteTreebyPath(String parentPath, String name, boolean allVersions, UnfileObject unfile, boolean continueOnFailure)
void	deleteType(String typeId)
boolean	exists(ObjectId objectId)
boolean	exists(String objectId)
boolean	existsPath(String path)
boolean	existsPath(String parentPath, String name)
Acl	getAcl(ObjectId objectId, boolean onlyBasicPermissions)
CmisBinding	getBinding()
Cache	getCache()
ItemIterable<Document>	getCheckedOutDocs()
ItemIterable<Document>	getCheckedOutDocs(OperationContext context)
ItemIterable<ChangeEvent>	getContentChanges(String changeLogToken, boolean includeProperties)
ChangeEvents	getContentChanges(String changeLogToken, boolean includeProperties, long maxNumItems)
ChangeEvents	getContentChanges(String changeLogToken, boolean includeProperties, long maxNumItems, OperationContext context)
ItemIterable<ChangeEvent>	getContentChanges(String changeLogToken, boolean includeProperties, OperationContext context)
ContentStream	getContentStream(ObjectId docId)
ContentStream	getContentStream(ObjectId docId, String streamId, BigInteger offset, BigInteger length)
ContentStream	getContentStreamByPath(String path)
ContentStream	getContentStreamByPath(String path, String streamId, BigInteger offset, BigInteger length)
OperationContext	getDefaultContext()
String	getLatestChangeLogToken()
Document	getLatestDocumentVersion(ObjectId objectId)
Document	getLatestDocumentVersion(ObjectId objectId, boolean major, OperationContext context)
Document	getLatestDocumentVersion(ObjectId objectId, OperationContext context)
Document	getLatestDocumentVersion(String objectId)
Document	getLatestDocumentVersion(String objectId, boolean major, OperationContext context)
Document	getLatestDocumentVersion(String objectId, OperationContext context)
Locale	getLocale()
CmisObject	getObject(ObjectId objectId)
CmisObject	getObject(ObjectId objectId, OperationContext context)
CmisObject	getObject(String objectId)
CmisObject	getObject(String objectId, OperationContext context)
CmisObject	getObjectByPath(String path)
CmisObject	getObjectByPath(String path, OperationContext context)
CmisObject	getObjectByPath(String parentPath, String name)
CmisObject	getObjectByPath(String parentPath, String name, OperationContext context)
ObjectFactory	getObjectFactory()
protected String	getObjectIdByPath(String path)
ItemIterable<Relationship>	getRelationships(ObjectId objectId, boolean includeSubRelationshipTypes, RelationshipDirection relationshipDirection, ObjectType type, OperationContext context)
String	getRepositoryId() Returns the repository id.
RepositoryInfo	getRepositoryInfo()
Folder	getRootFolder()
Folder	getRootFolder(OperationContext context)
Map<String,String>	getSessionParameters()
ItemIterable<ObjectType>	getTypeChildren(String typeId, boolean includePropertyDefinitions)
ObjectType	getTypeDefinition(String typeId)
ObjectType	getTypeDefinition(String typeId, boolean useCache)
List<Tree<ObjectType>>	getTypeDescendants(String typeId, int depth, boolean includePropertyDefinitions)
ItemIterable<QueryResult>	query(String statement, boolean searchAllVersions)
ItemIterable<QueryResult>	query(String statement, boolean searchAllVersions, OperationContext context)
ItemIterable<CmisObject>	queryObjects(String typeId, String where, boolean searchAllVersions, OperationContext context)
void	removeObjectFromCache(ObjectId objectId)
void	removeObjectFromCache(String objectId)
void	removePolicy(ObjectId objectId, ObjectId... policyIds)
Acl	setAcl(ObjectId objectId, List<Ace> aces)
void	setDefaultContext(OperationContext context)
String	toString()
ObjectType	updateType(TypeDefinition 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

getSessionParameters

public Map<String,String> getSessionParameters()

Specified by:

getSessionParameters in interface Session

clear

public void clear()

Specified by:

clear in interface Session

getObjectFactory

public ObjectFactory getObjectFactory()

Specified by:

getObjectFactory in interface Session

getCheckedOutDocs

public ItemIterable<Document> getCheckedOutDocs()

Specified by:

getCheckedOutDocs in interface Session

getCheckedOutDocs

public ItemIterable<Document> getCheckedOutDocs(OperationContext context)

Specified by:

getCheckedOutDocs in interface Session

getContentChanges

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

Specified by:

getContentChanges in interface Session

getContentChanges

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

Specified by:

getContentChanges in interface Session

getContentChanges

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

Specified by:

getContentChanges in interface Session

getContentChanges

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

Specified by:

getContentChanges in interface Session

getLatestChangeLogToken

public String getLatestChangeLogToken()

Specified by:

getLatestChangeLogToken in interface Session

getDefaultContext

public OperationContext getDefaultContext()

Specified by:

getDefaultContext in interface Session

setDefaultContext

public void setDefaultContext(OperationContext context)

Specified by:

setDefaultContext in interface Session

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)

Specified by:

createOperationContext in interface Session

createOperationContext

public OperationContext createOperationContext()

Specified by:

createOperationContext in interface Session

createObjectId

public ObjectId createObjectId(String id)

Specified by:

createObjectId in interface Session

getLocale

public Locale getLocale()

Specified by:

getLocale in interface Session

getObject

public CmisObject getObject(ObjectId objectId)

Specified by:

getObject in interface Session

getObject

public CmisObject getObject(ObjectId objectId,
                            OperationContext context)

Specified by:

getObject in interface Session

getObject

public CmisObject getObject(String objectId)

Specified by:

getObject in interface Session

getObject

public CmisObject getObject(String objectId,
                            OperationContext context)

Specified by:

getObject in interface Session

getObjectByPath

public CmisObject getObjectByPath(String path)

Specified by:

getObjectByPath in interface Session

getObjectByPath

public CmisObject getObjectByPath(String path,
                                  OperationContext context)

Specified by:

getObjectByPath in interface Session

getObjectByPath

public CmisObject getObjectByPath(String parentPath,
                                  String name)

Specified by:

getObjectByPath in interface Session

getObjectByPath

public CmisObject getObjectByPath(String parentPath,
                                  String name,
                                  OperationContext context)

Specified by:

getObjectByPath in interface Session

getLatestDocumentVersion

public Document getLatestDocumentVersion(ObjectId objectId)

Specified by:

getLatestDocumentVersion in interface Session

getLatestDocumentVersion

public Document getLatestDocumentVersion(String objectId,
                                         OperationContext context)

Specified by:

getLatestDocumentVersion in interface Session

getLatestDocumentVersion

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

Specified by:

getLatestDocumentVersion in interface Session

getLatestDocumentVersion

public Document getLatestDocumentVersion(String objectId)

Specified by:

getLatestDocumentVersion in interface Session

getLatestDocumentVersion

public Document getLatestDocumentVersion(ObjectId objectId,
                                         OperationContext context)

Specified by:

getLatestDocumentVersion in interface Session

getLatestDocumentVersion

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

Specified by:

getLatestDocumentVersion in interface Session

exists

public boolean exists(ObjectId objectId)

Specified by:

exists in interface Session

exists

public boolean exists(String objectId)

Specified by:

exists in interface Session

existsPath

public boolean existsPath(String path)

Specified by:

existsPath in interface Session

existsPath

public boolean existsPath(String parentPath,
                          String name)

Specified by:

existsPath in interface Session

removeObjectFromCache

public void removeObjectFromCache(ObjectId objectId)

Specified by:

removeObjectFromCache in interface Session

removeObjectFromCache

public void removeObjectFromCache(String objectId)

Specified by:

removeObjectFromCache in interface Session

getRepositoryInfo

public RepositoryInfo getRepositoryInfo()

Specified by:

getRepositoryInfo in interface Session

getRootFolder

public Folder getRootFolder()

Specified by:

getRootFolder in interface Session

getRootFolder

public Folder getRootFolder(OperationContext context)

Specified by:

getRootFolder in interface Session

getTypeChildren

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

Specified by:

getTypeChildren in interface Session

getTypeDefinition

public ObjectType getTypeDefinition(String typeId)

Specified by:

getTypeDefinition in interface Session

getTypeDefinition

public ObjectType getTypeDefinition(String typeId,
                                    boolean useCache)

Specified by:

getTypeDefinition in interface Session

getTypeDescendants

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

Specified by:

getTypeDescendants in interface Session

createType

public ObjectType createType(TypeDefinition type)

Specified by:

createType in interface Session

updateType

public ObjectType updateType(TypeDefinition type)

Specified by:

updateType in interface Session

deleteType

public void deleteType(String typeId)

Specified by:

deleteType in interface Session

query

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

Specified by:

query in interface Session

query

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

Specified by:

query in interface Session

queryObjects

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

Specified by:

queryObjects in interface Session

createQueryStatement

public QueryStatement createQueryStatement(String statement)

Specified by:

createQueryStatement in interface Session

createQueryStatement

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

Specified by:

createQueryStatement in interface Session

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()

Specified by:

getBinding in interface Session

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)

Specified by:

createDocument in interface Session

createDocumentFromSource

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

Specified by:

createDocumentFromSource in interface Session

createFolder

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

Specified by:

createFolder in interface Session

createPath

public ObjectId createPath(String newPath,
                           String typeId)

Specified by:

createPath in interface Session

createPath

public ObjectId createPath(ObjectId startFolderId,
                           String newPath,
                           String typeId)

Specified by:

createPath in interface Session

createPath

public ObjectId createPath(String newPath,
                           Map<String,?> properties)

Specified by:

createPath in interface Session

createPath

public ObjectId createPath(ObjectId startFolderId,
                           String newPath,
                           Map<String,?> properties)

Specified by:

createPath in interface Session

createPath

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

Specified by:

createPath in interface Session

createPolicy

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

Specified by:

createPolicy in interface Session

createItem

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

Specified by:

createItem in interface Session

createRelationship

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

Specified by:

createRelationship in interface Session

createDocument

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

Specified by:

createDocument in interface Session

createDocumentFromSource

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

Specified by:

createDocumentFromSource in interface Session

createFolder

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

Specified by:

createFolder in interface Session

createPolicy

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

Specified by:

createPolicy in interface Session

createItem

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

Specified by:

createItem in interface Session

createRelationship

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

Specified by:

createRelationship in interface Session

getRelationships

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

Specified by:

getRelationships in interface Session

bulkUpdateProperties

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

Specified by:

bulkUpdateProperties in interface Session

delete

public void delete(ObjectId objectId)

Specified by:

delete in interface Session

delete

public void delete(ObjectId objectId,
                   boolean allVersions)

Specified by:

delete in interface Session

deleteByPath

public void deleteByPath(String path)

Specified by:

deleteByPath in interface Session

deleteByPath

public void deleteByPath(String parentPath,
                         String name)

Specified by:

deleteByPath in interface Session

deleteByPath

public void deleteByPath(String path,
                         boolean allVersions)

Specified by:

deleteByPath in interface Session

deleteTree

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

Specified by:

deleteTree in interface Session

deleteTreebyPath

public List<String> deleteTreebyPath(String parentPath,
                                     String name,
                                     boolean allVersions,
                                     UnfileObject unfile,
                                     boolean continueOnFailure)

Specified by:

deleteTreebyPath in interface Session

deleteTreebyPath

public List<String> deleteTreebyPath(String path,
                                     boolean allVersions,
                                     UnfileObject unfile,
                                     boolean continueOnFailure)

Specified by:

deleteTreebyPath in interface Session

getContentStream

public ContentStream getContentStream(ObjectId docId)

Specified by:

getContentStream in interface Session

getContentStream

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

Specified by:

getContentStream in interface Session

getContentStreamByPath

public ContentStream getContentStreamByPath(String path)

Specified by:

getContentStreamByPath in interface Session

getContentStreamByPath

public ContentStream getContentStreamByPath(String path,
                                            String streamId,
                                            BigInteger offset,
                                            BigInteger length)

Specified by:

getContentStreamByPath in interface Session

getAcl

public Acl getAcl(ObjectId objectId,
                  boolean onlyBasicPermissions)

Specified by:

getAcl in interface Session

applyAcl

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

Specified by:

applyAcl in interface Session

setAcl

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

Specified by:

setAcl in interface Session

applyPolicy

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

Specified by:

applyPolicy in interface Session

removePolicy

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

Specified by:

removePolicy in interface Session

buildPath

protected String buildPath(String parentPath,
                           String name)

getObjectIdByPath

protected String getObjectIdByPath(String path)

checkObjectId

protected final void checkObjectId(ObjectId objectId)

checkObjectId

protected final void checkObjectId(String objectId)

checkDocumentId

protected final void checkDocumentId(ObjectId docId)

checkDocumentId

protected final void checkDocumentId(String docId)

checkFolderId

protected final void checkFolderId(ObjectId folderId)

checkPath

protected final void checkPath(String path)

checkContext

protected final void checkContext(OperationContext context)

checkProperties

protected final void checkProperties(Map<String,?> properties)

checkCmisVersion

protected final void checkCmisVersion()

toString

public String toString()

Overrides:

toString in class Object