org.apache.chemistry.opencmis.inmemory.storedobj.impl

Class ObjectStoreImpl

java.lang.Object

org.apache.chemistry.opencmis.inmemory.storedobj.impl.ObjectStoreImpl

All Implemented Interfaces:

ObjectStore, ObjectStoreFiling, ObjectStoreMultiFiling

public class ObjectStoreImpl
extends Object
implements ObjectStore, ObjectStoreMultiFiling

The object store is the central core of the in-memory repository. It is based on huge HashMap map mapping ids to objects in memory. To allow access from multiple threads a Java concurrent HashMap is used that allows parallel access methods.

Certain methods in the in-memory repository must guarantee constraints. For example a folder enforces that each child has a unique name. Therefore certain operations must occur in an atomic manner. In the example it must be guaranteed that no write access occurs to the map between acquiring the iterator to find the children and finishing the add operation when no name conflicts can occur. For this purpose this class has methods to lock an unlock the state of the repository. It is very important that the caller acquiring the lock enforces an unlock under all circumstances. Typical code is:

 ObjectStoreImpl os = ... ;
 try {
     os.lock();
 } finally {
     os.unlock();
 }
 

The locking is very coarse-grained. Productive implementations would probably implement finer grained locks on a folder or document rather than the complete repository.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.chemistry.opencmis.inmemory.storedobj.api.ObjectStoreFiling

ObjectStoreFiling.ChildrenResult

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_PRINCIPAL_ID user id for administrator always having all rights

Constructor Summary

Constructors

Constructor and Description
ObjectStoreImpl(String repositoryId)

Method Summary

Methods

Modifier and Type	Method and Description
void	addParent(StoredObject so, Folder parent) Add this document to a new parent folder as child object
Acl	applyAcl(StoredObject so, Acl addAces, Acl removeAces, AclPropagation aclPropagation, String principalId) Apply a ACLs by relative adding and removing a list of ACEs to/from an object
Acl	applyAcl(StoredObject so, Acl acl, AclPropagation aclPropagation, String principalId) Apply a ACLs by setting a new list of ACEs to an object
void	checkAllAccess(String principalId, StoredObject so)
void	checkReadAccess(String principalId, StoredObject so)
void	checkWriteAccess(String principalId, StoredObject so)
void	clear() Clear repository and remove all data.
Document	createDocument(String name, Map<String,PropertyData<?>> propMap, String user, Folder folder, List<String> policies, Acl addACEs, Acl removeACEs) Create a document as initial step.
Folder	createFolder(String name)
Folder	createFolder(String name, Map<String,PropertyData<?>> propMap, String user, Folder parent, List<String> policies, Acl addACEs, Acl removeACEs) Create a folder as initial step.
StoredObject	createItem(String name, Map<String,PropertyData<?>> propMap, String user, Folder folder, List<String> policies, Acl addACEs, Acl removeACEs) Create an item as initial step.
StoredObject	createPolicy(String name, String policyText, Map<String,PropertyData<?>> propMap, String user) Create a policy.
StoredObject	createRelationship(String name, StoredObject sourceObject, StoredObject targetObject, Map<String,PropertyData<?>> propMap, String user, Acl addACEs, Acl removeACEs) Create a relationship.
DocumentVersion	createVersionedDocument(String name, Map<String,PropertyData<?>> propMap, String user, Folder folder, List<String> policies, Acl addACEs, Acl removeACEs, ContentStream contentStream, VersioningState versioningState) Create a document that supports versions as initial step.
void	deleteObject(String objectId, Boolean allVersions, String user) Deletes an object from the store.
void	deleteVersion(DocumentVersion version) remove a version from the store (after a cancel check-out)
Acl	getAcl(int aclId) get an ACL object from an ACL id
int	getAclId(StoredObjectImpl so, Acl addACEs, Acl removeACEs)
List<Integer>	getAllAclsForUser(String principalId, Permission permission)
List<StoredObject>	getCheckedOutDocuments(String orderBy, String user, IncludeRelationships includeRelationships) Return a list of all documents that are checked out in the repository.
ObjectStoreFiling.ChildrenResult	getChildren(Folder folder, int maxItems, int skipCount, String user, boolean usePwc) get all the children of this folder.
ObjectStoreFiling.ChildrenResult	getFolderChildren(Folder folder, int maxItems, int skipCount, String user) get all the children of this folder which are folders.
String	getFolderPath(String folderId) get the path of this folder (for folder in CMIS path is unique)
Set<String>	getIds()
StoredObject	getObjectById(String objectId) get an object by its id
StoredObject	getObjectByPath(String path, String user) return an object by path.
long	getObjectCount() For statistics: return the number of objects contained in the system
List<String>	getParentIds(Filing fileable, String user) get all parent ids of this object visible for a user
List<StoredObject>	getRelationships(String objectId, List<String> typeIds, RelationshipDirection direction) Get relationships to and from an object
Folder	getRootFolder() Get the root folder of this object store
boolean	hasAllAccess(String principalId, StoredObject so)
boolean	hasReadAccess(String principalId, StoredObject so)
boolean	hasWriteAccess(String principalId, StoredObject so)
boolean	isTypeInUse(String typeId) Check if this store contains any object with the given type id
void	move(StoredObject so, Folder oldParent, Folder newParent) Move an object to a different folder.
void	removeParent(StoredObject so, Folder parent) Remove this object from the children of parent
void	rename(Fileable so, String newName) Rename an object
String	storeObject(StoredObject so)
void	storeVersion(DocumentVersion version) Persist a new version in the store (created from a check-out)
void	upateObject(StoredObject so) Persist an object after modifying the properties

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_PRINCIPAL_ID

