io.openliberty.tools.maven

Class BasicSupport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.pluginsupport.MojoSupport

io.openliberty.tools.maven.AbstractLibertySupport

io.openliberty.tools.maven.BasicSupport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

ConfigureArquillianMojo, InstallFeatureSupport, StartDebugMojoSupport, UninstallFeatureMojo

public class BasicSupport
extends AbstractLibertySupport

Basic Liberty Mojo Support

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BasicSupport.InstallType

Field Summary

Fields

Modifier and Type	Field and Description
protected File	assemblyArchive A file which points to a specific assembly ZIP archive.
protected org.codehaus.mojo.pluginsupport.util.ArtifactItem	assemblyArtifact Maven coordinates of a server assembly.
protected File	assemblyInstallDirectory Server Install Directory
protected File	configDirectory Location of customized configuration directory
protected boolean	defaultOutputDirSet
protected Install	install Liberty install option.
protected File	installDirectory Installation directory of Liberty profile.
protected BasicSupport.InstallType	installType
protected boolean	isInstall Set the false to skip the installation of the assembly, re-using anything that is already there.
protected String	libertyRuntimeVersion Version to override any specified in the assemblyArtifact
protected org.codehaus.mojo.pluginsupport.util.ArtifactItem	licenseArtifact Maven coordinates of a liberty license artifact.
protected boolean	mergeServerEnv If set, merges server.env contents from default server.env, configDir server.env, inline properties, and specified server.env
protected static ResourceBundle	messages
protected File	outputDirectory Liberty output directory (WLP_OUTPUT_DIR).
protected boolean	refresh Enable forced install refresh.
protected File	serverDirectory Server Directory: ${installDirectory}/usr/servers/${serverName}/
protected File	serverEnvFile Location of customized server environment file server.env
protected String	serverName Liberty server name, default is defaultServer
protected boolean	skip Skips the specific goal
protected static String	START_APP_MESSAGE_REGEXP
protected File	userDirectory Liberty user directory (WLP_USER_DIR).

Fields inherited from class io.openliberty.tools.maven.AbstractLibertySupport

ant, artifactRepository, mavenProjectBuilder, project, reactorProjects, repoSession, repositories, repositorySystem, session, settings

Fields inherited from class org.codehaus.mojo.pluginsupport.MojoSupport

container, log

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

ROLE

Constructor Summary

Constructors

Constructor and Description
BasicSupport()

Method Summary

Modifier and Type	Method and Description
protected void	checkServerDirectoryExists()
protected void	checkServerHomeExists()
protected void	deleteApplication(File parent, File artifactFile)
protected void	deleteApplication(File parent, String filename)
protected Map<String,File>	getLibertyDirectoryPropertyFiles()
static Map<String,File>	getLibertyDirectoryPropertyFiles(File installDir, File userDir, File serverDir)
protected void	init()
protected void	installFromArchive()
protected void	installFromFile()
protected void	installLicense()
protected void	installServerAssembly() Performs assembly installation unless the install type is pre-existing.
protected String	stripVersionFromName(String name, String version)

Methods inherited from class io.openliberty.tools.maven.AbstractLibertySupport

createArtifact, createArtifactItem, dependencyTrailContainsArtifact, findTransitiveDependencies, getArtifact, getArtifact, getArtifactRepository, getProject, getReactorMavenProject, getResolvedDependencyWithTransitiveDependencies, isReactorMavenProject

Methods inherited from class org.codehaus.mojo.pluginsupport.MojoSupport

contextualize, doExecute, execute, getArtifactFactory, getArtifactResolver, getProjectArtifacts, getProjectArtifacts, getProjectArtifacts, resolveArtifact, resolveArtifact

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

START_APP_MESSAGE_REGEXP

protected static final String START_APP_MESSAGE_REGEXP

See Also:

Constant Field Values

messages

protected static final ResourceBundle messages

defaultOutputDirSet

protected boolean defaultOutputDirSet

skip

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

Skips the specific goal

refresh

@Parameter(property="refresh",
           defaultValue="false")
protected boolean refresh

