org.jahia.services.templates

Class TemplatePackageRegistry

java.lang.Object

org.jahia.services.templates.TemplatePackageRegistry

public class TemplatePackageRegistry
extends Object

Template packages registry service.

Author:

Sergiy Shyrkov

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<JahiaTemplatesPackage>	TEMPLATE_PACKAGE_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
TemplatePackageRegistry() Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addModuleWithViewsForComponent(String component, JahiaTemplatesPackage module)
void	addPackageForResourceBundle(String bundle, JahiaTemplatesPackage module)
void	afterInitializationForModule(JahiaTemplatesPackage pack)
void	afterInitializationForModules()
boolean	areVersionsForModuleAvailable(String moduleNameOrId)
boolean	computeDependencies(JahiaTemplatesPackage pack) Compute package dependencies
boolean	contains(String moduleName) Checks if the specified template set is present in the repository.
boolean	containsAll(List<String> moduleNames) Checks if specified template sets are all present in the repository.
boolean	containsId(String moduleId)
Map<String,Action>	getActions()
Map<String,SortedMap<ModuleVersion,JahiaTemplatesPackage>>	getAllModuleVersions()
List<JahiaTemplatesPackage>	getAvailablePackages() Returns a list of all available template packages.
int	getAvailablePackagesCount() Returns the number of available template packages in the registry.
Set<ModuleVersion>	getAvailableVersionsForModule(String moduleNameOrId)
Map<String,BackgroundAction>	getBackgroundActions()
List<JahiaTemplatesPackage>	getDependantModules(JahiaTemplatesPackage module)
List<JahiaTemplatesPackage>	getDependantModules(JahiaTemplatesPackage module, boolean includeNonStarted)
List<ErrorHandler>	getErrorHandlers() Returns a list of ErrorHandler instances
String	getModuleId(String moduleNameOrId)
Set<String>	getModuleIds()
Set<String>	getModuleNames()
Map<String,Set<JahiaTemplatesPackage>>	getModulesWithViewsPerComponents()
JahiaTemplatesPackage	getPackageForResourceBundle(String resourceBundle)
Map<String,JahiaTemplatesPackage>	getRegisteredModules()
List<RenderFilter>	getRenderFilters() Returns a list of RenderFilter instances, configured for the specified templates package.
List<org.springframework.web.servlet.HandlerMapping>	getSpringHandlerMappings()
void	handleJCREventListener(Object bean, boolean register)
boolean	hasEncounteredIssuesWithDefinitions() Indicates if any issue related to the definitions has been encountered since the last startup.
boolean	isAfterInitializeDone()
JahiaTemplatesPackage	lookup(String packageName) Returns the requested template package or null if the package with the specified name is not registered in the repository.
JahiaTemplatesPackage	lookupByBundle(org.osgi.framework.Bundle osgiBundle) Returns the template package that corresponds to the provided OSGi bundle or null if the package is not registered.
JahiaTemplatesPackage	lookupByFileName(String fileName) Deprecated. use lookupById(String) instead
JahiaTemplatesPackage	lookupByFileNameAndVersion(String fileName, ModuleVersion moduleVersion) Deprecated. use lookupByIdAndVersion(String, ModuleVersion) instead
JahiaTemplatesPackage	lookupById(String moduleId) Returns the requested template package or null if the package with the specified Id is not registered in the repository.
JahiaTemplatesPackage	lookupByIdAndVersion(String moduleId, ModuleVersion moduleVersion)
JahiaTemplatesPackage	lookupByNameAndVersion(String moduleName, ModuleVersion moduleVersion)
void	register(JahiaTemplatesPackage templatePackage) Adds the template package to the repository.
void	registerPackageVersion(JahiaTemplatesPackage pack)
void	removeModuleWithViewsForComponent(String component, JahiaTemplatesPackage module)
void	reset()
void	resetBeanModules()
void	unregister(JahiaTemplatesPackage templatePackage)
void	unregisterPackageVersion(JahiaTemplatesPackage pack)

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_PACKAGE_COMPARATOR

public static final Comparator<JahiaTemplatesPackage> TEMPLATE_PACKAGE_COMPARATOR

Constructor Detail

TemplatePackageRegistry

public TemplatePackageRegistry()

Initializes an instance of this class.

Method Detail

getActions

public Map<String,Action> getActions()

getBackgroundActions

public Map<String,BackgroundAction> getBackgroundActions()

getSpringHandlerMappings

public List<org.springframework.web.servlet.HandlerMapping> getSpringHandlerMappings()

getErrorHandlers

public List<ErrorHandler> getErrorHandlers()

Returns a list of ErrorHandler instances

Returns:

a list of ErrorHandler instances

getModulesWithViewsPerComponents

public Map<String,Set<JahiaTemplatesPackage>> getModulesWithViewsPerComponents()

addModuleWithViewsForComponent

public void addModuleWithViewsForComponent(String component,
                                           JahiaTemplatesPackage module)

removeModuleWithViewsForComponent

public void removeModuleWithViewsForComponent(String component,
                                              JahiaTemplatesPackage module)

afterInitializationForModules

public void afterInitializationForModules()