public static final String ADMIN_PRINCIPAL_ID

user id for administrator always having all rights

See Also:

Constant Field Values

Constructor Detail

ObjectStoreImpl

public ObjectStoreImpl(String repositoryId)

Method Detail

getRootFolder

public Folder getRootFolder()

Description copied from interface: ObjectStore

Get the root folder of this object store

Specified by:

getRootFolder in interface ObjectStore

Returns:

the root folder of this store

getObjectByPath

public StoredObject getObjectByPath(String path,
                           String user)

Description copied from interface: ObjectStore

return an object by path.

Specified by:

getObjectByPath in interface ObjectStore

Parameters:

path - the path to the object

Returns:

the stored object with this path

getObjectById

public StoredObject getObjectById(String objectId)

Description copied from interface: ObjectStore

get an object by its id

Specified by:

getObjectById in interface ObjectStore

Parameters:

objectId - the id of the object

Returns:

the object identified by this id

deleteObject

public void deleteObject(String objectId,
                Boolean allVersions,
                String user)

Description copied from interface: ObjectStore

Deletes an object from the store. For a folders the folder must be empty.

Specified by:

deleteObject in interface ObjectStore

allVersions - is TRUE all version of the document are deleted, otherwise just this one

storeObject

public String storeObject(StoredObject so)

getIds

public Set<String> getIds()

clear

public void clear()

Clear repository and remove all data.

Specified by:

clear in interface ObjectStore

getObjectCount

public long getObjectCount()

Description copied from interface: ObjectStore

For statistics: return the number of objects contained in the system

Specified by:

getObjectCount in interface ObjectStore

Returns:

number of stored objects

createDocument

public Document createDocument(String name,
                      Map<String,PropertyData<?>> propMap,
                      String user,
                      Folder folder,
                      List<String> policies,
                      Acl addACEs,
                      Acl removeACEs)

Description copied from interface: ObjectStore

Create a document as initial step. The document is created but still temporary It is not yet persisted and does not have an id yet. After this call additional actions can take place (like assigning properties and a type) before it is persisted.

Specified by:

createDocument in interface ObjectStore

Parameters:

name - name of the document

propMap - map of properties

user - the user who creates the document

folder - the parent folder

policies - list of policies to apply

addACEs - aces that are added

removeACEs - aces that are removed

Returns:

document object

createItem

public StoredObject createItem(String name,
                      Map<String,PropertyData<?>> propMap,
                      String user,
                      Folder folder,
                      List<String> policies,
                      Acl addACEs,
                      Acl removeACEs)

Description copied from interface: ObjectStore

Create an item as initial step. The item is created but still temporary. It is not yet persisted and does not have an id yet. After this call additional actions can take place (like assigning properties and a type) before it is persisted.

Specified by:

createItem in interface ObjectStore

Parameters:

name - name of the document

propMap - map of properties

user - the user who creates the document

folder - the parent folder

policies - list of policies to apply

addACEs - aces that are added

removeACEs - aces that are removed

Returns:

document object

createVersionedDocument

public DocumentVersion createVersionedDocument(String name,
                                      Map<String,PropertyData<?>> propMap,
                                      String user,
                                      Folder folder,
                                      List<String> policies,
                                      Acl addACEs,
                                      Acl removeACEs,
                                      ContentStream contentStream,
                                      VersioningState versioningState)

