org.jahia.services.templates

Class JahiaTemplateManagerService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.templates.JahiaTemplateManagerService

All Implemented Interfaces:

EventListener, JahiaAfterInitializationService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

public class JahiaTemplateManagerService
extends JahiaService
implements org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>, JahiaAfterInitializationService

Template and template set deployment and management service.

Author:

Sergiy Shyrkov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JahiaTemplateManagerService.ModuleDependenciesEvent Is fired when the module dependencies are changed.
static class	JahiaTemplateManagerService.ModuleDeployedOnSiteEvent Event indicates that a module was either installed to the specified site or uninstalled from it.
static class	JahiaTemplateManagerService.TemplatePackageRedeployedEvent This event is fired when a template module is re-deployed (in runtime, not on the server startup).

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	DEFAULT_MODULES_WITH_NO_DEFAUL_DEPENDENCY
static String	MODULE_TYPE_MODULE
static String	MODULE_TYPE_SYSTEM
static String	MODULE_TYPE_TEMPLATES_SET
static Comparator<JahiaTemplatesPackage>	TEMPLATE_PACKAGE_NAME_COMPARATOR

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
JahiaTemplateManagerService()

Method Summary

Modifier and Type	Method and Description
JahiaTemplatesPackage	activateModuleVersion(String moduleId, String version)
void	autoInstallModulesToSites(JahiaTemplatesPackage module, JCRSessionWrapper session)
boolean	checkExistingContent(String module) Check if any content is created with definitions in this module
JCRNodeWrapper	checkoutModule(File moduleSources, String scmURI, String branchOrTag, String moduleId, String version, JCRSessionWrapper session) Checkout module sources, compile and deploy
File	checkoutTempModule(String scmURI, String branchOrTag, String moduleId, String version)
boolean	checkValidSources(JahiaTemplatesPackage pack, File sources)
JahiaTemplatesPackage	compileAndDeploy(String moduleId, File sources, JCRSessionWrapper session)
File	compileModule(File sources)
JCRNodeWrapper	createModule(String moduleName, String artifactId, String groupId, String moduleType, File sources, JCRSessionWrapper session)
JahiaTemplatesPackage	deployModule(File warFile, JCRSessionWrapper session)
void	deployToMaven(String groupId, String artifactId, ModuleReleaseInfo releaseInfo, File generatedWar)
boolean	differentModuleWithSameIdExists(String symbolicName, String groupId)
JahiaTemplatesPackage	duplicateModule(String moduleName, String moduleId, String groupId, String srcPath, String scmURI, String branchOrTag, String srcModuleId, String srcModuleVersion, boolean uninstallSrcModule, String dstPath, boolean deleteSrcFolder, JCRSessionWrapper session)
void	fireTemplatePackageRedeployedEvent(JahiaTemplatesPackage aPackage) Fires a Spring event in core context and contexts of all modules to notify listeners about the fact that a module bundle is either started or stopped.
Map<String,Action>	getActions()
JahiaTemplatesPackage	getAnyDeployedTemplatePackage(String templatePackage)
List<JahiaTemplatesPackage>	getAvailableTemplatePackages() Returns a list of all available template packages.
int	getAvailableTemplatePackagesCount() Returns the number of available template packages in the registry.
Map<String,BackgroundAction>	getBackgroundActions()
List<ErrorHandler>	getErrorHandler()
Set<org.osgi.framework.Bundle>	getInitializedBundles()
Set<org.osgi.framework.Bundle>	getInstalledBundles()
List<JahiaTemplatesPackage>	getInstalledModulesForSite(String siteKey, boolean includeTemplateSet, boolean includeDirectDependencies, boolean includeTransitiveDependencies) get List of installed modules for a site.
Set<String>	getKnownFragmentHosts() Returns a set of symbolic names for bundles, which are known to be target hosts for fragments.
List<org.osgi.framework.Bundle>	getModulesByState(ModuleState.State state) Returns list of module bundles in the specified state.
Map<org.osgi.framework.Bundle,ModuleState>	getModuleStates()
Set<String>	getModulesWithNoDefaultDependency()
Set<JahiaTemplatesPackage>	getModulesWithViewsForComponent(String componentName) Returns a set of all available template packages having templates for a module.
List<String>	getNonManageableModules()
List<JahiaTemplatesPackage>	getNonSystemModulePackages()
List<JahiaTemplatesPackage>	getNonSystemTemplateSetPackages()
Map<org.osgi.framework.Bundle,JahiaTemplatesPackage>	getRegisteredBundles()
List<RenderFilter>	getRenderFilters() Returns a list of RenderFilter instances, configured for the specified templates package.
SourceControlFactory	getSourceControlFactory()
File	getSources(JahiaTemplatesPackage pack, JCRSessionWrapper session)
JahiaTemplatesPackage	getTemplatePackage(String packageName) Returns the requested template package for the specified site or null if the package with the specified name is not registered in the repository.
JahiaTemplatesPackage	getTemplatePackageByFileName(String fileName) Deprecated. use getTemplatePackageById(String) instead
JahiaTemplatesPackage	getTemplatePackageById(String moduleId) Returns the requested template package for the specified site or null if the package with the specified Id is not registered in the repository.
Map<String,JahiaTemplatesPackage>	getTemplatePackageByNodeName() Returns the lookup map for template packages by the JCR node name.
TemplatePackageDeployer	getTemplatePackageDeployer()
TemplatePackageRegistry	getTemplatePackageRegistry()
Set<String>	getTemplateSetNames() Returns a set of existing template sets that are available for site creation.
Map<String,List<org.osgi.framework.Bundle>>	getToBeResolved()
String	guessBranchOrTag(String moduleVersion, String scm, Set<String> branchOrTags)
boolean	hasEncounteredIssuesWithDefinitions() Indicates if any issue related to the definitions has been encountered since the last startup.
void	initAfterAllServicesAreStarted()
JCRNodeWrapper	installFromSources(File sources, JCRSessionWrapper session)
void	installModule(JahiaTemplatesPackage module, String sitePath, JCRSessionWrapper session)
void	installModule(String moduleId, String sitePath, String username)
void	installModule(String moduleId, String version, String sitePath, String username)
void	installModuleOnAllSites(JahiaTemplatesPackage module, JCRSessionWrapper sessionWrapper, List<JCRNodeWrapper> sites) Install module in provided list of site
void	installModules(List<JahiaTemplatesPackage> modules, String sitePath, JCRSessionWrapper session)
boolean	isTemplatePresent(String templateName, Set<String> templateSetNames) Checks if the specified template is available either in one of the requested template sets or modules.
boolean	isTemplatePresent(String templateName, String templateSetName) Checks if the specified template is available either in the requested template set or in one of the deployed modules.
Map<String,String>	listBranches(String scmURI)
Map<String,String>	listTags(String scmURI)
void	onApplicationEvent(org.springframework.context.ApplicationEvent event)
List<File>	regenerateImportFile(String moduleId, File sources, JCRSessionWrapper session)
File	releaseModule(JahiaTemplatesPackage module, ModuleReleaseInfo releaseInfo, File sources, String scmUrl, JCRSessionWrapper session)
File	releaseModule(String moduleId, ModuleReleaseInfo releaseInfo, JCRSessionWrapper session)
void	sendToSourceControl(String moduleId, String scmURI, String scmType, JCRSessionWrapper session)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setForgeHelper(org.jahia.services.templates.ForgeHelper forgeHelper) Injects an instance of the helper class for Private App Store related operations.
void	setKnownFragmentHosts(Set<String> knownFragmentHosts) Defines a set of symbolic names for bundles, which are known to be target hosts for fragments.
void	setModuleBuildHelper(ModuleBuildHelper moduleBuildHelper)
void	setModuleInstallationHelper(ModuleInstallationHelper moduleInstallationHelper)
void	setModuleManager(ModuleManager moduleManager)
void	setModuleStates(Map<org.osgi.framework.Bundle,ModuleState> moduleStates)
void	setModulesWithNoDefaultDependency(Set<String> modulesWithNoDefaultDependency)
void	setNonManageableModules(List<String> nonManageableModules)
void	setSiteService(JahiaSitesService siteService)
void	setSourceControlHelper(SourceControlHelper scmHelper) Injects an instance of the SCM helper.
void	setSourcesFolderInPackage(JahiaTemplatesPackage pack, File sources)
void	setTemplatePackageDeployer(TemplatePackageDeployer deployer)
void	setTemplatePackageRegistry(TemplatePackageRegistry registry)
void	setXmlIndentation(int i)
void	start()
void	stop()
JahiaTemplatesPackage	stopModule(String moduleId)
void	synchro(JCRNodeWrapper source, JCRNodeWrapper destinationNode, JCRSessionWrapper session, String moduleName, Map<String,List<String>> references)
void	templatesSynchro(JCRNodeWrapper source, JCRNodeWrapper destinationNode, JCRSessionWrapper session, Map<String,List<String>> references, boolean doUpdate, boolean doChildren)
void	undeployModule(JahiaTemplatesPackage pack)
void	undeployModule(String moduleId, String version)
void	uninstallModule(JahiaTemplatesPackage module, String sitePath, JCRSessionWrapper session)
void	uninstallModule(String module, String sitePath, String username, boolean purgeAllContent)
void	uninstallModules(List<JahiaTemplatesPackage> modules, String sitePath, JCRSessionWrapper session)
void	uninstallModulesByIds(List<String> moduleIds, String sitePath, JCRSessionWrapper session)
void	uninstallModulesFromAllSites(List<String> modules, JCRSessionWrapper session)
void	uninstallModulesFromAllSites(String module, JCRSessionWrapper session)
void	uninstallModulesFromAllSites(String module, String username, boolean purgeAllContent)
void	updateDependencies(JahiaTemplatesPackage pack, List<String> depends)

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MODULES_WITH_NO_DEFAUL_DEPENDENCY

