io.reactiverse.vertx.maven.plugin.mojos

Class AbstractVertxMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRunMojo, InitializeMojo, PackageMojo

public abstract class AbstractVertxMojo
extends AbstractMojo
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

The base Mojo class that will be extended by the other plugin goals

Field Summary

Fields

Modifier and Type	Field and Description
protected Archive	archive Configure the packaging content.
protected BuildPluginManager	buildPluginManager
protected org.codehaus.plexus.PlexusContainer	container The Plexus container.
protected static String	DEFAULT_CONF_DIR
static String	IO_VERTX_CORE_LAUNCHER The vert.x Core Launcher class
protected String	launcher The main launcher class that will be used when launching the Vert.X applications.
protected LifecycleExecutor	lifecycleExecutor The component used to execute the second Maven execution.
protected MavenSession	mavenSession The Maven Session.
protected MavenProject	project The Maven project which will define and confiure the vertx-maven-plugin
protected String	projectBuildDir The project build output directory, defaults to ${project.build.directory} which will be target directory of the project
protected List<org.eclipse.aether.repository.ArtifactRepository>	remoteRepositories The list of remote repositories that will be used to resolve artifacts
protected org.eclipse.aether.RepositorySystem	repositorySystem
protected org.eclipse.aether.DefaultRepositorySystemSession	repositorySystemSession The maven artifact resolution session, which will be used to resolve Maven artifacts
protected org.apache.maven.scm.manager.ScmManager	scmManager
protected boolean	skip Skip (globally) the processing made by this plugin.
protected boolean	skipScmMetadata
protected String	verticle The verticle that will be the main entry point on to the vertx application, the same property will be used as "Main-Verticle;" attribute value on the MANIFEST.MF
protected static String	VERTX_ARG_CONF vert.x configuration option
protected static String	VERTX_ARG_JAVA_OPT vert.x java-opt argument
protected static String	VERTX_ARG_LAUNCHER_CLASS vert.x launcher argument
protected static String	VERTX_ARG_REDEPLOY vert.x redeploy argument
protected static String	VERTX_ARG_REDEPLOY_GRACE_PERIOD vert.x redeploy grace period
protected static String	VERTX_ARG_REDEPLOY_SCAN_PERIOD vert.x redeploy scan period
protected static String	VERTX_ARG_REDEPLOY_TERMINATION_PERIOD vert.x redeploy termination period
protected static String	VERTX_COMMAND_START vert.x command start
protected static String	VERTX_COMMAND_STOP vert.x command stop
protected static String	VERTX_CONFIG_FILE_JSON
protected static String	VERTX_PACKAGING
protected static String	VERTX_PID_FILE
protected static String	VERTX_RUN_MODE_JAR
protected static String[]	WILDCARD_CONFIG_FILES

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractVertxMojo()

Method Summary

Modifier and Type	Method and Description
protected String	asMavenCoordinates(Artifact artifact) this method helps in resolving the Artifact as maven coordinates coordinates ::= group:artifact[:packaging[:classifier]]:version
protected Archive	computeArchive()
void	contextualize(org.codehaus.plexus.context.Context context) Retrieves the Plexus container.
protected Set<Optional<File>>	extractArtifactPaths(Set<Artifact> artifacts) this method helps in extracting the Artifact paths from the Maven local repository.
protected Optional<File>	getArtifactFile(Artifact artifact) This method returns the project's primary artifact file, this method tries to compute the artifact file name based on project finalName is configured or not
private List<ManifestCustomizerService>	getManifestCustomizers()
MavenProject	getProject()
org.apache.maven.scm.manager.ScmManager	getScmManager()
protected Optional<File>	resolveArtifact(String artifact) this method resolves maven artifact from all configured repositories using the maven coordinates
boolean	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

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

execute

Field Detail

IO_VERTX_CORE_LAUNCHER

public static final String IO_VERTX_CORE_LAUNCHER

The vert.x Core Launcher class

See Also:

Constant Field Values

WILDCARD_CONFIG_FILES

protected static final String[] WILDCARD_CONFIG_FILES

VERTX_ARG_CONF

protected static final String VERTX_ARG_CONF

vert.x configuration option

See Also:

Constant Field Values

VERTX_ARG_LAUNCHER_CLASS

protected static final String VERTX_ARG_LAUNCHER_CLASS

vert.x launcher argument

See Also:

Constant Field Values

DEFAULT_CONF_DIR

protected static final String DEFAULT_CONF_DIR

See Also:

Constant Field Values

VERTX_ARG_JAVA_OPT

protected static final String VERTX_ARG_JAVA_OPT

vert.x java-opt argument

See Also:

Constant Field Values

VERTX_ARG_REDEPLOY

protected static final String VERTX_ARG_REDEPLOY

vert.x redeploy argument

See Also:

Constant Field Values

VERTX_ARG_REDEPLOY_SCAN_PERIOD

protected static final String VERTX_ARG_REDEPLOY_SCAN_PERIOD

vert.x redeploy scan period

See Also:

Constant Field Values

VERTX_ARG_REDEPLOY_GRACE_PERIOD

protected static final String VERTX_ARG_REDEPLOY_GRACE_PERIOD