Description copied from interface: ObjectStore

Create a document that supports versions as initial step. The document is created but still temporary. It is not yet persisted and does not have an id yet. After this call additional actions can take place (like assigning properties and a type) before it is persisted.

Specified by:

createVersionedDocument in interface ObjectStore

Parameters:

name - name of the document * @param propMap map of properities

user - the user who creates the document

folder - the parent folder

policies - list of policies to apply

addACEs - aces that are added

removeACEs - aces that are removed

Returns:

versioned document object

createFolder

public Folder createFolder(String name,
                  Map<String,PropertyData<?>> propMap,
                  String user,
                  Folder parent,
                  List<String> policies,
                  Acl addACEs,
                  Acl removeACEs)

Description copied from interface: ObjectStore

Create a folder as initial step. The folder is created but still temporary. It is not yet persisted and does not have an id yet. After this call additional actions can take place (like assigning properties and a type) before it is persisted.

Specified by:

createFolder in interface ObjectStore

Parameters:

name - name of the folder

propMap - map of properties

user - the user who creates the document

parent - the parent folder

policies - list of policies to apply

addACEs - aces that are added

removeACEs - aces that are removed

Returns:

folder object

createFolder

public Folder createFolder(String name)

createPolicy

public StoredObject createPolicy(String name,
                        String policyText,
                        Map<String,PropertyData<?>> propMap,
                        String user)

Description copied from interface: ObjectStore

Create a policy. The policy is created but still temporary. It is not yet persisted and does not have an id yet. After this call additional actions can take place (like assigning properties and a type) before it is persisted.

Specified by:

createPolicy in interface ObjectStore

Parameters:

name - name of the document

policyText - policy text to apply to this policy

propMap - map of properties

user - the user who creates the document

Returns:

policy object

createRelationship

public StoredObject createRelationship(String name,
                              StoredObject sourceObject,
                              StoredObject targetObject,
                              Map<String,PropertyData<?>> propMap,
                              String user,
                              Acl addACEs,
                              Acl removeACEs)

Description copied from interface: ObjectStore

Create a relationship. The relationship is created but still temporary. It is not yet persisted and does not have an id yet. After this call additional actions can take place (like assigning properties and a type) before it is persisted.

Specified by:

createRelationship in interface ObjectStore

sourceObject - source of the relationship

targetObject - target of the relationship

propMap - map of properities

user - the user who creates the document

addACEs - aces that are added

removeACEs - aces that are removed

Returns:

versioned document object

storeVersion

public void storeVersion(DocumentVersion version)

Description copied from interface: ObjectStore

Persist a new version in the store (created from a check-out)

Specified by:

storeVersion in interface ObjectStore

deleteVersion

public void deleteVersion(DocumentVersion version)

Description copied from interface: ObjectStore

remove a version from the store (after a cancel check-out)

Specified by:

deleteVersion in interface ObjectStore

Parameters:

version - version to be deleted

upateObject

public void upateObject(StoredObject so)

Description copied from interface: ObjectStore

Persist an object after modifying the properties

Specified by:

upateObject in interface ObjectStore

Parameters:

so - object to be updated

getCheckedOutDocuments

public List<StoredObject> getCheckedOutDocuments(String orderBy,
                                        String user,
                                        IncludeRelationships includeRelationships)

Description copied from interface: ObjectStore

Return a list of all documents that are checked out in the repository.

Specified by:

getCheckedOutDocuments in interface ObjectStore

Parameters:

orderBy - orderBy specification according to CMIS spec.

user - user id of user calling

includeRelationships - if true include all relationships in the response

Returns:

list of checked out documents in the repository

getRelationships

public List<StoredObject> getRelationships(String objectId,
                                  List<String> typeIds,
                                  RelationshipDirection direction)

Description copied from interface: ObjectStore

Get relationships to and from an object

Specified by:

getRelationships in interface ObjectStore

Parameters:

objectId - id of object to get relationships with

Returns:

getFolderPath

public String getFolderPath(String folderId)

Description copied from interface: ObjectStore

get the path of this folder (for folder in CMIS path is unique)

Specified by:

getFolderPath in interface ObjectStore

Parameters:

folderId - id of folder

Returns:

path of this folder

applyAcl

public Acl applyAcl(StoredObject so,
           Acl addAces,
           Acl removeAces,
           AclPropagation aclPropagation,
           String principalId)

Description copied from interface: ObjectStore

Apply a ACLs by relative adding and removing a list of ACEs to/from an object

