org.jenkinsci.maven.plugins.hpi

Class AbstractHpiMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jenkinsci.maven.plugins.hpi.AbstractJenkinsMojo

org.jenkinsci.maven.plugins.hpi.AbstractHpiMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractJenkinsManifestMojo, ListPluginDependenciesMojo, TestDependencyMojo, ValidateHpiMojo

public abstract class AbstractHpiMojo
extends AbstractJenkinsMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager To look up Archiver/UnArchiver implementations
protected boolean	failOnVersionOverrideToDifferentRelease Controls the safety check that prevents a snapshotPluginVersionOverride from switching to a different release version.
protected String	globalMaskClasses Like the maskClasses parameter, but it applies at the boundary between core and all the plugins.
protected String	maskClasses [ws|tab|CR|LF]+ separated list of package prefixes that your plugin doesn't want to see from the core.
protected String	outputDirectory The directory for the generated WAR.
protected boolean	pluginFirstClassLoader Change the classloader preference such that classes locally bundled in this plugin will take precedence over those that are defined by the dependency plugins.
protected String	pluginName Name of the plugin that Jenkins uses for display purpose.
protected String	pluginVersionDescription Additional information that accompanies the version number of the plugin.
protected String	snapshotPluginVersionOverride Optional - the version to use in place of the project version in the event that the project version is a -SNAPSHOT.
protected File	warSourceDirectory Single directory for extra files to include in the WAR.

Fields inherited from class org.jenkinsci.maven.plugins.hpi.AbstractJenkinsMojo

artifactFactory, artifactResolver, jenkinsCoreId, project, projectBuilder, projectHelper, session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractHpiMojo()

Method Summary

Modifier and Type	Method and Description
void	buildExplodedWebapp(File webappDirectory, File jarFile)
void	buildWebapp(org.apache.maven.project.MavenProject project, File webappDirectory) Builds the webapp for the specified project.
void	copyResources(File sourceDirectory, File webappDirectory) Copies webapp webResources from the specified directory.
void	copyResources(org.apache.maven.model.Resource resource, File webappDirectory, Properties filterProperties) Copies webapp webResources from the specified directory.
File	getClassesDirectory()
File	getContainerConfigXML()
protected String[]	getDependentWarExcludes() Returns a string array of the excludes to be used when adding dependent wars as an overlay onto this war.
protected String[]	getDependentWarIncludes() Returns a string array of the includes to be used when adding dependent wars as an overlay onto this war.
Set<MavenArtifact>	getDirectDependencyArtfacts() Returns just the direct dependencies.
protected String[]	getExcludes() Returns a string array of the excludes to be used when assembling/copying the war.
String	getGitHeadSha1() If the project is on Git, figure out Git SHA1.
protected String[]	getIncludes() Returns a string array of the includes to be used when assembling/copying the war.
Set<MavenArtifact>	getProjectArtfacts() Returns all the transitive dependencies.
File	getWebappDirectory()
protected Boolean	isSupportDynamicLoading() Is the dynamic loading supported? False, if the answer is known to be "No".
void	setClassesDirectory(File classesDirectory)
void	setContainerConfigXML(File containerConfigXML)
void	setWarSourceDirectory(File warSourceDirectory)
void	setWebappDirectory(File webappDirectory)
protected Set<MavenArtifact>	wrap(Iterable<org.apache.maven.artifact.Artifact> artifacts)

Methods inherited from class org.jenkinsci.maven.plugins.hpi.AbstractJenkinsMojo

findJenkinsVersion, wrap

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

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

execute

Field Detail

outputDirectory

@Parameter(defaultValue="${project.build.directory}")
protected String outputDirectory

The directory for the generated WAR.

pluginName

@Parameter(defaultValue="${project.name}",
           readonly=true)
protected String pluginName

Name of the plugin that Jenkins uses for display purpose. It should be one line text.

pluginVersionDescription

@Parameter(defaultValue="${plugin.version.description}")
protected String pluginVersionDescription

Additional information that accompanies the version number of the plugin. Useful to distinguish snapshot builds. For example, if you are building snapshot plugins from Jenkins, you can put the build number in here by running Maven with "-Dplugin.version.description=$BUILD_TAG"

snapshotPluginVersionOverride

@Parameter
protected String snapshotPluginVersionOverride

