org.jahia.services.templates

Class ModuleBuildHelper

java.lang.Object

org.jahia.services.templates.ModuleBuildHelper

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class ModuleBuildHelper
extends Object
implements org.springframework.beans.factory.InitializingBean

Utility class for module compilation and build.

Author:

Sergiy Shyrkov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleBuildHelper.SvnCleaner

Constructor Summary

Constructors

Constructor and Description
ModuleBuildHelper()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
JahiaTemplatesPackage	compileAndDeploy(String moduleId, File sources, JCRSessionWrapper session)
org.jahia.services.templates.ModuleBuildHelper.CompiledModuleInfo	compileModule(File sources)
JCRNodeWrapper	createModule(String moduleName, String artifactId, String groupId, String moduleType, File moduleSources, JCRSessionWrapper session)
void	deployToMaven(String groupId, String artifactId, ModuleReleaseInfo releaseInfo, File generatedJar)
JahiaTemplatesPackage	duplicateModule(String dstModuleName, String dstModuleId, String dstGroupId, String srcPath, String scmURI, String branchOrTag, String srcModuleId, String srcModuleVersion, boolean uninstallSrcModule, String dstPath, boolean deleteSrcFolder, JCRSessionWrapper session)
int	getModuleStartLevel()
void	regenerateImportFile(JCRSessionWrapper session, List<File> modifiedFiles, File sources, String moduleId, String moduleIdWithVersion)
protected File	releaseModuleInternal(org.apache.maven.model.Model model, String lastVersion, String releaseVersion, ModuleReleaseInfo releaseInfo, File sources, String scmUrl)
void	setIgnoreSnapshots(String ignoreSnapshots)
void	setMavenArchetypeCatalog(String mavenArchetypeCatalog)
void	setMavenArchetypePlugin(String mavenArchetypePlugin)
void	setMavenArchetypeVersion(String mavenArchetypeVersion) Supplies the exact version of the Maven archetypes to use when creating a module.
void	setMavenExecutable(String mavenExecutable)
void	setMavenMinRequiredVersion(String mavenRequiredVersion)
void	setMavenReleasePlugin(String mavenReleasePlugin)
void	setMavenWarnIfVersionIsOlderThan(String mavenWarnIfVersionIsOlderThan)
void	setModuleManager(ModuleManager moduleManager)
void	setModuleStartLevel(int moduleStartLevel)
void	setSettingsBean(SettingsBean settingsBean)
void	setSourceControlHelper(SourceControlHelper scmHelper)
void	setTemplatePackageRegistry(TemplatePackageRegistry registry)
void	setToolbarWarningsService(ToolbarWarningsService toolbarWarningsService)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleBuildHelper

public ModuleBuildHelper()

Method Detail

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 org.jahia.services.templates.ModuleBuildHelper.CompiledModuleInfo compileModule(File sources)
                                                                                throws IOException

Throws:

IOException

createModule

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

Throws:

IOException

javax.jcr.RepositoryException

org.osgi.framework.BundleException

deployToMaven

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

Throws:

IOException

releaseModuleInternal

protected File releaseModuleInternal(org.apache.maven.model.Model model,
                                     String lastVersion,
                                     String releaseVersion,
                                     ModuleReleaseInfo releaseInfo,
                                     File sources,
                                     String scmUrl)
                              throws IOException,
                                     org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

IOException

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

setIgnoreSnapshots

public void setIgnoreSnapshots(String ignoreSnapshots)

setMavenArchetypeCatalog

public void setMavenArchetypeCatalog(String mavenArchetypeCatalog)

setSettingsBean

public void setSettingsBean(SettingsBean settingsBean)

setSourceControlHelper

public void setSourceControlHelper(SourceControlHelper scmHelper)

setTemplatePackageRegistry

public void setTemplatePackageRegistry(TemplatePackageRegistry registry)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setMavenReleasePlugin

public void setMavenReleasePlugin(String mavenReleasePlugin)

setMavenMinRequiredVersion

public void setMavenMinRequiredVersion(String mavenRequiredVersion)

setMavenExecutable

public void setMavenExecutable(String mavenExecutable)

setToolbarWarningsService

public void setToolbarWarningsService(ToolbarWarningsService toolbarWarningsService)

duplicateModule

public JahiaTemplatesPackage duplicateModule(String dstModuleName,
                                             String dstModuleId,
                                             String dstGroupId,
                                             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

regenerateImportFile

public void regenerateImportFile(JCRSessionWrapper session,
                                 List<File> modifiedFiles,
                                 File sources,
                                 String moduleId,
                                 String moduleIdWithVersion)
                          throws javax.jcr.RepositoryException,
                                 SAXException,
                                 IOException,
                                 TransformerException

Throws:

javax.jcr.RepositoryException

SAXException

IOException

TransformerException

setMavenArchetypeVersion

public void setMavenArchetypeVersion(String mavenArchetypeVersion)

Supplies the exact version of the Maven archetypes to use when creating a module.

Parameters:

mavenArchetypeVersion - the exact version of the Maven archetypes to use when creating a module

getModuleStartLevel

public int getModuleStartLevel()

setModuleStartLevel

public void setModuleStartLevel(int moduleStartLevel)

setModuleManager

public void setModuleManager(ModuleManager moduleManager)

setMavenWarnIfVersionIsOlderThan

public void setMavenWarnIfVersionIsOlderThan(String mavenWarnIfVersionIsOlderThan)

setMavenArchetypePlugin

public void setMavenArchetypePlugin(String mavenArchetypePlugin)