org.apache.openejb.maven.plugin

Class AbstractTomEEMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.openejb.maven.plugin.AbstractAddressMojo

org.apache.openejb.maven.plugin.AbstractTomEEMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

BuildTomEEMojo, ConfigTestTomEEMojo, StopTomEEMojo, UpdatableTomEEMojo

public abstract class AbstractTomEEMojo
extends AbstractAddressMojo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractTomEEMojo.Resolver

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apacheRepos
protected String	appDir relative to tomee.base.
protected List<String>	apps
protected String	args
protected String	artifactId
protected File	bin
protected File	catalinaBase
protected boolean	checkStarted
protected File	classes
protected List<String>	classpaths
protected File	config
protected String	container
protected String	context rename the current artifact
protected List<String>	customizers
protected boolean	debug
protected int	debugPort
protected File	deployedFile
protected boolean	deployOpenEjbApplication
protected List<File>	docBases for TomEE and wars only, which docBase to use for this war.
protected boolean	ejbRemote
protected List<String>	endorsedLibs
static String	EXIT_CMD
protected List<File>	externalRepositories for TomEE and wars only, add some external repositories to classloader.
protected boolean	extractWars
protected org.apache.maven.artifact.factory.ArtifactFactory	factory
protected String	finalName
protected boolean	forceJspDevelopment force webapp to be reloadable
protected boolean	forceReloadable force webapp to be reloadable
protected List<String>	groovyCustomizers
protected org.codehaus.plexus.configuration.PlexusConfiguration	inlinedServerXml server.xml configured inlined (is Server tag is the first child of inlinedServerXml)
protected org.codehaus.plexus.configuration.PlexusConfiguration	inlinedTomEEXml tomee.xml configured inlined (is tomee tag is the first child of inlinedTomEEXml)
protected List<String>	javaagents
protected List<String>	jsCustomizers
protected String	keystore the actual path used in server.xml for the https keystore if relevant.
protected File	lib
protected String	libDir relative to tomee.base.
protected List<String>	libs supported formats: --> groupId:artifactId:version... --> unzip:groupId:artifactId:version... --> remove:prefix (often prefix = artifactId)
protected org.apache.maven.artifact.repository.ArtifactRepository	local
protected File	mainDir
protected boolean	overrideOnUnzip if a file is already there when unpacking tomee zip should it be overriden?
protected String	packaging
protected boolean	persistJavaagents
protected org.apache.maven.project.MavenProject	project
protected boolean	quickSession use a real random instead of secure random. saves few ms at startup.
static String	QUIT_CMD
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepos
protected boolean	removeDefaultWebapps
protected boolean	removeTomeeWebapp
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver
protected RemoteServer	server
protected org.apache.maven.settings.Settings	settings The current user system settings for use in Maven.
protected boolean	simpleLog
protected boolean	skipCurrentProject
protected boolean	skipRootFolderOnUnzip if a file is already there when unpacking tomee zip should it be overriden?
protected boolean	stripVersion
protected boolean	stripWarVersion
protected Map<String,String>	systemVariables
protected File	target
static String	TOM_EE
protected String	tomeeAjpPort
protected boolean	tomeeAlreadyInstalled
protected String	tomeeArtifactId
protected String	tomeeClassifier tomee classifier to use (webprofile or plus)
protected String	tomeeGroupId
protected int	tomeeShutdownAttempts
protected String	tomeeShutdownCommand
protected String	tomeeShutdownPort
protected String	tomeeType while tar.gz is not managed it is readonly
protected String	tomeeVersion
protected boolean	useConsole
protected boolean	useOpenEJB use openejb-standalone automatically instead of TomEE
protected File	warFile
protected File	webappClasses
protected boolean	webappDefaultConfig forcing nice default for war development (WEB-INF/classes and web resources)
protected String	webappDir relative to tomee.base.
protected File	webappResources
protected List<String>	webapps
protected File	workWarFile

Fields inherited from class org.apache.openejb.maven.plugin.AbstractAddressMojo

password, realm, tomeeHost, tomeeHttpPort, tomeeHttpsPort, user

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractTomEEMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addShutdownHooks(RemoteServer server)
protected Collection<String>	availableCommands()
protected String	destinationName()
void	execute()
protected void	fixConfig()
protected List<String>	generateJVMArgs()
protected String	getAdditionalClasspath()
abstract String	getCmd()
protected int	getConnectAttempts()
protected boolean	getWaitTomEE()
protected boolean	handleLine(String line)
protected void	run()
protected void	serverCmd(RemoteServer server, List<String> strings)
protected void	stopServer(CountDownLatch stopCondition)

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

QUIT_CMD

public static final String QUIT_CMD

See Also:

Constant Field Values

EXIT_CMD

public static final String EXIT_CMD

See Also:

Constant Field Values

TOM_EE

public static final String TOM_EE

See Also:

Constant Field Values

factory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory factory

resolver

@Component
protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

local