public static final Set<String> DEFAULT_MODULES_WITH_NO_DEFAUL_DEPENDENCY

MODULE_TYPE_MODULE

public static final String MODULE_TYPE_MODULE

See Also:

Constant Field Values

MODULE_TYPE_SYSTEM

public static final String MODULE_TYPE_SYSTEM

See Also:

Constant Field Values

MODULE_TYPE_TEMPLATES_SET

public static final String MODULE_TYPE_TEMPLATES_SET

See Also:

Constant Field Values

TEMPLATE_PACKAGE_NAME_COMPARATOR

public static final Comparator<JahiaTemplatesPackage> TEMPLATE_PACKAGE_NAME_COMPARATOR

Constructor Detail

JahiaTemplateManagerService

public JahiaTemplateManagerService()

Method Detail

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setSiteService

public void setSiteService(JahiaSitesService siteService)

setTemplatePackageRegistry

public void setTemplatePackageRegistry(TemplatePackageRegistry registry)

setTemplatePackageDeployer

public void setTemplatePackageDeployer(TemplatePackageDeployer deployer)

getTemplatePackageDeployer

public TemplatePackageDeployer getTemplatePackageDeployer()

getTemplatePackageRegistry

public TemplatePackageRegistry getTemplatePackageRegistry()

getSourceControlFactory

