io.fabric8.maven

Class ZipMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.AbstractFabric8Mojo

io.fabric8.maven.ZipMojo

All Implemented Interfaces:

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

@Mojo(name="zip",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=COMPILE)
public class ZipMojo
extends AbstractFabric8Mojo

Generates a ZIP file of the App for the current maven project.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	deployFileGoal The maven goal used to deploy aggregated zips.
protected boolean	generateAppPropertiesFile Whether or not we should generate a fabric8.properties file from the pom.xml.
protected boolean	generateSummaryFile Whether or not we should generate a Summary.md file from the pom.xml <description> element text value.
protected String	iconRef Provides the resource name of the icon to use; found using the current classpath (including the ones shippped inside the maven plugin).
protected boolean	includeReadMe Whether or not we should upload the project readme file if no specific readme file exists in the AbstractFabric8Mojo.appConfigDir
protected String	pathInZip The name of the path inside the zip where the app is generated.
protected String	replaceReadmeLinksPrefix If provided then any links in the readme.md files will be replaced to include the given prefix
protected org.apache.maven.execution.MavenSession	session The Maven Session.

Fields inherited from class io.fabric8.maven.AbstractFabric8Mojo

appConfigDir, kubernetesSourceJson, zipFile

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ZipMojo()

Method Summary

Methods

Modifier and Type	Method and Description
static void	appendAppConfigFiles(File appSourceDir, File outputDir) Combines any files from the appSourceDir into the output directory
protected static void	combineAppFilesToFolder(org.apache.maven.project.MavenProject reactorProject, File buildDir, org.apache.maven.plugin.logging.Log log, String reactorProjectOutputPath)
protected static void	combinePropertiesFiles(File sourceFile, File destFile) For 2 properties files the source and dest file, lets combine the values so that all the values of the sourceFile are in the dest file
protected void	copyAppConfigFiles(File appBuildDir, File appConfigDir) Copies any local configuration files into the app directory
protected void	createAggregatedZip(File projectBaseDir, File projectBuildDir, String reactorProjectOutputPath, File projectOutputFile, boolean includeReadMe, Set<org.apache.maven.project.MavenProject> pomZipProjects)
protected String	escapeAgentPropertiesKey(String text)
protected String	escapeAgentPropertiesValue(String text)
void	execute()
protected void	generateAggregatedZip(org.apache.maven.project.MavenProject rootProject, List<org.apache.maven.project.MavenProject> reactorProjects, Set<org.apache.maven.project.MavenProject> pomZipProjects)
protected void	generateAggregatedZips()
protected void	generateZip()
protected static String	getChildProjectRelativePath(File projectBaseDir, org.apache.maven.project.MavenProject pomProject)
protected String	replaceGithubLinks(Set<String> names, String relativePath, String line) Replacing github links with fabric apps links for our quickstarts
protected boolean	toBeExclude(String fileName)

Methods inherited from class io.fabric8.maven.AbstractFabric8Mojo

createClassLoader, createURLClassLoader, getCompileClassLoader, getEnvironmentVariableJsonSchema, getEnvironmentVariableProperties, getKubernetesJson, getProject, getReplicas, getTestClassLoader, getZipFile, hasConfigDir, isIgnoreProject, isPom, isPomProject, loadPluginResource, shouldGenerateForThisProject

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

Field Detail

includeReadMe

@Parameter(property="fabric8.includeReadMe",
           defaultValue="true")
protected boolean includeReadMe

Whether or not we should upload the project readme file if no specific readme file exists in the AbstractFabric8Mojo.appConfigDir

replaceReadmeLinksPrefix

@Parameter(property="fabric8.replaceReadmeLinksPrefix")
protected String replaceReadmeLinksPrefix

If provided then any links in the readme.md files will be replaced to include the given prefix

iconRef

@Parameter(property="fabric8.iconRef")
protected String iconRef

Provides the resource name of the icon to use; found using the current classpath (including the ones shippped inside the maven plugin).

generateSummaryFile

@Parameter(property="fabric8.generateSummaryFile",
           defaultValue="true")
protected boolean generateSummaryFile

Whether or not we should generate a Summary.md file from the pom.xml <description> element text value.

generateAppPropertiesFile

@Parameter(property="fabric8.generateAppPropertiesFile",
           defaultValue="true")
protected boolean generateAppPropertiesFile

Whether or not we should generate a fabric8.properties file from the pom.xml.

pathInZip

@Parameter(property="fabric8.pathInZip",
           defaultValue="${project.artifactId}")
protected String pathInZip

The name of the path inside the zip where the app is generated.

deployFileGoal

@Parameter(property="fabric8.deployFileGoal",
           defaultValue="gpg:sign-and-deploy-file")
protected String deployFileGoal

The maven goal used to deploy aggregated zips. Could be deploy:deploy-file to perform a regular deploy or gpg:sign-and-deploy-file to sign and deploy the file

session

protected org.apache.maven.execution.MavenSession session

The Maven Session.

Constructor Detail

ZipMojo

public ZipMojo()

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

generateZip

protected void generateZip()
                    throws org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException,
                           org.apache.maven.plugin.MojoExecutionException,
                           IOException,
                           org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException

org.apache.maven.plugin.MojoExecutionException

IOException

org.apache.maven.plugin.MojoFailureException

generateAggregatedZips

protected void generateAggregatedZips()
                               throws IOException,
                                      org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

generateAggregatedZip

protected void generateAggregatedZip(org.apache.maven.project.MavenProject rootProject,
                         List<org.apache.maven.project.MavenProject> reactorProjects,
                         Set<org.apache.maven.project.MavenProject> pomZipProjects)
                              throws IOException,
                                     org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

replaceGithubLinks

protected String replaceGithubLinks(Set<String> names,
                        String relativePath,
                        String line)

Replacing github links with fabric apps links for our quickstarts

createAggregatedZip

protected void createAggregatedZip(File projectBaseDir,
                       File projectBuildDir,
                       String reactorProjectOutputPath,
                       File projectOutputFile,
                       boolean includeReadMe,
                       Set<org.apache.maven.project.MavenProject> pomZipProjects)
                            throws IOException

Throws:

IOException

getChildProjectRelativePath

protected static String getChildProjectRelativePath(File projectBaseDir,
                                 org.apache.maven.project.MavenProject pomProject)
                                             throws IOException

Throws:

IOException

appendAppConfigFiles

public static void appendAppConfigFiles(File appSourceDir,
                        File outputDir)
                                 throws IOException

Combines any files from the appSourceDir into the output directory

Throws:

IOException

combineAppFilesToFolder

protected static void combineAppFilesToFolder(org.apache.maven.project.MavenProject reactorProject,
                           File buildDir,
                           org.apache.maven.plugin.logging.Log log,
                           String reactorProjectOutputPath)
                                       throws IOException

Throws:

IOException

combinePropertiesFiles

protected static void combinePropertiesFiles(File sourceFile,
                          File destFile)
                                      throws IOException

For 2 properties files the source and dest file, lets combine the values so that all the values of the sourceFile are in the dest file

Throws:

IOException

copyAppConfigFiles

protected void copyAppConfigFiles(File appBuildDir,
                      File appConfigDir)
                           throws IOException

Copies any local configuration files into the app directory

Throws:

IOException

toBeExclude

protected boolean toBeExclude(String fileName)

escapeAgentPropertiesKey

protected String escapeAgentPropertiesKey(String text)

escapeAgentPropertiesValue

protected String escapeAgentPropertiesValue(String text)