@Parameter(defaultValue="${localRepository}",
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository local

remoteRepos

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true)
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepos

skipCurrentProject

@Parameter(property="tomee-plugin.skipCurrentProject",
           defaultValue="false")
protected boolean skipCurrentProject

tomeeVersion

@Parameter(property="tomee-plugin.version",
           defaultValue="-1")
protected String tomeeVersion

tomeeGroupId

@Parameter(property="tomee-plugin.groupId",
           defaultValue="org.apache.tomee")
protected String tomeeGroupId

tomeeArtifactId

@Parameter(property="tomee-plugin.artifactId",
           defaultValue="apache-tomee")
protected String tomeeArtifactId

tomeeType

@Parameter(property="tomee-plugin.type",
           defaultValue="zip",
           readonly=true)
protected String tomeeType

while tar.gz is not managed it is readonly

apacheRepos

@Parameter(property="tomee-plugin.apache-repos",
           defaultValue="snapshots")
protected String apacheRepos

tomeeClassifier

@Parameter(property="tomee-plugin.classifier",
           defaultValue="webprofile")
protected String tomeeClassifier

tomee classifier to use (webprofile or plus)

tomeeShutdownPort

@Parameter(property="tomee-plugin.shutdown")
protected String tomeeShutdownPort

tomeeShutdownAttempts

@Parameter(property="tomee-plugin.shutdown.attempts",
           defaultValue="60")
protected int tomeeShutdownAttempts

tomeeShutdownCommand

@Parameter(property="tomee-plugin.shutdown-command",
           defaultValue="SHUTDOWN")
protected String tomeeShutdownCommand

tomeeAjpPort

@Parameter(property="tomee-plugin.ajp")
protected String tomeeAjpPort

args

@Parameter(property="tomee-plugin.args")
protected String args

debug

@Parameter(property="tomee-plugin.debug",
           defaultValue="false")
protected boolean debug

simpleLog

@Parameter(property="tomee-plugin.simple-log",
           defaultValue="false")
protected boolean simpleLog

extractWars

@Parameter(property="tomee-plugin.extractWars",
           defaultValue="false")
protected boolean extractWars

stripWarVersion

@Parameter(property="tomee-plugin.stripWarVersion",
           defaultValue="true")
protected boolean stripWarVersion

stripVersion

@Parameter(property="tomee-plugin.stripVersion",
           defaultValue="false")
protected boolean stripVersion

debugPort

@Parameter(property="tomee-plugin.debugPort",
           defaultValue="5005")
protected int debugPort

webappResources

@Parameter(defaultValue="${project.basedir}/src/main/webapp",
           property="tomee-plugin.webappResources")
protected File webappResources

webappClasses

@Parameter(defaultValue="${project.build.outputDirectory}",
           property="tomee-plugin.webappClasses")
protected File webappClasses

catalinaBase

@Parameter(defaultValue="${project.build.directory}/apache-tomee",
           property="tomee-plugin.catalina-base")
protected File catalinaBase

context

@Parameter
protected String context

rename the current artifact

webappDir

@Parameter
protected String webappDir

relative to tomee.base.

appDir

@Parameter(defaultValue="apps")
protected String appDir

relative to tomee.base.

libDir

@Parameter(defaultValue="lib")
protected String libDir

relative to tomee.base.

mainDir

@Parameter(defaultValue="${project.basedir}/src/main")
protected File mainDir

target

@Parameter(defaultValue="${project.build.directory}")
protected File target

config

@Parameter(property="tomee-plugin.conf",
           defaultValue="${project.basedir}/src/main/tomee/conf")
protected File config

bin

@Parameter(property="tomee-plugin.bin",
           defaultValue="${project.basedir}/src/main/tomee/bin")
protected File bin

lib

@Parameter(property="tomee-plugin.lib",
           defaultValue="${project.basedir}/src/main/tomee/lib")
protected File lib

systemVariables

@Parameter
protected Map<String,String> systemVariables

classpaths

@Parameter
protected List<String> classpaths

customizers

@Parameter
protected List<String> customizers

jsCustomizers

@Parameter
protected List<String> jsCustomizers

groovyCustomizers

@Parameter
protected List<String> groovyCustomizers

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

webappDefaultConfig

@Parameter(property="tomee-plugin.webappDefaultConfig",
           defaultValue="false")
protected boolean webappDefaultConfig

forcing nice default for war development (WEB-INF/classes and web resources)

quickSession

@Parameter(property="tomee-plugin.quick-session",
           defaultValue="true")
protected boolean quickSession

use a real random instead of secure random. saves few ms at startup.

forceReloadable

@Parameter(property="tomee-plugin.force-reloadable",
           defaultValue="false")
protected boolean forceReloadable

force webapp to be reloadable

forceJspDevelopment

@Parameter(property="tomee-plugin.jsp-development",
           defaultValue="true")
protected boolean forceJspDevelopment

force webapp to be reloadable

libs

