io.openliberty.tools.maven.applications

Class DeployMojoSupport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.pluginsupport.MojoSupport

io.openliberty.tools.maven.AbstractLibertySupport

io.openliberty.tools.maven.BasicSupport

io.openliberty.tools.maven.server.StartDebugMojoSupport

io.openliberty.tools.maven.server.PluginConfigSupport

io.openliberty.tools.maven.applications.DeployMojoSupport

All Implemented Interfaces:

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

Direct Known Subclasses:

DeployMojo, UndeployAppMojo

public class DeployMojoSupport
extends PluginConfigSupport

Support for installing and deploying applications to a Liberty server.

Nested Class Summary

Nested classes/interfaces inherited from class io.openliberty.tools.maven.BasicSupport

BasicSupport.InstallType

Field Summary

Fields

Modifier and Type	Field and Description
protected io.openliberty.tools.common.plugins.config.ApplicationXmlDocument	applicationXml
protected File	copyLibsDirectory When deploying loose applications, the optional directory to which application dependencies are copied.
protected long	timeout Timeout to verify deploy successfully, in seconds.

Fields inherited from class io.openliberty.tools.maven.server.PluginConfigSupport

appsDirectory, looseApplication, PLUGIN_CONFIG_XML, stripVersion

Fields inherited from class io.openliberty.tools.maven.server.StartDebugMojoSupport

bootstrapMavenProps, bootstrapProperties, bootstrapPropertiesFile, combinedBootstrapProperties, combinedJvmOptions, copyDependencies, defaultVarMavenProps, envMavenProps, HEADER, jvmMavenProps, jvmOptions, jvmOptionsFile, PLUGIN_VARIABLE_CONFIG_XML, pluginManager, serverXmlFile, varMavenProps

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

assemblyArchive, assemblyArtifact, assemblyInstallDirectory, configDirectory, defaultOutputDirSet, install, installDirectory, installType, isInstall, libertyRuntimeVersion, licenseArtifact, mergeServerEnv, messages, outputDirectory, refresh, serverDirectory, serverEnvFile, serverName, skip, START_APP_MESSAGE_REGEXP, userDirectory

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
DeployMojoSupport()

Method Summary

Modifier and Type	Method and Description
protected String	getAppFileName(org.apache.maven.project.MavenProject project)
protected String	getLooseConfigFileName(org.apache.maven.project.MavenProject project)
protected void	installApp(org.apache.maven.artifact.Artifact artifact)
protected void	installLooseConfigEar(org.apache.maven.project.MavenProject proj, io.openliberty.tools.common.plugins.config.LooseConfigData config)
protected void	installLooseConfigWar(org.apache.maven.project.MavenProject proj, io.openliberty.tools.common.plugins.config.LooseConfigData config, boolean container)
protected void	invokeSpringBootUtilCommand(File installDirectory, String fatArchiveSrcLocation, String thinArchiveTargetLocation, String libIndexCacheTargetLocation) Executes the SpringBootUtilTask to thin the Spring Boot application executable archive and place the thin archive and lib.index.cache in the specified location.
static boolean	isSupportedLooseAppType(String type)
protected boolean	isSupportedType(String type)
protected boolean	matches(org.apache.maven.artifact.Artifact artifact, org.codehaus.mojo.pluginsupport.util.ArtifactItem assemblyArtifact)
protected void	validateAppConfig(String fileName, String artifactId)
protected void	validateAppConfig(String fileName, String artifactId, boolean isSpringBootApp)
protected void	verifyAppStarted(String appFile)

Methods inherited from class io.openliberty.tools.maven.server.PluginConfigSupport

exportParametersToXml, findConfigFile, getAppConfigLocationsFromSourceServerXml, getApplicationFilename, getAppsDirectory, getDeployPackages, getLibertyAssemblyWarSourceDirectory, getWarSourceDirectory, installServerAssembly, isAnyAppConfiguredInSourceServerXml, isAppConfiguredInSourceServerXml, stripVersionFromName

Methods inherited from class io.openliberty.tools.maven.server.StartDebugMojoSupport

copyConfigFiles, getLibertyPlugin, getPlugin, getPluginFromPluginManagement, initializeJava, isConfigCopied, runLibertyMojoCreate, runLibertyMojoDeploy, runLibertyMojoDeploy, runLibertyMojoInstallFeature, runMojo

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

checkServerDirectoryExists, checkServerHomeExists, deleteApplication, deleteApplication, getLibertyDirectoryPropertyFiles, getLibertyDirectoryPropertyFiles, init, installFromArchive, installFromFile, installLicense

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

timeout

@Parameter(property="timeout",
           defaultValue="40")
protected long timeout

Timeout to verify deploy successfully, in seconds.

copyLibsDirectory

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

When deploying loose applications, the optional directory to which application dependencies are copied.

applicationXml

protected io.openliberty.tools.common.plugins.config.ApplicationXmlDocument applicationXml

Constructor Detail

DeployMojoSupport

public DeployMojoSupport()

Method Detail

installApp

protected void installApp(org.apache.maven.artifact.Artifact artifact)
                   throws Exception

Throws:

Exception

installLooseConfigWar

protected void installLooseConfigWar(org.apache.maven.project.MavenProject proj,
                                     io.openliberty.tools.common.plugins.config.LooseConfigData config,
                                     boolean container)
                              throws Exception

Throws:

Exception

installLooseConfigEar

protected void installLooseConfigEar(org.apache.maven.project.MavenProject proj,
                                     io.openliberty.tools.common.plugins.config.LooseConfigData config)
                              throws Exception

Throws:

Exception

verifyAppStarted

protected void verifyAppStarted(String appFile)
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getLooseConfigFileName

protected String getLooseConfigFileName(org.apache.maven.project.MavenProject project)

getAppFileName

protected String getAppFileName(org.apache.maven.project.MavenProject project)

validateAppConfig

protected void validateAppConfig(String fileName,
                                 String artifactId)
                          throws Exception

Throws:

Exception

validateAppConfig

protected void validateAppConfig(String fileName,
                                 String artifactId,
                                 boolean isSpringBootApp)
                          throws Exception

Throws:

Exception

invokeSpringBootUtilCommand

protected void invokeSpringBootUtilCommand(File installDirectory,
                                           String fatArchiveSrcLocation,
                                           String thinArchiveTargetLocation,
                                           String libIndexCacheTargetLocation)
                                    throws Exception

Executes the SpringBootUtilTask to thin the Spring Boot application executable archive and place the thin archive and lib.index.cache in the specified location.

Parameters:

installDirectory - : Installation directory of Liberty profile.

fatArchiveSrcLocation - : Source Spring Boot FAT executable archive location.

thinArchiveTargetLocation - : Target thin archive location.

libIndexCacheTargetLocation - : Library cache location.

Throws:

Exception

matches

protected boolean matches(org.apache.maven.artifact.Artifact artifact,
                          org.codehaus.mojo.pluginsupport.util.ArtifactItem assemblyArtifact)

isSupportedType

protected boolean isSupportedType(String type)

isSupportedLooseAppType

public static boolean isSupportedLooseAppType(String type)