public SourceControlFactory getSourceControlFactory()

setXmlIndentation

public void setXmlIndentation(int i)

getNonManageableModules

public List<String> getNonManageableModules()

setNonManageableModules

public void setNonManageableModules(List<String> nonManageableModules)

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()
          throws JahiaException

Specified by:

stop in class JahiaService

Throws:

JahiaException

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

checkoutModule

public JCRNodeWrapper checkoutModule(File moduleSources,
                                     String scmURI,
                                     String branchOrTag,
                                     String moduleId,
                                     String version,
                                     JCRSessionWrapper session)
                              throws IOException,
                                     javax.jcr.RepositoryException,
                                     org.osgi.framework.BundleException

Checkout module sources, compile and deploy

Parameters:

moduleSources - sources folder

scmURI - scm uri ( in mvn format , scm::

branchOrTag - branch or tag

moduleId - name of the module to checkout, if there are multiple modules in the repository

version - version of the module to checkout, if there are multiple modules in the repository

session - session

Returns:

the module node

Throws:

IOException

javax.jcr.RepositoryException - in case of JCR-related errors

org.osgi.framework.BundleException

checkoutTempModule

public File checkoutTempModule(String scmURI,
                               String branchOrTag,
                               String moduleId,
                               String version)
                        throws javax.jcr.RepositoryException,
                               org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                               org.dom4j.DocumentException,
                               IOException

Throws:

javax.jcr.RepositoryException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

org.dom4j.DocumentException

IOException

duplicateModule

public JahiaTemplatesPackage duplicateModule(String moduleName,
                                             String moduleId,
                                             String groupId,
                                             String srcPath,
                                             String scmURI,
                                             String branchOrTag,
                                             String srcModuleId,
                                             String srcModuleVersion,
                                             boolean uninstallSrcModule,
                                             String dstPath,
                                             boolean deleteSrcFolder,
                                             JCRSessionWrapper session)
                                      throws IOException,
                                             javax.jcr.RepositoryException,
                                             org.osgi.framework.BundleException

Throws:

IOException

javax.jcr.RepositoryException

org.osgi.framework.BundleException

createModule

public JCRNodeWrapper createModule(String moduleName,
                                   String artifactId,
                                   String groupId,
                                   String moduleType,
                                   File sources,
                                   JCRSessionWrapper session)
                            throws IOException,
                                   javax.jcr.RepositoryException,
                                   org.osgi.framework.BundleException

Throws:

IOException

javax.jcr.RepositoryException

org.osgi.framework.BundleException

deployModule

public JahiaTemplatesPackage deployModule(File warFile,
                                          JCRSessionWrapper session)
                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

compileAndDeploy

public JahiaTemplatesPackage compileAndDeploy(String moduleId,
                                              File sources,
                                              JCRSessionWrapper session)
                                       throws javax.jcr.RepositoryException,
                                              IOException,
                                              org.osgi.framework.BundleException

Throws:

javax.jcr.RepositoryException

IOException

org.osgi.framework.BundleException

compileModule

public File compileModule(File sources)
                   throws IOException

Throws:

IOException

installFromSources

public JCRNodeWrapper installFromSources(File sources,
                                         JCRSessionWrapper session)
                                  throws IOException,
                                         javax.jcr.RepositoryException,
                                         org.osgi.framework.BundleException

Throws:

IOException

javax.jcr.RepositoryException

org.osgi.framework.BundleException

getSources

public File getSources(JahiaTemplatesPackage pack,
                       JCRSessionWrapper session)
                throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

sendToSourceControl

public void sendToSourceControl(String moduleId,
                                String scmURI,
                                String scmType,
                                JCRSessionWrapper session)
                         throws javax.jcr.RepositoryException,
                                IOException

Throws:

javax.jcr.RepositoryException

IOException

listTags

public Map<String,String> listTags(String scmURI)
                            throws IOException

Throws:

IOException

listBranches

public Map<String,String> listBranches(String scmURI)
                                throws IOException

Throws:

IOException

guessBranchOrTag

public String guessBranchOrTag(String moduleVersion,
                               String scm,
                               Set<String> branchOrTags)

checkValidSources

public boolean checkValidSources(JahiaTemplatesPackage pack,
                                 File sources)

releaseModule

public File releaseModule(String moduleId,
                          ModuleReleaseInfo releaseInfo,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException,
                          IOException,
                          org.osgi.framework.BundleException

Throws:

javax.jcr.RepositoryException

IOException

org.osgi.framework.BundleException

releaseModule

public File releaseModule(JahiaTemplatesPackage module,
                          ModuleReleaseInfo releaseInfo,
                          File sources,
                          String scmUrl,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException,
                          IOException,
                          org.osgi.framework.BundleException

Throws:

javax.jcr.RepositoryException

IOException

org.osgi.framework.BundleException

deployToMaven

public void deployToMaven(String groupId,
                          String artifactId,
                          ModuleReleaseInfo releaseInfo,
                          File generatedWar)
                   throws IOException

Throws:

IOException

regenerateImportFile

public List<File> regenerateImportFile(String moduleId,
                                       File sources,
                                       JCRSessionWrapper session)
                                throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

updateDependencies

public void updateDependencies(JahiaTemplatesPackage pack,
                               List<String> depends)

fireTemplatePackageRedeployedEvent

public void fireTemplatePackageRedeployedEvent(JahiaTemplatesPackage aPackage)

Fires a Spring event in core context and contexts of all modules to notify listeners about the fact that a module bundle is either started or stopped.

Parameters:

aPackage - the module that generated this event

setSourcesFolderInPackage

public void setSourcesFolderInPackage(JahiaTemplatesPackage pack,
                                      File sources)

getInstalledModulesForSite

public List<JahiaTemplatesPackage> getInstalledModulesForSite(String siteKey,
                                                              boolean includeTemplateSet,
                                                              boolean includeDirectDependencies,
                                                              boolean includeTransitiveDependencies)
                                                       throws JahiaException

get List of installed modules for a site.

Parameters:

siteKey - key of the site

includeTemplateSet - if true (default is false) include dependencies of the template set

includeDirectDependencies - if true (default is false) include dependencies of dependencies

includeTransitiveDependencies - if true (default is false) include all dependencies

Returns:

list of template packages

Throws:

JahiaException

autoInstallModulesToSites

public void autoInstallModulesToSites(JahiaTemplatesPackage module,
                                      JCRSessionWrapper session)
                               throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

installModuleOnAllSites

public void installModuleOnAllSites(JahiaTemplatesPackage module,
                                    JCRSessionWrapper sessionWrapper,
                                    List<JCRNodeWrapper> sites)
                             throws javax.jcr.RepositoryException

Install module in provided list of site

Parameters:

module - : module to install

sessionWrapper - : session to use

sites - : list of sites on which deploy the module

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

installModule

public void installModule(String moduleId,
                          String sitePath,
                          String username)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

installModule

public void installModule(String moduleId,
                          String version,
                          String sitePath,
                          String username)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

installModule

public void installModule(JahiaTemplatesPackage module,
                          String sitePath,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

installModules

public void installModules(List<JahiaTemplatesPackage> modules,
                           String sitePath,
                           JCRSessionWrapper session)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

synchro

public void synchro(JCRNodeWrapper source,
                    JCRNodeWrapper destinationNode,
                    JCRSessionWrapper session,
                    String moduleName,
                    Map<String,List<String>> references)
             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

templatesSynchro

public void templatesSynchro(JCRNodeWrapper source,
                             JCRNodeWrapper destinationNode,
                             JCRSessionWrapper session,
                             Map<String,List<String>> references,
                             boolean doUpdate,
                             boolean doChildren)
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

uninstallModule

public void uninstallModule(String module,
                            String sitePath,
                            String username,
                            boolean purgeAllContent)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

uninstallModule

public void uninstallModule(JahiaTemplatesPackage module,
                            String sitePath,
                            JCRSessionWrapper session)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

uninstallModules

public void uninstallModules(List<JahiaTemplatesPackage> modules,
                             String sitePath,
                             JCRSessionWrapper session)
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

uninstallModulesByIds

public void uninstallModulesByIds(List<String> moduleIds,
                                  String sitePath,
                                  JCRSessionWrapper session)
                           throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

uninstallModulesFromAllSites

public void uninstallModulesFromAllSites(String module,
                                         String username,
                                         boolean purgeAllContent)
                                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

uninstallModulesFromAllSites

public void uninstallModulesFromAllSites(String module,
                                         JCRSessionWrapper session)
                                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

uninstallModulesFromAllSites

public void uninstallModulesFromAllSites(List<String> modules,
                                         JCRSessionWrapper session)
                                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

checkExistingContent

public boolean checkExistingContent(String module)
                             throws javax.jcr.RepositoryException

Check if any content is created with definitions in this module

Parameters:

module -

Returns:

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

getAvailableTemplatePackages

public List<JahiaTemplatesPackage> getAvailableTemplatePackages()

Returns a list of all available template packages.

Returns:

a list of all available template packages

getNonSystemTemplateSetPackages

public List<JahiaTemplatesPackage> getNonSystemTemplateSetPackages()

getNonSystemModulePackages

public List<JahiaTemplatesPackage> getNonSystemModulePackages()

getAvailableTemplatePackagesCount

public int getAvailableTemplatePackagesCount()

Returns the number of available template packages in the registry.

Returns:

the number of available template packages in the registry

getActions

public Map<String,Action> getActions()

getBackgroundActions

public Map<String,BackgroundAction> getBackgroundActions()

getErrorHandler

public List<ErrorHandler> getErrorHandler()

getTemplatePackageByFileName

public JahiaTemplatesPackage getTemplatePackageByFileName(String fileName)

Deprecated. use getTemplatePackageById(String) instead

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

Parameters:

fileName - the template package fileName to search for

Returns:

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

getTemplatePackageById

public JahiaTemplatesPackage getTemplatePackageById(String moduleId)

Returns the requested template package for the specified site 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

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

getModulesWithViewsForComponent

public Set<JahiaTemplatesPackage> getModulesWithViewsForComponent(String componentName)

Returns a set of all available template packages having templates for a module.

Returns:

a set of all available template packages

getTemplatePackage

public JahiaTemplatesPackage getTemplatePackage(String packageName)

Returns the requested template package for the specified site 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

getTemplatePackageByNodeName

public Map<String,JahiaTemplatesPackage> getTemplatePackageByNodeName()

Returns the lookup map for template packages by the JCR node name.

Returns:

the lookup map for template packages by the JCR node name

getAnyDeployedTemplatePackage

public JahiaTemplatesPackage getAnyDeployedTemplatePackage(String templatePackage)

getTemplateSetNames

public Set<String> getTemplateSetNames()

Returns a set of existing template sets that are available for site creation.

Returns:

a set of existing template sets that are available for site creation

activateModuleVersion

public JahiaTemplatesPackage activateModuleVersion(String moduleId,
                                                   String version)
                                            throws javax.jcr.RepositoryException,
                                                   org.osgi.framework.BundleException

Throws:

javax.jcr.RepositoryException

org.osgi.framework.BundleException

stopModule

public JahiaTemplatesPackage stopModule(String moduleId)
                                 throws javax.jcr.RepositoryException,
                                        org.osgi.framework.BundleException

Throws:

javax.jcr.RepositoryException

org.osgi.framework.BundleException

undeployModule

public void undeployModule(String moduleId,
                           String version)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

undeployModule

public void undeployModule(JahiaTemplatesPackage pack)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isTemplatePresent

public boolean isTemplatePresent(String templateName,
                                 String templateSetName)

Checks if the specified template is available either in the requested template set or in one of the deployed modules.

Parameters:

templateName - the path of the template to be checked

templateSetName - the name of the target template set

Returns:

true if the specified template is present; false otherwise

isTemplatePresent

public boolean isTemplatePresent(String templateName,
                                 Set<String> templateSetNames)

Checks if the specified template is available either in one of the requested template sets or modules.

Parameters:

templateName - the path of the template to be checked

templateSetNames - the set of template sets and modules we should check for the presence of the specified template

Returns:

true if the specified template is present; false otherwise

getModuleStates

public Map<org.osgi.framework.Bundle,ModuleState> getModuleStates()

getRegisteredBundles

public Map<org.osgi.framework.Bundle,JahiaTemplatesPackage> getRegisteredBundles()

getInstalledBundles

public Set<org.osgi.framework.Bundle> getInstalledBundles()

getInitializedBundles

public Set<org.osgi.framework.Bundle> getInitializedBundles()

getToBeResolved

public Map<String,List<org.osgi.framework.Bundle>> getToBeResolved()

getModulesByState

public List<org.osgi.framework.Bundle> getModulesByState(ModuleState.State state)

Returns list of module bundles in the specified state.

Parameters:

state - the state of the module to be considered

Returns:

list of module bundles in the specified state or an empty list if there no modules in that state

setModuleStates

public void setModuleStates(Map<org.osgi.framework.Bundle,ModuleState> moduleStates)

differentModuleWithSameIdExists

public boolean differentModuleWithSameIdExists(String symbolicName,
                                               String groupId)

initAfterAllServicesAreStarted

public void initAfterAllServicesAreStarted()
                                    throws JahiaInitializationException

Specified by:

initAfterAllServicesAreStarted in interface JahiaAfterInitializationService

Throws:

JahiaInitializationException

setModuleInstallationHelper

public void setModuleInstallationHelper(ModuleInstallationHelper moduleInstallationHelper)

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

setSourceControlHelper

public void setSourceControlHelper(SourceControlHelper scmHelper)

Injects an instance of the SCM helper.

Parameters:

scmHelper - an instance of the SCM helper

setModuleBuildHelper

public void setModuleBuildHelper(ModuleBuildHelper moduleBuildHelper)

setForgeHelper

public void setForgeHelper(org.jahia.services.templates.ForgeHelper forgeHelper)

Injects an instance of the helper class for Private App Store related operations.

Parameters:

forgeHelper - an instance helper class for Private App Store related operations

getModulesWithNoDefaultDependency

public Set<String> getModulesWithNoDefaultDependency()

setModulesWithNoDefaultDependency

public void setModulesWithNoDefaultDependency(Set<String> modulesWithNoDefaultDependency)

getKnownFragmentHosts

public Set<String> getKnownFragmentHosts()

Returns a set of symbolic names for bundles, which are known to be target hosts for fragments.

Returns:

a set of symbolic names for bundles, which are known to be target hosts for fragments

setKnownFragmentHosts

public void setKnownFragmentHosts(Set<String> knownFragmentHosts)

Defines a set of symbolic names for bundles, which are known to be target hosts for fragments.

Parameters:

knownFragmentHosts - a set of symbolic names for bundles, which are known to be target hosts for fragments

setModuleManager

public void setModuleManager(ModuleManager moduleManager)