@Parameter
protected List<String> libs

supported formats: --> groupId:artifactId:version... --> unzip:groupId:artifactId:version... --> remove:prefix (often prefix = artifactId)

endorsedLibs

@Parameter
protected List<String> endorsedLibs

javaagents

@Parameter
protected List<String> javaagents

persistJavaagents

@Parameter(property="tomee-plugin.persist-javaagents",
           defaultValue="false")
protected boolean persistJavaagents

webapps

@Parameter
protected List<String> webapps

apps

@Parameter
protected List<String> apps

classes

@Parameter(property="tomee-plugin.classes",
           defaultValue="${project.build.outputDirectory}",
           readonly=true)
protected File classes

warFile

@Parameter(defaultValue="${project.build.directory}/${project.build.finalName}.${project.packaging}")
protected File warFile

workWarFile

@Parameter(defaultValue="${project.build.directory}/${project.build.finalName}",
           readonly=true)
protected File workWarFile

finalName

@Parameter(defaultValue="${project.build.finalName}",
           readonly=true)
protected String finalName

artifactId

@Parameter(defaultValue="${project.artifactId}",
           readonly=true)
protected String artifactId

removeDefaultWebapps

@Parameter(property="tomee-plugin.remove-default-webapps",
           defaultValue="true")
protected boolean removeDefaultWebapps

deployOpenEjbApplication

@Parameter(property="tomee-plugin.deploy-openejb-internal-application",
           defaultValue="false")
protected boolean deployOpenEjbApplication

removeTomeeWebapp

@Parameter(property="tomee-plugin.remove-tomee-webapps",
           defaultValue="true")
protected boolean removeTomeeWebapp

ejbRemote

@Parameter(property="tomee-plugin.ejb-remote",
           defaultValue="true")
protected boolean ejbRemote

packaging

@Parameter(defaultValue="${project.packaging}",
           readonly=true)
protected String packaging

checkStarted

@Parameter(property="tomee-plugin.check-started",
           defaultValue="false")
protected boolean checkStarted

useConsole

@Parameter(property="tomee-plugin.use-console",
           defaultValue="true")
protected boolean useConsole

tomeeAlreadyInstalled

@Parameter(property="tomee-plugin.exiting",
           defaultValue="false")
protected boolean tomeeAlreadyInstalled

settings

@Parameter(defaultValue="${settings}",
           readonly=true)
protected org.apache.maven.settings.Settings settings

The current user system settings for use in Maven.

useOpenEJB

@Parameter(property="tomee-plugin.openejb",
           defaultValue="false")
protected boolean useOpenEJB

use openejb-standalone automatically instead of TomEE

docBases

@Parameter
protected List<File> docBases

for TomEE and wars only, which docBase to use for this war.

externalRepositories

@Parameter
protected List<File> externalRepositories

for TomEE and wars only, add some external repositories to classloader.

inlinedServerXml

@Parameter
protected org.codehaus.plexus.configuration.PlexusConfiguration inlinedServerXml

server.xml configured inlined (is Server tag is the first child of inlinedServerXml)

inlinedTomEEXml

@Parameter
protected org.codehaus.plexus.configuration.PlexusConfiguration inlinedTomEEXml

tomee.xml configured inlined (is tomee tag is the first child of inlinedTomEEXml)

overrideOnUnzip

@Parameter(property="tomee-plugin.override-on-unzip",
           defaultValue="true")
protected boolean overrideOnUnzip

if a file is already there when unpacking tomee zip should it be overriden?

skipRootFolderOnUnzip

@Parameter(property="tomee-plugin.skip-root-folder-on-unzip",
           defaultValue="true")
protected boolean skipRootFolderOnUnzip

if a file is already there when unpacking tomee zip should it be overriden?

keystore

@Parameter(property="tomee-plugin.keystore")
protected String keystore

the actual path used in server.xml for the https keystore if relevant. Common usage will be to put in src/main/tomee/conf a keystore foo.jks and set this value to ${catalina.base}/foo.jks.

Note: if not set we'll check for any *.jks in conf/. You can set it to "ignore" to skip this.

deployedFile

protected File deployedFile

server

protected RemoteServer server

container

protected String container

Constructor Detail

AbstractTomEEMojo

public AbstractTomEEMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

fixConfig

protected void fixConfig()

getAdditionalClasspath

protected String getAdditionalClasspath()

destinationName

protected String destinationName()

run

protected void run()

generateJVMArgs

protected List<String> generateJVMArgs()

availableCommands

protected Collection<String> availableCommands()

stopServer

protected void stopServer(CountDownLatch stopCondition)

handleLine

protected boolean handleLine(String line)

serverCmd

protected void serverCmd(RemoteServer server,
             List<String> strings)

addShutdownHooks

protected void addShutdownHooks(RemoteServer server)

getConnectAttempts

protected int getConnectAttempts()

getWaitTomEE

protected boolean getWaitTomEE()

getCmd

public abstract String getCmd()