de.mhoffrogge.maven.plugins.p2site

Class BuildIndexHtmlMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.mhoffrogge.maven.plugins.base.AbstractBaseMojo

de.mhoffrogge.maven.plugins.p2site.BuildIndexHtmlMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="build-index-html",
      requiresDependencyResolution=COMPILE,
      defaultPhase=PACKAGE)
public class BuildIndexHtmlMojo
extends de.mhoffrogge.maven.plugins.base.AbstractBaseMojo

This goal creates template based index.html and optionally composite[Content|Artifacts].xml files for P2 update sites.

Author:

mhoffrog

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
BuildIndexHtmlMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addFolderToFolderStackIfNeeded(int depth, String folderName)
protected void	addProbableForwardLinks(List<String> listOfChilds, Properties props)
protected void	addToCompositeChilds(int depth, String folderName)
protected static String	buildCompositeLocation(String locationName)
protected static String	buildFileLink(String fileName)
protected static String	buildFolderLink(String folderName)
protected void	createCompositeFilesAndIndexHtmlAsRequired(File dir, Properties props, int depth, boolean isToCreateCompositeXmls)
protected void	createCompositeXml(String compositeBaseName, long timeStamp, List<String> listOfChilds, File dir, String repoName)
protected void	createCompositeXmls(List<String> listOfChilds, File dir, String repoName)
protected void	enforceBaseDirUpdateSitePropertiesFileIfConfigured()
void	execute()
protected void	executeInternal(boolean isToCreateCompositeXmls, boolean isToCreateIndexHtml)
protected File	getEffectiveBaseDir()
protected String	getIndexTemplate(String indexTemplateFileName, String defaultResourceName)
protected org.apache.commons.lang3.tuple.Pair<Boolean,StringBuilder>	getUpdateSiteContentFragment(File dir, Properties props, int depth)
protected boolean	isExcludedDirName(String dirName)
protected boolean	isExcludedFileName(String fileName)
protected boolean	isUpdateSiteFile(String fileName)
protected boolean	removeFolderFromFolderStackAndCreateCompositeXmlIfNeeded(int depth, File dir, String repoName, Properties props, boolean isToCreateCompositeXmls)
protected static String	replaceFileContent(String fileContent, String value, String propertyName)
protected void	walkAllFiles(File dir, int depth)

Methods inherited from class de.mhoffrogge.maven.plugins.base.AbstractBaseMojo

getMavenSession, getPluginManager, getPluginVersionResolver, getProject, isProjectSnapshotVersion

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildIndexHtmlMojo

public BuildIndexHtmlMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeInternal

protected void executeInternal(boolean isToCreateCompositeXmls,
                               boolean isToCreateIndexHtml)
                        throws org.apache.maven.plugin.MojoExecutionException,
                               org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getEffectiveBaseDir

protected File getEffectiveBaseDir()

Returns:

File object for the effective updateSite baseDir

enforceBaseDirUpdateSitePropertiesFileIfConfigured

protected void enforceBaseDirUpdateSitePropertiesFileIfConfigured()
                                                           throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getIndexTemplate

protected String getIndexTemplate(String indexTemplateFileName,
                                  String defaultResourceName)
                           throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

walkAllFiles

protected void walkAllFiles(File dir,
                            int depth)
                     throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

addFolderToFolderStackIfNeeded

protected void addFolderToFolderStackIfNeeded(int depth,
                                              String folderName)

removeFolderFromFolderStackAndCreateCompositeXmlIfNeeded

protected boolean removeFolderFromFolderStackAndCreateCompositeXmlIfNeeded(int depth,
                                                                           File dir,
                                                                           String repoName,
                                                                           Properties props,
                                                                           boolean isToCreateCompositeXmls)
                                                                    throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

addProbableForwardLinks

protected void addProbableForwardLinks(List<String> listOfChilds,
                                       Properties props)

Parameters:

listOfChilds -

props -

createCompositeXmls

protected void createCompositeXmls(List<String> listOfChilds,
                                   File dir,
                                   String repoName)
                            throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

createCompositeXml

protected void createCompositeXml(String compositeBaseName,
                                  long timeStamp,
                                  List<String> listOfChilds,
                                  File dir,
                                  String repoName)
                           throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

addToCompositeChilds

protected void addToCompositeChilds(int depth,
                                    String folderName)

createCompositeFilesAndIndexHtmlAsRequired

protected void createCompositeFilesAndIndexHtmlAsRequired(File dir,
                                                          Properties props,
                                                          int depth,
                                                          boolean isToCreateCompositeXmls)
                                                   throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

replaceFileContent

protected static String replaceFileContent(String fileContent,
                                           String value,
                                           String propertyName)

getUpdateSiteContentFragment

protected org.apache.commons.lang3.tuple.Pair<Boolean,StringBuilder> getUpdateSiteContentFragment(File dir,
                                                                                                  Properties props,
                                                                                                  int depth)
                                                                                           throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

isUpdateSiteFile

protected boolean isUpdateSiteFile(String fileName)

isExcludedFileName

protected boolean isExcludedFileName(String fileName)

isExcludedDirName

protected boolean isExcludedDirName(String dirName)

buildFolderLink

protected static String buildFolderLink(String folderName)

buildFileLink

protected static String buildFileLink(String fileName)

buildCompositeLocation

protected static String buildCompositeLocation(String locationName)