Optional - the version to use in place of the project version in the event that the project version is a -SNAPSHOT. If specified, the value must start with the project version after removing the terminal -SNAPSHOT, for example if the project version is 1.2.3-SNAPSHOT then the snapshotPluginVersionOverride could be 1.2.3-rc45.cafebabe-SNAPSHOT or 1.2.3-20180430.123233-56, etc, but it could not be 1.2.4 as that does not start with the project version. When testing plugin builds on a locally hosted update centre, in order to be allowed to update the plugin, the update centre must report the plugin version as greater than the currently installed plugin version. If you are using a Continuous Delivery model for your plugin (i.e. where the master branch stays on a version like 1.x-SNAPSHOT and releases are tagged but not merged back to master (in order to prevent merge conflicts) then you will find that you cannot update the plugin when building locally as 1.x-SNAPSHOT is never less than 1.x-SNAPSHOT. Thus in order to test plugin upgrade (in say an acceptance test), you need to override the plugin version for non-releases. Typically you would use something like git-timestamp-maven-plugin to populate a property with the version and then use this configuration to provide the version.

Since:

2.4

See Also:

failOnVersionOverrideToDifferentRelease

failOnVersionOverrideToDifferentRelease

@Parameter(defaultValue="true")
protected boolean failOnVersionOverrideToDifferentRelease

Controls the safety check that prevents a snapshotPluginVersionOverride from switching to a different release version.

Since:

2.4

warSourceDirectory

@Parameter(defaultValue="${basedir}/src/main/webapp")
protected File warSourceDirectory

Single directory for extra files to include in the WAR.

archiverManager

@Component
protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

To look up Archiver/UnArchiver implementations

maskClasses

@Parameter
protected String maskClasses

[ws|tab|CR|LF]+ separated list of package prefixes that your plugin doesn't want to see from the core.

Tokens in this list is prefix-matched against the fully-qualified class name, so add "." to the end of each package name, like "com.foo. com.bar."

globalMaskClasses

@Parameter
protected String globalMaskClasses

Like the maskClasses parameter, but it applies at the boundary between core and all the plugins.

This mechanism is intended for those plugins that bring JavaEE APIs (such as the database plugin, which brings in the JPA API.) Other plugins that depend on the database plugin can still see the JPA API through the container classloader, so to make them all resolve to the JPA API in the database plugin, the database plugin needs to rely on this mechanism.

Since:

1.92

pluginFirstClassLoader

@Parameter
protected boolean pluginFirstClassLoader

Change the classloader preference such that classes locally bundled in this plugin will take precedence over those that are defined by the dependency plugins.

This is useful if the plugins that you want to depend on exposes conflicting versions of the libraries you are using, but enabling this switch makes your code susceptible to classloader constraint violations.

Since:

1.53

Constructor Detail

AbstractHpiMojo

public AbstractHpiMojo()

Method Detail

getClassesDirectory

public File getClassesDirectory()

setClassesDirectory

public void setClassesDirectory(File classesDirectory)

getWebappDirectory

public File getWebappDirectory()

setWebappDirectory

public void setWebappDirectory(File webappDirectory)

setWarSourceDirectory

public void setWarSourceDirectory(File warSourceDirectory)

getContainerConfigXML

public File getContainerConfigXML()

setContainerConfigXML

public void setContainerConfigXML(File containerConfigXML)

getExcludes

protected String[] getExcludes()

Returns a string array of the excludes to be used when assembling/copying the war.

Returns:

an array of tokens to exclude

getIncludes

protected String[] getIncludes()

Returns a string array of the includes to be used when assembling/copying the war.

Returns:

an array of tokens to include

getDependentWarExcludes

protected String[] getDependentWarExcludes()

Returns a string array of the excludes to be used when adding dependent wars as an overlay onto this war.

Returns:

an array of tokens to exclude

getDependentWarIncludes

protected String[] getDependentWarIncludes()

Returns a string array of the includes to be used when adding dependent wars as an overlay onto this war.

Returns:

an array of tokens to include

buildExplodedWebapp

public void buildExplodedWebapp(File webappDirectory,
                                File jarFile)
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

copyResources

public void copyResources(org.apache.maven.model.Resource resource,
                          File webappDirectory,
                          Properties filterProperties)
                   throws IOException

Copies webapp webResources from the specified directory.

Note that the webXml parameter could be null and may specify a file which is not named web.xml. If the file exists, it will be copied to the META-INF directory and renamed accordingly.

Parameters:

resource - the resource to copy

webappDirectory - the target directory

Throws:

IOException - if an error occurred while copying webResources

copyResources

public void copyResources(File sourceDirectory,
                          File webappDirectory)
                   throws IOException

Copies webapp webResources from the specified directory.

Note that the webXml parameter could be null and may specify a file which is not named web.xml. If the file exists, it will be copied to the META-INF directory and renamed accordingly.

Parameters:

sourceDirectory - the source directory

webappDirectory - the target directory

Throws:

IOException - if an error occurred while copying webResources

getProjectArtfacts

public Set<MavenArtifact> getProjectArtfacts()

Returns all the transitive dependencies.

getDirectDependencyArtfacts

public Set<MavenArtifact> getDirectDependencyArtfacts()

Returns just the direct dependencies.

wrap

protected Set<MavenArtifact> wrap(Iterable<org.apache.maven.artifact.Artifact> artifacts)

buildWebapp

public void buildWebapp(org.apache.maven.project.MavenProject project,
                        File webappDirectory)
                 throws org.apache.maven.plugin.MojoExecutionException,
                        IOException

Builds the webapp for the specified project.

Classes, libraries and tld files are copied to the webappDirectory during this phase.

Parameters:

project - the maven project

Throws:

IOException - if an error occurred while building the webapp

org.apache.maven.plugin.MojoExecutionException

getGitHeadSha1

public String getGitHeadSha1()

If the project is on Git, figure out Git SHA1.

Returns:

null if no git repository is found

isSupportDynamicLoading

protected Boolean isSupportDynamicLoading()
                                   throws IOException

Is the dynamic loading supported? False, if the answer is known to be "No". Otherwise null, if there are some extensions we don't know we can dynamic load. Otherwise, if everything is known to be dynamic loadable, return true.

Throws:

IOException