Specified by:

applyAcl in interface ObjectStore

Parameters:

so - object where ACLs are applied

addAces - list of ACEs to be added

removeAces - list of ACEs to be removed

aclPropagation - enum value how to propagate ACLs to child objects

Returns:

new ACL of object

applyAcl

public Acl applyAcl(StoredObject so,
           Acl acl,
           AclPropagation aclPropagation,
           String principalId)

Description copied from interface: ObjectStore

Apply a ACLs by setting a new list of ACEs to an object

Specified by:

applyAcl in interface ObjectStore

Parameters:

so - object where ACLs are applied

acl - list of ACEs to be applied

aclPropagation - enum value how to propagate ACLs to child objects

Returns:

new ACL of object

getAllAclsForUser

public List<Integer> getAllAclsForUser(String principalId,
                              Permission permission)

getAcl

public Acl getAcl(int aclId)

Description copied from interface: ObjectStore

get an ACL object from an ACL id

Specified by:

getAcl in interface ObjectStore

Parameters:

aclId - id of ACL

Returns:

ACL of this id

getAclId

public int getAclId(StoredObjectImpl so,
           Acl addACEs,
           Acl removeACEs)

getChildren

public ObjectStoreFiling.ChildrenResult getChildren(Folder folder,
                                           int maxItems,
                                           int skipCount,
                                           String user,
                                           boolean usePwc)

Description copied from interface: ObjectStoreFiling

get all the children of this folder. To support paging an initial offset and a maximum number of children to retrieve can be passed

Specified by:

getChildren in interface ObjectStoreFiling

Parameters:

folder - folder to get children from

maxItems - max. number of items to return

skipCount - initial offset where to start fetching

user - user to determine visible children

usePwc - if true return private working copy otherwise return latest version;

Returns:

list of children objects

getFolderChildren

public ObjectStoreFiling.ChildrenResult getFolderChildren(Folder folder,
                                                 int maxItems,
                                                 int skipCount,
                                                 String user)

Description copied from interface: ObjectStoreFiling

get all the children of this folder which are folders. To support paging an initial offset and a maximum number of children to retrieve can be passed.

Specified by:

getFolderChildren in interface ObjectStoreFiling

Parameters:

folder - folder to get children from

maxItems - max. number of items to return

skipCount - initial offset where to start fetching

Returns:

list of children folders

move

public void move(StoredObject so,
        Folder oldParent,
        Folder newParent)

Description copied from interface: ObjectStoreFiling

Move an object to a different folder.

Specified by:

move in interface ObjectStoreFiling

Parameters:

so - object to be moved

oldParent - old parent folder for the object

newParent - new parent folder for the object

rename

public void rename(Fileable so,
          String newName)

Description copied from interface: ObjectStoreFiling

Rename an object

Specified by:

rename in interface ObjectStoreFiling

Parameters:

so - object to be renamed

newName - new name to be assigned

getParentIds

public List<String> getParentIds(Filing fileable,
                        String user)

Description copied from interface: ObjectStoreFiling

get all parent ids of this object visible for a user

Specified by:

getParentIds in interface ObjectStoreFiling

user - user who can see parents

Returns:

list of folder ids

hasReadAccess

public boolean hasReadAccess(String principalId,
                    StoredObject so)

hasWriteAccess

public boolean hasWriteAccess(String principalId,
                     StoredObject so)

hasAllAccess

public boolean hasAllAccess(String principalId,
                   StoredObject so)

checkReadAccess

public void checkReadAccess(String principalId,
                   StoredObject so)

checkWriteAccess

public void checkWriteAccess(String principalId,
                    StoredObject so)

checkAllAccess

public void checkAllAccess(String principalId,
                  StoredObject so)

isTypeInUse

public boolean isTypeInUse(String typeId)

Description copied from interface: ObjectStore

Check if this store contains any object with the given type id

Specified by:

isTypeInUse in interface ObjectStore

Parameters:

typeId - id of type definition to check

Returns:

true if at least one object in the store has the given type, false if no objects exist having this type

addParent

public void addParent(StoredObject so,
             Folder parent)

Description copied from interface: ObjectStoreMultiFiling

Add this document to a new parent folder as child object

Specified by:

addParent in interface ObjectStoreMultiFiling

removeParent

public void removeParent(StoredObject so,
                Folder parent)

Description copied from interface: ObjectStoreMultiFiling

Remove this object from the children of parent

Specified by:

removeParent in interface ObjectStoreMultiFiling