Enable forced install refresh.

isInstall

@Parameter(property="isInstall",
           defaultValue="true")
protected boolean isInstall

Set the false to skip the installation of the assembly, re-using anything that is already there.

assemblyInstallDirectory

@Parameter(alias="runtimeInstallDirectory",
           property="runtimeInstallDirectory",
           defaultValue="${project.build.directory}/liberty")
protected File assemblyInstallDirectory

Server Install Directory

installDirectory

@Parameter(property="installDirectory")
protected File installDirectory

Installation directory of Liberty profile.

serverName

@Parameter(property="serverName",
           defaultValue="defaultServer")
protected String serverName

Liberty server name, default is defaultServer

userDirectory

@Parameter(property="userDirectory")
protected File userDirectory

Liberty user directory (WLP_USER_DIR).

outputDirectory

@Parameter(property="outputDirectory")
protected File outputDirectory

Liberty output directory (WLP_OUTPUT_DIR).

serverDirectory

protected File serverDirectory

Server Directory: ${installDirectory}/usr/servers/${serverName}/

installType

protected BasicSupport.InstallType installType

assemblyArchive

@Parameter(alias="runtimeArchive",
           property="runtimeArchive")
protected File assemblyArchive

A file which points to a specific assembly ZIP archive. If this parameter is set, then it will install server from archive

assemblyArtifact

@Parameter(alias="runtimeArtifact",
           property="runtimeArtifact")
protected org.codehaus.mojo.pluginsupport.util.ArtifactItem assemblyArtifact

Maven coordinates of a server assembly. This is best listed as a dependency, in which case the version can be omitted.

install

@Parameter
protected Install install

Liberty install option. If set, Liberty will be downloaded and installed from the WASdev repository or the given URL.

licenseArtifact

@Parameter
protected org.codehaus.mojo.pluginsupport.util.ArtifactItem licenseArtifact

Maven coordinates of a liberty license artifact. This is best listed as a dependency, in which case the version can be omitted.

configDirectory

@Parameter(property="configDirectory",
           defaultValue="${basedir}/src/main/liberty/config")
protected File configDirectory

Location of customized configuration directory

serverEnvFile

@Parameter(alias="serverEnv",
           property="serverEnvFile")
protected File serverEnvFile

Location of customized server environment file server.env

mergeServerEnv

@Parameter(property="mergeServerEnv",
           defaultValue="false")
protected boolean mergeServerEnv

If set, merges server.env contents from default server.env, configDir server.env, inline properties, and specified server.env

libertyRuntimeVersion

@Parameter(alias="libertyRuntimeVersion",
           property="liberty.runtime.version")
protected String libertyRuntimeVersion

Version to override any specified in the assemblyArtifact

Constructor Detail

BasicSupport

public BasicSupport()

Method Detail

init

protected void init()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Overrides:

init in class AbstractLibertySupport

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

checkServerHomeExists

protected void checkServerHomeExists()
                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

checkServerDirectoryExists

protected void checkServerDirectoryExists()
                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

installServerAssembly

protected void installServerAssembly()
                              throws Exception

Performs assembly installation unless the install type is pre-existing.

Throws:

Exception

installFromFile

protected void installFromFile()
                        throws Exception

Throws:

Exception

installFromArchive

protected void installFromArchive()
                           throws Exception

Throws:

Exception

stripVersionFromName

protected String stripVersionFromName(String name,
                                      String version)

installLicense

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

Throws:

org.apache.maven.plugin.MojoExecutionException

IOException

deleteApplication

protected void deleteApplication(File parent,
                                 File artifactFile)
                          throws IOException

Throws:

IOException

deleteApplication

protected void deleteApplication(File parent,
                                 String filename)
                          throws IOException

Throws:

IOException

getLibertyDirectoryPropertyFiles

public static Map<String,File> getLibertyDirectoryPropertyFiles(File installDir,
                                                                File userDir,
                                                                File serverDir)
                                                         throws IOException

Throws:

IOException

getLibertyDirectoryPropertyFiles

protected Map<String,File> getLibertyDirectoryPropertyFiles()