org.alfresco.opencmis.dictionary

Class CMISAbstractDictionaryService

java.lang.Object

org.springframework.extensions.surf.util.AbstractLifecycleBean

org.alfresco.opencmis.dictionary.CMISAbstractDictionaryService

All Implemented Interfaces:

EventListener, CMISDictionaryService, DictionaryListener, ExtendedDictionaryListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

Direct Known Subclasses:

CMISStrictDictionaryService

public abstract class CMISAbstractDictionaryService
extends org.springframework.extensions.surf.util.AbstractLifecycleBean
implements CMISDictionaryService, ExtendedDictionaryListener

Common CMIS Dictionary Support including registry of Types.

Author:

davidc, florian.mueller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	CMISAbstractDictionaryService.DictionaryInitializer

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyAccessorMapping	accessorMapping
protected CMISMapping	cmisMapping
protected DictionaryDAO	dictionaryDAO
protected DictionaryService	dictionaryService
protected static org.apache.commons.logging.Log	logger
protected PropertyLuceneBuilderMapping	luceneBuilderMapping
protected TenantService	tenantService

Fields inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

log

Constructor Summary

Constructors

Constructor and Description
CMISAbstractDictionaryService()

Method Summary

Modifier and Type	Method and Description
void	afterDictionaryDestroy() Callback once dictionary destroy is complete (executed in the current tenant context)
void	afterDictionaryInit() Callback once dictionary initialisation is complete (executed in the current tenant context)
protected CMISDictionaryRegistry	createCoreDictionaryRegistry()
protected CMISDictionaryRegistry	createDictionaryRegistry(String tenant)
protected CMISDictionaryRegistry	createDictionaryRegistryWithWriteLock()
protected CMISDictionaryRegistry	createTenantDictionaryRegistry(String tenant)
QName	findAlfrescoDataType(org.apache.chemistry.opencmis.commons.enums.PropertyType propertyType)
TypeDefinitionWrapper	findAssocType(QName clazz)
org.apache.chemistry.opencmis.commons.enums.PropertyType	findDataType(QName dataType) Find data type
TypeDefinitionWrapper	findNodeType(QName clazz)
PropertyDefinitionWrapper	findProperty(String propId)
PropertyDefinitionWrapper	findPropertyByQueryName(String queryName)
TypeDefinitionWrapper	findType(String typeId) Find type for type id
TypeDefinitionWrapper	findTypeByQueryName(String queryName) Find a type by its query name
TypeDefinitionWrapper	findTypeForClass(QName clazz, org.apache.chemistry.opencmis.commons.enums.BaseTypeId... matchingScopes) Find type for Alfresco class name.
List<TypeDefinitionWrapper>	getAllTypes() Get all Types
List<TypeDefinitionWrapper>	getAllTypes(boolean includeParent)
List<TypeDefinitionWrapper>	getBaseTypes() Get Base Types
List<TypeDefinitionWrapper>	getBaseTypes(boolean includeParent)
List<TypeDefinitionWrapper>	getChildren(String typeId)
protected abstract CMISAbstractDictionaryService.DictionaryInitializer	getCoreDictionaryInitializer()
protected CMISDictionaryRegistry	getRegistry()
protected abstract CMISAbstractDictionaryService.DictionaryInitializer	getTenantDictionaryInitializer()
boolean	isExcluded(QName qname)
void	modelAdded(CompiledModel model, String tenantDomain)
protected void	onBootstrap(org.springframework.context.ApplicationEvent event)
void	onDictionaryInit() Callback for (re-)initialising the Dictionary caches (executed in the current tenant context)
protected void	onShutdown(org.springframework.context.ApplicationEvent event)
void	setCmisMapping(CMISMapping cmisMapping) Set the mapping service
void	setDictionaryDAO(DictionaryDAO dictionaryDAO) Set the dictionary DAO
void	setDictionaryService(DictionaryService dictionaryService) Set the dictionary Service
void	setPropertyAccessorMapping(PropertyAccessorMapping accessorMapping) Set the property accessor mapping service
void	setPropertyLuceneBuilderMapping(PropertyLuceneBuilderMapping luceneBuilderMapping) Set the property lucene mapping service
void	setSingletonCache(SimpleCache<String,CMISDictionaryRegistry> singletonCache)
void	setTenantService(TenantService tenantService)

Methods inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

getApplicationContext, onApplicationEvent, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

dictionaryDAO

protected DictionaryDAO dictionaryDAO

dictionaryService

protected DictionaryService dictionaryService

cmisMapping

protected CMISMapping cmisMapping

accessorMapping

protected PropertyAccessorMapping accessorMapping

luceneBuilderMapping

protected PropertyLuceneBuilderMapping luceneBuilderMapping

tenantService

protected TenantService tenantService

Constructor Detail

CMISAbstractDictionaryService

public CMISAbstractDictionaryService()

Method Detail

setTenantService

public void setTenantService(TenantService tenantService)

setCmisMapping

public void setCmisMapping(CMISMapping cmisMapping)

Set the mapping service

Parameters:

cmisMapping - CMISMapping

setPropertyAccessorMapping

public void setPropertyAccessorMapping(PropertyAccessorMapping accessorMapping)

Set the property accessor mapping service

Parameters:

accessorMapping - mapping

setPropertyLuceneBuilderMapping

public void setPropertyLuceneBuilderMapping(PropertyLuceneBuilderMapping luceneBuilderMapping)

Set the property lucene mapping service

Parameters:

luceneBuilderMapping - mapping

setDictionaryService

public void setDictionaryService(DictionaryService dictionaryService)