isAfterInitializeDone

public boolean isAfterInitializeDone()

afterInitializationForModule

public void afterInitializationForModule(JahiaTemplatesPackage pack)

contains

public boolean contains(String moduleName)

Checks if the specified template set is present in the repository.

Parameters:

moduleName - the template package name to check for

Returns:

true, if the specified template package already exists in the repository

containsAll

public boolean containsAll(List<String> moduleNames)

Checks if specified template sets are all present in the repository.

Parameters:

moduleNames - the list of template package names to check for

Returns:

true, if specified template packages are all present in the repository

containsId

public boolean containsId(String moduleId)

getAvailablePackages

public List<JahiaTemplatesPackage> getAvailablePackages()

Returns a list of all available template packages.

Returns:

a list of all available template packages

getAvailablePackagesCount

public int getAvailablePackagesCount()

Returns the number of available template packages in the registry.

Returns:

the number of available template packages in the registry

getAvailableVersionsForModule

public Set<ModuleVersion> getAvailableVersionsForModule(String moduleNameOrId)

areVersionsForModuleAvailable

public boolean areVersionsForModuleAvailable(String moduleNameOrId)

getAllModuleVersions

public Map<String,SortedMap<ModuleVersion,JahiaTemplatesPackage>> getAllModuleVersions()

getModuleId

public String getModuleId(String moduleNameOrId)

getModuleIds

public Set<String> getModuleIds()

getModuleNames

public Set<String> getModuleNames()

getRegisteredModules

public Map<String,JahiaTemplatesPackage> getRegisteredModules()

getRenderFilters

public List<RenderFilter> getRenderFilters()

Returns a list of RenderFilter instances, configured for the specified templates package.

Returns:

a list of RenderFilter instances, configured for the specified templates package

hasEncounteredIssuesWithDefinitions

public final boolean hasEncounteredIssuesWithDefinitions()

Indicates if any issue related to the definitions has been encountered since the last startup. When this method returns true, the only way to get back false as a return value is to restart Jahia.

Returns:

true if an issue with the def has been encountered, false otherwise.

Since:

6.6.2.0

lookup

public JahiaTemplatesPackage lookup(String packageName)

Returns the requested template package or null if the package with the specified name is not registered in the repository.

Parameters:

packageName - the template package name to search for

Returns:

the requested template package or null if the package with the specified name is not registered in the repository

lookupByBundle

public JahiaTemplatesPackage lookupByBundle(org.osgi.framework.Bundle osgiBundle)

Returns the template package that corresponds to the provided OSGi bundle or null if the package is not registered.

Parameters:

osgiBundle - the corresponding OSGi bundle

Returns:

the template package that corresponds to the provided OSGi bundle or null if the package is not registered

lookupByFileName

@Deprecated
public JahiaTemplatesPackage lookupByFileName(String fileName)

Deprecated. use lookupById(String) instead

Returns the requested template package or null if the package with the specified file name is not registered in the repository.

Parameters:

fileName - the template package Id to search for

Returns:

the requested template package or null if the package with the specified file name is not registered in the repository

lookupById

public JahiaTemplatesPackage lookupById(String moduleId)

Returns the requested template package or null if the package with the specified Id is not registered in the repository.

Parameters:

moduleId - the template package Id to search for

Returns:

the requested template package or null if the package with the specified Id is not registered in the repository

lookupByNameAndVersion

public JahiaTemplatesPackage lookupByNameAndVersion(String moduleName,
                                                    ModuleVersion moduleVersion)

lookupByFileNameAndVersion

@Deprecated
public JahiaTemplatesPackage lookupByFileNameAndVersion(String fileName,
                                                                    ModuleVersion moduleVersion)

Deprecated. use lookupByIdAndVersion(String, ModuleVersion) instead

lookupByIdAndVersion

public JahiaTemplatesPackage lookupByIdAndVersion(String moduleId,
                                                  ModuleVersion moduleVersion)

registerPackageVersion

public void registerPackageVersion(JahiaTemplatesPackage pack)

unregisterPackageVersion

public void unregisterPackageVersion(JahiaTemplatesPackage pack)

register

public void register(JahiaTemplatesPackage templatePackage)

Adds the template package to the repository.

Parameters:

templatePackage - the template package to add

getPackageForResourceBundle

public JahiaTemplatesPackage getPackageForResourceBundle(String resourceBundle)

addPackageForResourceBundle

public void addPackageForResourceBundle(String bundle,
                                        JahiaTemplatesPackage module)

computeDependencies

public boolean computeDependencies(JahiaTemplatesPackage pack)

Compute package dependencies

Parameters:

pack - package to compute dependencies

Returns:

true

getDependantModules

public List<JahiaTemplatesPackage> getDependantModules(JahiaTemplatesPackage module)

getDependantModules

public List<JahiaTemplatesPackage> getDependantModules(JahiaTemplatesPackage module,
                                                       boolean includeNonStarted)

reset

public void reset()

unregister

public void unregister(JahiaTemplatesPackage templatePackage)

resetBeanModules

public void resetBeanModules()

handleJCREventListener

public void handleJCREventListener(Object bean,
                                   boolean register)