Package org.alfresco.repo.dictionary

Class CustomModelServiceImpl

java.lang.Object

org.alfresco.repo.dictionary.CustomModelServiceImpl

All Implemented Interfaces:

CustomModelService

public class CustomModelServiceImpl
extends Object
implements CustomModelService

Custom Model Service Implementation

Author:

Jamal Kaabi-Mofrad

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY
static final QName	ASPECT_CUSTOM_MODEL
static final String	DEFAULT_CUSTOM_MODEL_ASPECT
static final String	GROUP_ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY
static final String	SHARE_EXT_MODULE_SUFFIX

Constructor Summary

Constructors

Constructor	Description
CustomModelServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activateCustomModel(String modelName)
CompiledModel	compileModel(M2Model m2Model)
CustomModelDefinition	createCustomModel(M2Model m2Model, boolean activate)
protected NodeRef	createCustomModelCopy(String newName, NodeRef modelNodeRef)	Creates a copy of the custom model where the created node will be a child of download container.
protected NodeRef	createCustomModelShareExtModuleRef(String modelName)	Finds the module element within the Share persisted-extension XML file and then writes the XML fragment as the content of a newly created node.
NodeRef	createDownloadNode(String modelFileName, boolean withAssociatedForm)
NodeRef	createDownloadNode(String modelFileName, boolean withAssociatedForm, String downloadNodeName)
void	deactivateCustomModel(String modelName)
void	deleteCustomModel(String modelName)
org.alfresco.query.PagingResults<AspectDefinition>	getAllCustomAspects(org.alfresco.query.PagingRequest pagingRequest)
protected List<CustomModelDefinition>	getAllCustomModels()
org.alfresco.query.PagingResults<TypeDefinition>	getAllCustomTypes(org.alfresco.query.PagingRequest pagingRequest)
AspectDefinition	getCustomAspect(QName name)
protected Pair<CompiledModel,Boolean>	getCustomCompiledModel(String modelName)	Returns compiled custom model and whether the model is active or not as a Pair object
ConstraintDefinition	getCustomConstraint(QName name)
CustomModelDefinition	getCustomModel(String modelName)
ModelDefinition	getCustomModelByUri(String namespaceUri)
org.alfresco.query.PagingResults<CustomModelDefinition>	getCustomModels(org.alfresco.query.PagingRequest pagingRequest)
CustomModelsInfo	getCustomModelsInfo()
TypeDefinition	getCustomType(QName name)
M2Model	getM2Model(NodeRef modelNodeRef)
Pair<String,String>	getModelNamespaceUriPrefix(M2Model model)
NodeRef	getModelNodeRef(String modelName)
protected NodeRef	getShareExtModule()	Gets Share persisted-extension nodeRef
void	init()	Checks that all necessary properties and services have been provided.
boolean	isModelAdmin(String userName)
boolean	isModelExists(String modelFileName)
boolean	isNamespacePrefixExists(String modelNamespacePrefix)
boolean	isNamespacePrefixExists(NodeRef modelNodeRef)
boolean	isNamespaceUriExists(String modelNamespaceUri)
void	setAuthorityService(AuthorityService authorityService)
void	setContentService(ContentService contentService)
void	setDictionaryDAO(DictionaryDAOImpl dictionaryDAO)
void	setDictionaryService(DictionaryService dictionaryService)
void	setDownloadService(DownloadService downloadSerivce)
void	setDownloadStorage(DownloadStorage downloadStorage)
void	setHiddenAspect(HiddenAspect hiddenAspect)
void	setNamespaceDAO(NamespaceDAO namespaceDAO)
void	setNodeService(NodeService nodeService)
void	setRepoAdminService(RepoAdminService repoAdminService)
void	setRepositoryModelsLocation(RepositoryLocation repoModelsLocation)
void	setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)
void	setSearchService(SearchService searchService)
void	setShareExtModulePath(String shareExtModulePath)
CustomModelDefinition	updateCustomModel(String modelFileName, M2Model m2Model, boolean activate)
void	validateModelNamespacePrefix(String prefix)
void	validateModelNamespacePrefix(NodeRef modelNodeRef)
protected <T> org.alfresco.query.PagingResults<T>	wrapResult(org.alfresco.query.PagingRequest pagingRequest, List<T> result)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CUSTOM_MODEL_ASPECT

public static final String DEFAULT_CUSTOM_MODEL_ASPECT

See Also:

• Constant Field Values

ASPECT_CUSTOM_MODEL

public static final QName ASPECT_CUSTOM_MODEL

ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY

public static final String ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY

See Also:

• Constant Field Values

GROUP_ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY

public static final String GROUP_ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY

See Also:

• Constant Field Values

SHARE_EXT_MODULE_SUFFIX

public static final String SHARE_EXT_MODULE_SUFFIX

See Also:

• Constant Field Values

Constructor Details

CustomModelServiceImpl

public CustomModelServiceImpl()

Method Details

setNodeService

public void setNodeService(NodeService nodeService)

setDictionaryDAO

public void setDictionaryDAO(DictionaryDAOImpl dictionaryDAO)

setContentService

public void setContentService(ContentService contentService)

setSearchService

public void setSearchService(SearchService searchService)

setRepositoryModelsLocation

public void setRepositoryModelsLocation(RepositoryLocation repoModelsLocation)

setDictionaryService

public void setDictionaryService(DictionaryService dictionaryService)

setNamespaceDAO

public void setNamespaceDAO(NamespaceDAO namespaceDAO)

setRetryingTransactionHelper

public void setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)

setRepoAdminService

public void setRepoAdminService(RepoAdminService repoAdminService)

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

setHiddenAspect

public void setHiddenAspect(HiddenAspect hiddenAspect)

setDownloadService