vert.x redeploy grace period

See Also:

Constant Field Values

VERTX_ARG_REDEPLOY_TERMINATION_PERIOD

protected static final String VERTX_ARG_REDEPLOY_TERMINATION_PERIOD

vert.x redeploy termination period

See Also:

Constant Field Values

VERTX_CONFIG_FILE_JSON

protected static final String VERTX_CONFIG_FILE_JSON

See Also:

Constant Field Values

VERTX_COMMAND_STOP

protected static final String VERTX_COMMAND_STOP

vert.x command stop

See Also:

Constant Field Values

VERTX_COMMAND_START

protected static final String VERTX_COMMAND_START

vert.x command start

See Also:

Constant Field Values

VERTX_PACKAGING

protected static final String VERTX_PACKAGING

See Also:

Constant Field Values

VERTX_PID_FILE

protected static final String VERTX_PID_FILE

See Also:

Constant Field Values

VERTX_RUN_MODE_JAR

protected static final String VERTX_RUN_MODE_JAR

See Also:

Constant Field Values

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected MavenProject project

The Maven project which will define and confiure the vertx-maven-plugin

projectBuildDir

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

The project build output directory, defaults to ${project.build.directory} which will be target directory of the project

repositorySystemSession

@Parameter(defaultValue="${repositorySystemSession}",
           readonly=true)
protected org.eclipse.aether.DefaultRepositorySystemSession repositorySystemSession

The maven artifact resolution session, which will be used to resolve Maven artifacts

remoteRepositories

@Parameter(alias="remoteRepositories",
           defaultValue="${project.remoteArtifactRepositories}",
           readonly=true)
protected List<org.eclipse.aether.repository.ArtifactRepository> remoteRepositories

The list of remote repositories that will be used to resolve artifacts

mavenSession

@Parameter(defaultValue="${session}",
           readonly=true)
protected MavenSession mavenSession

The Maven Session.

buildPluginManager

@Component
protected BuildPluginManager buildPluginManager

repositorySystem

@Component
protected org.eclipse.aether.RepositorySystem repositorySystem

lifecycleExecutor

@Component
protected LifecycleExecutor lifecycleExecutor

The component used to execute the second Maven execution.

scmManager

@Component
protected org.apache.maven.scm.manager.ScmManager scmManager

archive

@Parameter
protected Archive archive

Configure the packaging content.

verticle

@Parameter(alias="verticle",
           property="vertx.verticle")
protected String verticle

The verticle that will be the main entry point on to the vertx application, the same property will be used as "Main-Verticle;" attribute value on the MANIFEST.MF

launcher

@Parameter(defaultValue="io.vertx.core.Launcher",
           property="vertx.launcher")
protected String launcher

The main launcher class that will be used when launching the Vert.X applications. It defaults to io.vertx.core.Launcher

skip

@Parameter(property="vertx.skip",
           defaultValue="false")
protected boolean skip

Skip (globally) the processing made by this plugin. All mojos are impacted by this parameter.

skipScmMetadata

@Parameter(alias="skipScmMetadata",
           property="vertx.skipScmMetadata",
           defaultValue="false")
protected boolean skipScmMetadata

container

protected org.codehaus.plexus.PlexusContainer container

The Plexus container.

Constructor Detail

AbstractVertxMojo

public AbstractVertxMojo()

Method Detail

getProject

public MavenProject getProject()

resolveArtifact

protected Optional<File> resolveArtifact(String artifact)

this method resolves maven artifact from all configured repositories using the maven coordinates

Parameters:

artifact - - the maven coordinates of the artifact

Returns:

Optional File pointing to the resolved artifact in local repository

extractArtifactPaths

protected Set<Optional<File>> extractArtifactPaths(Set<Artifact> artifacts)

this method helps in extracting the Artifact paths from the Maven local repository. If does does not handle WebJars and non-jar dependencies.

Parameters:

artifacts - - the collection of artifacts which needs to be resolved to local File

Returns:

A Set of Optional file paths

asMavenCoordinates

protected String asMavenCoordinates(Artifact artifact)

this method helps in resolving the Artifact as maven coordinates coordinates ::= group:artifact[:packaging[:classifier]]:version

Parameters:

artifact - - the artifact which need to be represented as maven coordinate

Returns:

string representing the maven coordinate

getArtifactFile

protected Optional<File> getArtifactFile(Artifact artifact)

This method returns the project's primary artifact file, this method tries to compute the artifact file name based on project finalName is configured or not

Parameters:

artifact - - the project artifact for which the target file will be needed

Returns:

Optional representing the optional project primary artifact file

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Retrieves the Plexus container.

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Parameters:

context - the context

Throws:

org.codehaus.plexus.context.ContextException - if the container cannot be retrieved.

getScmManager

public org.apache.maven.scm.manager.ScmManager getScmManager()

Returns:

the SCM manager.

computeArchive

protected Archive computeArchive()
                          throws MojoExecutionException

Throws:

MojoExecutionException

getManifestCustomizers

private List<ManifestCustomizerService> getManifestCustomizers()
                                                        throws MojoExecutionException

Throws:

MojoExecutionException

skipScmMetadata

public boolean skipScmMetadata()