de.larssh.maven.jarrunner

Class Parameters

java.lang.Object

de.larssh.maven.jarrunner.Parameters

public final class Parameters
extends Object

Parameters object maintaining the injected system objects and user arguments of RunMojo.

Constructor Summary

Constructors

Constructor and Description

Parameters(org.apache.maven.execution.MavenSession mavenSession, org.eclipse.aether.RepositorySystem repositorySystem, org.eclipse.aether.RepositorySystemSession repositorySystemSession, String artifact, String mainClass, String arguments, boolean runAsync, String classPathFormat, String javaPath, String javaOptions, String repositories, boolean ignoreSystemRepositories, String workingDirectory) Constructor taking injected system objects and user arguments of RunMojo.

Method Summary

Modifier and Type	Method and Description
List<String>	getArguments() List of arguments for the to-be-executed application Default: none
org.eclipse.aether.artifact.Artifact	getArtifact() Artifact to load Required.
Optional<String>	getClassPathFormat() Formatter value that allows modifying the class path.
List<String>	getJavaOptions() List of options for the Java VM Default: none
Optional<Path>	getJavaPath() Path to the Java executable Default: path to the Java executable used by Maven
Optional<String>	getMainClass() Main class to execute Default: the artifacts JARs main class
org.apache.maven.execution.MavenSession	getMavenSession() Maven Session
List<org.eclipse.aether.repository.RemoteRepository>	getRepositories() List of Maven repository URLs User name and password can be inserted as URI user info, delimited by colon.
org.eclipse.aether.RepositorySystem	getRepositorySystem() Aether Repository System
org.eclipse.aether.RepositorySystemSession	getRepositorySystemSession() Aether Repository System Session
Optional<Path>	getWorkingDirectory() Working Directory for the to-be-executed application Default: current working directory
boolean	isIgnoreSystemRepositories() Ignore system repositories Default: false
boolean	isRunAsync() Run application asynchronously If this argument equals "true" the JAR Runner instance stops right after starting the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters(org.apache.maven.execution.MavenSession mavenSession,
                  org.eclipse.aether.RepositorySystem repositorySystem,
                  org.eclipse.aether.RepositorySystemSession repositorySystemSession,
                  @Nullable
                  String artifact,
                  @Nullable
                  String mainClass,
                  @Nullable
                  String arguments,
                  boolean runAsync,
                  @Nullable
                  String classPathFormat,
                  @Nullable
                  String javaPath,
                  @Nullable
                  String javaOptions,
                  @Nullable
                  String repositories,
                  boolean ignoreSystemRepositories,
                  @Nullable
                  String workingDirectory)

Constructor taking injected system objects and user arguments of RunMojo.

Arguments are validated and converted from Maven argument types to property types.

Parameters:

mavenSession - Maven Session

repositorySystem - Aether Repository System

repositorySystemSession - Aether Repository System Session

artifact - Artifact

mainClass - Main Class

arguments - Arguments

runAsync - Run application asynchronously

classPathFormat - Class Path Format

javaPath - Java Path

javaOptions - Java Options

repositories - List of Repositories

ignoreSystemRepositories - Ignore System Repositories

workingDirectory - Working Directory

Method Detail

getArguments

public List<String> getArguments()

List of arguments for the to-be-executed application

Default: none

Returns:

List of arguments for the to-be-executed application

getArtifact

public org.eclipse.aether.artifact.Artifact getArtifact()

Artifact to load

Required.

Returns:

Artifact to load

getClassPathFormat

public Optional<String> getClassPathFormat()

Formatter value that allows modifying the class path. Substring "%s" is replaced with the generated class path.

Default: "%s"

Returns:

Class Path Format

isIgnoreSystemRepositories

public boolean isIgnoreSystemRepositories()

Ignore system repositories

Default: false

Returns:

Ignore system repositories

getJavaPath

public Optional<Path> getJavaPath()

Path to the Java executable

Default: path to the Java executable used by Maven

Returns:

Path to the Java executable

getJavaOptions

public List<String> getJavaOptions()

List of options for the Java VM

Default: none

Returns:

List of options for the Java VM

getMainClass

public Optional<String> getMainClass()

Main class to execute

Default: the artifacts JARs main class

Returns:

Main class to execute

getMavenSession

public org.apache.maven.execution.MavenSession getMavenSession()

Maven Session

Returns:

Maven Session

getRepositories

public List<org.eclipse.aether.repository.RemoteRepository> getRepositories()

List of Maven repository URLs

User name and password can be inserted as URI user info, delimited by colon. Order is: user name, password converter (either base64 or plain), password. A repository ID can be set using the URI fragment.

Example: http://user:base64:cGFzc3dvcmQ=@repository.example.com/path#id

In case of multiple repositories with the same ID the first repository in order is used. Following repositories with the same ID are ignored. Repositories of user parameters are handled at first.

Repository layout and proxy cannot be set via user argument.

Default: none

Returns:

List of Maven repository URLs

getRepositorySystem

public org.eclipse.aether.RepositorySystem getRepositorySystem()

Aether Repository System

Returns:

Aether Repository System

getRepositorySystemSession

public org.eclipse.aether.RepositorySystemSession getRepositorySystemSession()

Aether Repository System Session

Returns:

Aether Repository System Session

isRunAsync

public boolean isRunAsync()

Run application asynchronously

If this argument equals "true" the JAR Runner instance stops right after starting the application. The applications stream will not be inherited.

Default: false

Returns:

true if the application shall run asynchronously

getWorkingDirectory

public Optional<Path> getWorkingDirectory()

Working Directory for the to-be-executed application

Default: current working directory

Returns:

Working Directory for the to-be-executed application