public void setDownloadService(DownloadService downloadSerivce)

setDownloadStorage

public void setDownloadStorage(DownloadStorage downloadStorage)

setShareExtModulePath

public void setShareExtModulePath(String shareExtModulePath)

init

public void init()

Checks that all necessary properties and services have been provided.

getModelNodeRef

public NodeRef getModelNodeRef(String modelName)

Specified by:

getModelNodeRef in interface CustomModelService

getM2Model

public M2Model getM2Model(NodeRef modelNodeRef)

Specified by:

getM2Model in interface CustomModelService

getCustomModel

public CustomModelDefinition getCustomModel(String modelName)

Specified by:

getCustomModel in interface CustomModelService

getCustomModelByUri

public ModelDefinition getCustomModelByUri(String namespaceUri)

Specified by:

getCustomModelByUri in interface CustomModelService

getCustomCompiledModel

protected Pair<CompiledModel,Boolean> getCustomCompiledModel(String modelName)

Returns compiled custom model and whether the model is active or not as a Pair object

Parameters:

modelName - the name of the custom model to retrieve

Returns:

the Pair<CompiledModel, Boolean> (or null, if it doesn't exist)

getCustomModels

public org.alfresco.query.PagingResults<CustomModelDefinition> getCustomModels(org.alfresco.query.PagingRequest pagingRequest)

Specified by:

getCustomModels in interface CustomModelService

getAllCustomModels

protected List<CustomModelDefinition> getAllCustomModels()

getCustomAspect

public AspectDefinition getCustomAspect(QName name)

Specified by:

getCustomAspect in interface CustomModelService

getAllCustomAspects

public org.alfresco.query.PagingResults<AspectDefinition> getAllCustomAspects(org.alfresco.query.PagingRequest pagingRequest)

Specified by:

getAllCustomAspects in interface CustomModelService

getCustomType

public TypeDefinition getCustomType(QName name)

Specified by:

getCustomType in interface CustomModelService

getAllCustomTypes

public org.alfresco.query.PagingResults<TypeDefinition> getAllCustomTypes(org.alfresco.query.PagingRequest pagingRequest)

Specified by:

getAllCustomTypes in interface CustomModelService

getCustomConstraint

public ConstraintDefinition getCustomConstraint(QName name)

Specified by:

getCustomConstraint in interface CustomModelService

createCustomModel

public CustomModelDefinition createCustomModel(M2Model m2Model,
 boolean activate)

Specified by:

createCustomModel in interface CustomModelService

updateCustomModel

public CustomModelDefinition updateCustomModel(String modelFileName,
 M2Model m2Model,
 boolean activate)

Specified by:

updateCustomModel in interface CustomModelService

compileModel

public CompiledModel compileModel(M2Model m2Model)

Specified by:

compileModel in interface CustomModelService

wrapResult

protected <T> org.alfresco.query.PagingResults<T> wrapResult(org.alfresco.query.PagingRequest pagingRequest,
 List<T> result)

isModelAdmin

public boolean isModelAdmin(String userName)

Specified by:

isModelAdmin in interface CustomModelService

activateCustomModel

public void activateCustomModel(String modelName)

Specified by:

activateCustomModel in interface CustomModelService

deactivateCustomModel

public void deactivateCustomModel(String modelName)

Specified by:

deactivateCustomModel in interface CustomModelService

deleteCustomModel

public void deleteCustomModel(String modelName)

Specified by:

deleteCustomModel in interface CustomModelService

isNamespaceUriExists

public boolean isNamespaceUriExists(String modelNamespaceUri)

Specified by:

isNamespaceUriExists in interface CustomModelService

isNamespacePrefixExists

public boolean isNamespacePrefixExists(String modelNamespacePrefix)

Specified by:

isNamespacePrefixExists in interface CustomModelService

isNamespacePrefixExists

public boolean isNamespacePrefixExists(NodeRef modelNodeRef)

Specified by:

isNamespacePrefixExists in interface CustomModelService

isModelExists

public boolean isModelExists(String modelFileName)

Specified by:

isModelExists in interface CustomModelService

getModelNamespaceUriPrefix

public Pair<String,String> getModelNamespaceUriPrefix(M2Model model)

Specified by:

getModelNamespaceUriPrefix in interface CustomModelService

validateModelNamespacePrefix

public void validateModelNamespacePrefix(String prefix)

Specified by:

validateModelNamespacePrefix in interface CustomModelService

validateModelNamespacePrefix

public void validateModelNamespacePrefix(NodeRef modelNodeRef)

Specified by:

validateModelNamespacePrefix in interface CustomModelService

createDownloadNode

public NodeRef createDownloadNode(String modelFileName,
 boolean withAssociatedForm)

Specified by:

createDownloadNode in interface CustomModelService

createDownloadNode

public NodeRef createDownloadNode(String modelFileName,
 boolean withAssociatedForm,
 String downloadNodeName)

Specified by:

createDownloadNode in interface CustomModelService

createCustomModelShareExtModuleRef

protected NodeRef createCustomModelShareExtModuleRef(String modelName)

Finds the module element within the Share persisted-extension XML file and then writes the XML fragment as the content of a newly created node.

Parameters:

modelName - the model name

Returns:

the created nodeRef

getShareExtModule

protected NodeRef getShareExtModule()

Gets Share persisted-extension nodeRef

createCustomModelCopy

protected NodeRef createCustomModelCopy(String newName,
 NodeRef modelNodeRef)

Creates a copy of the custom model where the created node will be a child of download container.

Parameters:

newName - the model new name

modelNodeRef - existing model nodeRef

Returns:

the created nodeRef

getCustomModelsInfo

public CustomModelsInfo getCustomModelsInfo()

Specified by:

getCustomModelsInfo in interface CustomModelService