it.sistematica.isharedoc.opencmis.indatabase.storedobj.api
Interface StoreManager

All Known Implementing Classes:
StoreManagerImpl, StoreManagerImpl_OLD

public interface StoreManager

interface to a repository implementation. This interface is the entry point to a repository that can persist CMIS objects. Using this interface the type information can be retrieved or set, a repository can be created or for a given repository the store can be retrieved.

Author:
Jens

Method Summary
 void createAndInitRepository(java.lang.String repositoryId, java.lang.String typeCreatorClassName)
          create a new repository with the given id.
 java.util.List<java.lang.String> getAllRepositoryIds()
          return a list of all available repositories
 it.neverworks.data.EntityManager getEntities()
           
 org.apache.chemistry.opencmis.commons.spi.BindingsObjectFactory getObjectFactory()
          Retrieve a factory to create CMIS data structures used as containers
 ObjectStore getObjectStore(java.lang.String repositoryId)
          get the object store for the given repository id.
 org.apache.chemistry.opencmis.commons.data.RepositoryInfo getRepositoryInfo(java.lang.String repositoryId)
          Retrieve the repository information for a repository
 java.util.List<org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer> getRootTypes(java.lang.String repositoryId, boolean inclPropDefs)
          Retrieve a list of root types in the repositories.
 SearchService getSearchService()
           
 CmisServiceValidator getServiceValidator()
          get a permission and parameter validating instance
 org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer getTypeById(java.lang.String repositoryId, java.lang.String typeId)
          Retrieve a type definition for a give repository and type id
 org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer getTypeById(java.lang.String repositoryId, java.lang.String typeId, boolean includePropertyDefinitions, int depth)
          Retrieve a type definition for a give repository and type id with or without property definitions and limited to depth in hierarchy
 java.util.Collection<org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer> getTypeDefinitionList(java.lang.String repositoryId, boolean includePropertyDefinitions)
          retrieve a list with all type definitions.
 TypeManagerCreatable getTypeManager(java.lang.String repositoryId)
          retrieve the type manager for a given repository
 it.neverworks.application.service.UserInfo getUserInfo()
           
 void initRepository(java.lang.String repositoryId, java.lang.String typeCreatorClassName)
          Initialize the store for the given repository.
 org.apache.chemistry.opencmis.commons.data.ObjectList query(java.lang.String user, java.lang.String repositoryId, java.lang.String statement, java.lang.Boolean searchAllVersions, java.lang.Boolean includeAllowableActions, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships, java.lang.String renditionFilter, java.math.BigInteger maxItems, java.math.BigInteger skipCount)
          Execute a query against the repository (same parameter as the discovery service query method
 void setDocumentManager(DocumentManager documentManager)
          Set the document manager.
 void setEntities(it.neverworks.data.EntityManager entities)
          Set the entity manager.
 void setSearchService(SearchService searchService)
          Set the searchService.
 void startManager()
          return a list of all available repositories
 

Method Detail

getUserInfo

it.neverworks.application.service.UserInfo getUserInfo()

getSearchService

SearchService getSearchService()

setSearchService

void setSearchService(SearchService searchService)
Set the searchService.

Parameters:
searchService - reference to searchService

getEntities

it.neverworks.data.EntityManager getEntities()

setEntities

void setEntities(it.neverworks.data.EntityManager entities)
Set the entity manager.

Parameters:
entities - reference to entity manager

setDocumentManager

void setDocumentManager(DocumentManager documentManager)
Set the document manager.

Parameters:
documentManager - reference to document manager

getAllRepositoryIds

java.util.List<java.lang.String> getAllRepositoryIds()
return a list of all available repositories

Returns:

startManager

void startManager()
return a list of all available repositories


initRepository

void initRepository(java.lang.String repositoryId,
                    java.lang.String typeCreatorClassName)
Initialize the store for the given repository. Only called for repositories that exist on startup (i.e. for each repository id returned in a previous getAllRepositoryIds() call.

Parameters:
repositoryId - id of repository
typeCreatorClassName - class implementing the type creation, the class must implement the interface TypeCreator

getObjectStore

ObjectStore getObjectStore(java.lang.String repositoryId)
get the object store for the given repository id.

Parameters:
repositoryId -
Returns:
the object store in which objects for this repository are stored.

getServiceValidator

CmisServiceValidator getServiceValidator()
get a permission and parameter validating instance

Returns:
validator and permission checker

createAndInitRepository

void createAndInitRepository(java.lang.String repositoryId,
                             java.lang.String typeCreatorClassName)
create a new repository with the given id. Create the repository, initiate the type system and initialize it so that it is ready for use

Parameters:
repositoryId - id of repository
typeCreatorClassName - class implementing the type creation, the class must implement the interface TypeCreator

getTypeDefinitionList

java.util.Collection<org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer> getTypeDefinitionList(java.lang.String repositoryId,
                                                                                                                      boolean includePropertyDefinitions)
retrieve a list with all type definitions.

Parameters:
repositoryId - id of repository
includePropertyDefinitions - indicates whether to include property definitions in returned type
Returns:
map with type definition

getTypeById

org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer getTypeById(java.lang.String repositoryId,
                                                                                      java.lang.String typeId)
Retrieve a type definition for a give repository and type id

Parameters:
repositoryId - id of repository
typeId - id of type definition
Returns:
type definition

getTypeById

org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer getTypeById(java.lang.String repositoryId,
                                                                                      java.lang.String typeId,
                                                                                      boolean includePropertyDefinitions,
                                                                                      int depth)
Retrieve a type definition for a give repository and type id with or without property definitions and limited to depth in hierarchy

Parameters:
repositoryId - id of repository
typeId - id of type definition
includePropertyDefinitions - indicates whether to include property definitions in returned type
depth - limit depth of type hierarchy in return (-1 means unlimited)
Returns:
type definition

getObjectFactory

org.apache.chemistry.opencmis.commons.spi.BindingsObjectFactory getObjectFactory()
Retrieve a factory to create CMIS data structures used as containers

Returns:
factory object

getRootTypes

java.util.List<org.apache.chemistry.opencmis.commons.definitions.TypeDefinitionContainer> getRootTypes(java.lang.String repositoryId,
                                                                                                       boolean inclPropDefs)
Retrieve a list of root types in the repositories. Root types are available by definition and need to to be created by a client. CMIS supports documents, folders, relations and policies as root types

Parameters:
repositoryId - id of repository
inclPropDefs -
Returns:
list of root types

getRepositoryInfo

org.apache.chemistry.opencmis.commons.data.RepositoryInfo getRepositoryInfo(java.lang.String repositoryId)
Retrieve the repository information for a repository

Parameters:
repositoryId - id of repository
Returns:
repository information

getTypeManager

TypeManagerCreatable getTypeManager(java.lang.String repositoryId)
retrieve the type manager for a given repository

Parameters:
repositoryId - id of repository
Returns:
type manager for this repository or null if repository is unknown

query

org.apache.chemistry.opencmis.commons.data.ObjectList query(java.lang.String user,
                                                            java.lang.String repositoryId,
                                                            java.lang.String statement,
                                                            java.lang.Boolean searchAllVersions,
                                                            java.lang.Boolean includeAllowableActions,
                                                            org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships,
                                                            java.lang.String renditionFilter,
                                                            java.math.BigInteger maxItems,
                                                            java.math.BigInteger skipCount)
Execute a query against the repository (same parameter as the discovery service query method

Parameters:
user -
repositoryId -
statement -
searchAllVersions -
includeAllowableActions -
includeRelationships -
renditionFilter -
maxItems -
skipCount -
Returns: