io.reactiverse.vertx.maven.plugin.mojos

Class PackageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.reactiverse.vertx.maven.plugin.mojos.AbstractVertxMojo

io.reactiverse.vertx.maven.plugin.mojos.PackageMojo

All Implemented Interfaces:

ContextEnabled, Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="package",
      defaultPhase=PACKAGE,
      requiresDependencyCollection=COMPILE_PLUS_RUNTIME,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME)
public class PackageMojo
extends AbstractVertxMojo

This goal helps in packaging VertX application as uber jar with bundled dependencies

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	attach Whether or not the created archive needs to be attached to the project.
protected String	classifier Classifier to add to the artifact generated.
protected ServiceFileCombiner	combiner
private static String	JAR_EXTENSION
protected PackageService	packageService
protected CombinationStrategy	serviceProviderCombination The service provider combination strategy.

Fields inherited from class io.reactiverse.vertx.maven.plugin.mojos.AbstractVertxMojo

archive, buildPluginManager, container, DEFAULT_CONF_DIR, IO_VERTX_CORE_LAUNCHER, launcher, lifecycleExecutor, mavenSession, project, projectBuildDir, remoteRepositories, repositorySystem, repositorySystemSession, scmManager, skip, skipScmMetadata, verticle, VERTX_ARG_CONF, VERTX_ARG_JAVA_OPT, VERTX_ARG_LAUNCHER_CLASS, VERTX_ARG_REDEPLOY, VERTX_ARG_REDEPLOY_GRACE_PERIOD, VERTX_ARG_REDEPLOY_SCAN_PERIOD, VERTX_ARG_REDEPLOY_TERMINATION_PERIOD, VERTX_COMMAND_START, VERTX_COMMAND_STOP, VERTX_CONFIG_FILE_JSON, VERTX_PACKAGING, VERTX_PID_FILE, VERTX_RUN_MODE_JAR, WILDCARD_CONFIG_FILES

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PackageMojo()

Method Summary

Modifier and Type	Method and Description
private void	attachIfNeeded(File jar)
static String	computeOutputName(Archive archive, MavenProject project, String classifier)
void	execute()
private void	fixEmptyClassifier()

Methods inherited from class io.reactiverse.vertx.maven.plugin.mojos.AbstractVertxMojo

asMavenCoordinates, computeArchive, contextualize, extractArtifactPaths, getArtifactFile, getProject, getScmManager, resolveArtifact, skipScmMetadata

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

serviceProviderCombination

@Parameter(name="serviceProviderCombination",
           defaultValue="COMBINE")
protected CombinationStrategy serviceProviderCombination

The service provider combination strategy.

classifier

@Parameter(name="classifier")
protected String classifier

Classifier to add to the artifact generated. If given, the artifact will be attached with that classifier and the main artifact will be deployed as the main artifact. If this is not given (default), it will replace the main artifact and only the Vert.x (fat) jar artifact will be deployed (in the Maven sense). Attaching the artifact allows to deploy it alongside to the original one. Attachment is controlled using the `attach` parameter.

attach

@Parameter(name="attach",
           defaultValue="true")
protected boolean attach

Whether or not the created archive needs to be attached to the project. If attached, the fat jar is installed and deployed alongside the main artifact. Notice that you can't disable attachment if the classifier is not set (it would mean detaching the main artifact).

packageService

@Component
protected PackageService packageService

combiner

@Component
protected ServiceFileCombiner combiner

JAR_EXTENSION

private static final String JAR_EXTENSION

See Also:

Constant Field Values

Constructor Detail

PackageMojo

public PackageMojo()

Method Detail

computeOutputName

public static String computeOutputName(Archive archive,
                                       MavenProject project,
                                       String classifier)

execute

public void execute()
             throws MojoExecutionException

Throws:

MojoExecutionException

attachIfNeeded

private void attachIfNeeded(File jar)

fixEmptyClassifier

private void fixEmptyClassifier()