Set the dictionary Service

Parameters:

dictionaryService - DictionaryService

setDictionaryDAO

public void setDictionaryDAO(DictionaryDAO dictionaryDAO)

Set the dictionary DAO

Parameters:

dictionaryDAO - DictionaryDAO

setSingletonCache

public void setSingletonCache(SimpleCache<String,CMISDictionaryRegistry> singletonCache)

getCoreDictionaryInitializer

protected abstract CMISAbstractDictionaryService.DictionaryInitializer getCoreDictionaryInitializer()

getTenantDictionaryInitializer

protected abstract CMISAbstractDictionaryService.DictionaryInitializer getTenantDictionaryInitializer()

getRegistry

protected CMISDictionaryRegistry getRegistry()

onBootstrap

protected void onBootstrap(org.springframework.context.ApplicationEvent event)

Specified by:

onBootstrap in class org.springframework.extensions.surf.util.AbstractLifecycleBean

onShutdown

protected void onShutdown(org.springframework.context.ApplicationEvent event)

Specified by:

onShutdown in class org.springframework.extensions.surf.util.AbstractLifecycleBean

createCoreDictionaryRegistry

protected CMISDictionaryRegistry createCoreDictionaryRegistry()

createTenantDictionaryRegistry

protected CMISDictionaryRegistry createTenantDictionaryRegistry(String tenant)

createDictionaryRegistryWithWriteLock

protected CMISDictionaryRegistry createDictionaryRegistryWithWriteLock()

createDictionaryRegistry

protected CMISDictionaryRegistry createDictionaryRegistry(String tenant)

findType

public TypeDefinitionWrapper findType(String typeId)

Description copied from interface: CMISDictionaryService

Find type for type id

Specified by:

findType in interface CMISDictionaryService

Parameters:

typeId - String

Returns:

TypeDefinitionWrapper

isExcluded

public boolean isExcluded(QName qname)

Specified by:

isExcluded in interface CMISDictionaryService

findTypeForClass

public TypeDefinitionWrapper findTypeForClass(QName clazz,
                                              org.apache.chemistry.opencmis.commons.enums.BaseTypeId... matchingScopes)

Description copied from interface: CMISDictionaryService

Find type for Alfresco class name. Optionally, constrain match to one of specified CMIS scopes

Specified by:

findTypeForClass in interface CMISDictionaryService

Parameters:

clazz - QName

matchingScopes - BaseTypeId...

Returns:

TypeDefinitionWrapper

findNodeType

public TypeDefinitionWrapper findNodeType(QName clazz)

Specified by:

findNodeType in interface CMISDictionaryService

findAssocType

public TypeDefinitionWrapper findAssocType(QName clazz)

Specified by:

findAssocType in interface CMISDictionaryService

findTypeByQueryName

public TypeDefinitionWrapper findTypeByQueryName(String queryName)

Description copied from interface: CMISDictionaryService

Find a type by its query name

Specified by:

findTypeByQueryName in interface CMISDictionaryService

Parameters:

queryName - String

Returns:

TypeDefinitionWrapper

findProperty

public PropertyDefinitionWrapper findProperty(String propId)

Specified by:

findProperty in interface CMISDictionaryService

findPropertyByQueryName

public PropertyDefinitionWrapper findPropertyByQueryName(String queryName)

Specified by:

findPropertyByQueryName in interface CMISDictionaryService

getBaseTypes

public List<TypeDefinitionWrapper> getBaseTypes()

Description copied from interface: CMISDictionaryService

Get Base Types

Specified by:

getBaseTypes in interface CMISDictionaryService

getBaseTypes

public List<TypeDefinitionWrapper> getBaseTypes(boolean includeParent)

Specified by:

getBaseTypes in interface CMISDictionaryService

getAllTypes

public List<TypeDefinitionWrapper> getAllTypes()

Description copied from interface: CMISDictionaryService

Get all Types

Specified by:

getAllTypes in interface CMISDictionaryService

getAllTypes

public List<TypeDefinitionWrapper> getAllTypes(boolean includeParent)

Specified by:

getAllTypes in interface CMISDictionaryService

findDataType

public org.apache.chemistry.opencmis.commons.enums.PropertyType findDataType(QName dataType)

Description copied from interface: CMISDictionaryService

Find data type

Specified by:

findDataType in interface CMISDictionaryService

Parameters:

dataType - QName

Returns:

PropertyType

findAlfrescoDataType

public QName findAlfrescoDataType(org.apache.chemistry.opencmis.commons.enums.PropertyType propertyType)

Specified by:

findAlfrescoDataType in interface CMISDictionaryService

onDictionaryInit

public void onDictionaryInit()

Description copied from interface: DictionaryListener

Callback for (re-)initialising the Dictionary caches (executed in the current tenant context)

Specified by:

onDictionaryInit in interface DictionaryListener

modelAdded

public void modelAdded(CompiledModel model,
                       String tenantDomain)

Specified by:

modelAdded in interface ExtendedDictionaryListener

afterDictionaryInit

public void afterDictionaryInit()

Description copied from interface: DictionaryListener

Callback once dictionary initialisation is complete (executed in the current tenant context)

Specified by:

afterDictionaryInit in interface DictionaryListener

afterDictionaryDestroy

public void afterDictionaryDestroy()

Description copied from interface: DictionaryListener

Callback once dictionary destroy is complete (executed in the current tenant context)

Specified by:

afterDictionaryDestroy in interface DictionaryListener

getChildren

public List<TypeDefinitionWrapper> getChildren(String typeId)

Specified by:

getChildren in interface CMISDictionaryService