AbstractTomEEMojo

java.lang.Object
- AbstractMojo
- - org.apache.openejb.maven.plugin.AbstractAddressMojo
  - - org.apache.openejb.maven.plugin.AbstractTomEEMojo

Direct Known Subclasses:

BuildTomEEMojo, ConfigTestTomEEMojo, StopTomEEMojo, UpdatableTomEEMojo
```
public abstract class AbstractTomEEMojo
extends AbstractAddressMojo
```
The type AbstractTomEEMojo is the base class to all the maven actions privided by the plugin.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AbstractTomEEMojo.Resolver
The interface Resolver.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AbstractTomEEMojo.Resolver` The interface Resolver.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`apacheRepos` The Apache repos.
`protected java.lang.String`	`appDir` relative to tomee.base.
`protected java.util.List<java.lang.String>`	`apps` The Apps.
`protected java.lang.String`	`args` The Args.
`protected java.lang.String`	`artifactId` The Artifact id.
`protected java.io.File`	`bin` The Bin.
`protected java.io.File`	`catalinaBase` The Catalina base.
`protected boolean`	`checkStarted` The Check started.
`protected int`	`checkStartedAttempts` The amount of attempts to check if the container is started.
`protected java.io.File`	`classes` The Classes.
`protected java.util.List<java.lang.String>`	`classpaths` The Classpaths.
`protected java.lang.String`	`classpathSeparator` The Classpath separator.
`protected java.io.File`	`config` The Config.
`protected java.lang.String`	`container` The Container.
`protected java.lang.String`	`context` rename the current artifact
`protected java.util.List<java.lang.String>`	`customizers` The Customizers.
`protected boolean`	`debug` The Debug.
`protected int`	`debugPort` The Debug port.
`protected java.io.File`	`deployedFile` The Deployed file.
`protected boolean`	`deployOpenEjbApplication` The Deploy open ejb application.
`protected java.util.List<java.io.File>`	`docBases` for TomEE and wars only, which docBase to use for this war.
`protected boolean`	`ejbRemote` The Ejb remote.
`protected java.util.List<java.lang.String>`	`endorsedLibs` The Endorsed libs.
`static java.lang.String`	`EXIT_CMD` The constant EXIT_CMD.
`protected java.util.List<java.io.File>`	`externalRepositories` for TomEE and wars only, add some external repositories to classloader.
`protected boolean`	`extractWars` The Extract wars.
`protected ArtifactFactory`	`factory` The Factory.
`protected java.lang.String`	`finalName` The Final name.
`protected boolean`	`forceJspDevelopment` force webapp to be reloadable
`protected boolean`	`forceReloadable` force webapp to be reloadable
`protected java.util.List<java.lang.String>`	`groovyCustomizers` The Groovy customizers.
`protected PlexusConfiguration`	`inlinedServerXml` server.xml configured inlined (is Server tag is the first child of inlinedServerXml)
`protected PlexusConfiguration`	`inlinedTomEEXml` tomee.xml configured inlined (is tomee tag is the first child of inlinedTomEEXml)
`protected java.util.List<java.lang.String>`	`javaagents` The Javaagents.
`protected java.util.List<java.lang.String>`	`jsCustomizers` The Js customizers.
`protected java.lang.String`	`keystore` the actual path used in server.xml for the https keystore if relevant.
`protected java.io.File`	`lib` The Lib.
`protected java.lang.String`	`libDir` relative to tomee.base.
`protected java.util.List<java.lang.String>`	`libs` supported formats: --> groupId:artifactId:version...
`protected ArtifactRepository`	`local` The Local.
`protected java.io.File`	`mainDir` The Main dir.
`protected boolean`	`overrideOnUnzip` if a file is already there when unpacking tomee zip should it be overriden?
`protected java.lang.String`	`packaging` The Packaging.
`protected boolean`	`persistJavaagents` The Persist javaagents.
`protected MavenProject`	`project` The Project.
`protected boolean`	`quickSession` use a real random instead of secure random.
`static java.lang.String`	`QUIT_CMD` The constant QUIT_CMD.
`protected java.util.List<ArtifactRepository>`	`remoteRepos` The Remote repos.
`protected boolean`	`removeDefaultWebapps` The Remove default webapps.
`protected boolean`	`removeTomeeWebapp` The Remove tomee webapp.
`protected ArtifactResolver`	`resolver` The Resolver.
`protected RemoteServer`	`server` The Server.
`protected Settings`	`settings` The current user system settings for use in Maven.
`protected boolean`	`simpleLog` The Simple log.
`protected boolean`	`skipCurrentProject` The Skip current project.
`protected boolean`	`skipRootFolderOnUnzip` if a file is already there when unpacking tomee zip should it be overriden?
`protected boolean`	`stripVersion` The Strip version.
`protected boolean`	`stripWarVersion` The Strip war version.
`protected java.util.Map<java.lang.String,java.lang.String>`	`systemVariables` The System variables.
`protected java.io.File`	`target` The Target.
`static java.lang.String`	`TOM_EE` The constant TOM_EE.
`protected java.lang.String`	`tomeeAjpPort` The TomEE ajp port.
`protected boolean`	`tomeeAlreadyInstalled` The TomEE already installed.
`protected java.lang.String`	`tomeeArtifactId` The TomEE artifact id.
`protected java.lang.String`	`tomeeClassifier` tomee classifier to use (webprofile or plus)
`protected java.lang.String`	`tomeeGroupId` The TomEE group id.
`protected int`	`tomeeShutdownAttempts` The TomEE shutdown attempts.
`protected java.lang.String`	`tomeeShutdownCommand` The TomEE shutdown command.
`protected java.lang.String`	`tomeeShutdownPort` The TomEE shutdown port.
`protected java.lang.String`	`tomeeType` while tar.gz is not managed it is readonly
`protected java.lang.String`	`tomeeVersion` The TomEE version.
`protected boolean`	`useConsole` The Use console.
`protected boolean`	`useOpenEJB` use openejb-standalone automatically instead of TomEE
`protected java.io.File`	`warFile` The War file.
`protected java.io.File`	`webappClasses` The Webapp classes.
`protected boolean`	`webappDefaultConfig` forcing nice default for war development (WEB-INF/classes and web resources)
`protected java.lang.String`	`webappDir` relative to tomee.base.
`protected java.io.File`	`webappResources` The Webapp resources.
`protected java.util.List<java.lang.String>`	`webapps` The Webapps.
`protected java.io.File`	`workWarFile` The Work war file.

Fields inherited from class org.apache.openejb.maven.plugin.AbstractAddressMojo
password, realm, tomeeHost, tomeeHttpPort, tomeeHttpsPort, user

Constructor Summary

Constructors
Constructor and Description

AbstractTomEEMojo()

Constructors
Constructor and Description
`AbstractTomEEMojo()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addShutdownHooks(RemoteServer server)` Add shutdown hooks.
`protected java.util.Collection<java.lang.String>`	`availableCommands()` Available commands collection.
`protected java.lang.String`	`destinationName()` Destination name string.
`void`	`execute()`
`protected void`	`fixConfig()` Fix config.
`protected java.util.List<java.lang.String>`	`generateJVMArgs()` Generate jvm args list.
`protected java.lang.String`	`getAdditionalClasspath()` Gets additional classpath.
`abstract java.lang.String`	`getCmd()` Gets cmd.
`protected int`	`getConnectAttempts()` Gets connect attempts.
`protected boolean`	`getWaitTomEE()` Gets wait TomEE.
`protected boolean`	`handleLine(java.lang.String line)` Handle line boolean.
`protected void`	`run()` Run.
`protected void`	`serverCmd(RemoteServer server, java.util.List<java.lang.String> strings)` Server cmd.
`protected void`	`stopServer(java.util.concurrent.CountDownLatch stopCondition)` Stop server.

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 java.lang.String QUIT_CMD
```
    The constant QUIT_CMD.
    
    See Also:
    
    Constant Field Values
  - EXIT_CMD
```
public static final java.lang.String EXIT_CMD
```
    The constant EXIT_CMD.
    
    See Also:
    
    Constant Field Values
  - TOM_EE
```
public static final java.lang.String TOM_EE
```
    The constant TOM_EE.
    
    See Also:
    
    Constant Field Values
  - factory
```
protected ArtifactFactory factory
```
    The Factory.
  - resolver
```
protected ArtifactResolver resolver
```
    The Resolver.
  - local
```
protected ArtifactRepository local
```
    The Local.
  - remoteRepos
```
protected java.util.List<ArtifactRepository> remoteRepos
```
    The Remote repos.
  - skipCurrentProject
```
protected boolean skipCurrentProject
```
    The Skip current project.
  - tomeeVersion
```
protected java.lang.String tomeeVersion
```
    The TomEE version.
  - tomeeGroupId
```
protected java.lang.String tomeeGroupId
```
    The TomEE group id.
  - tomeeArtifactId
```
protected java.lang.String tomeeArtifactId
```
    The TomEE artifact id.
  - tomeeType
```
protected java.lang.String tomeeType
```
    while tar.gz is not managed it is readonly
  - apacheRepos
```
protected java.lang.String apacheRepos
```
    The Apache repos.
  - tomeeClassifier
```
protected java.lang.String tomeeClassifier
```
    tomee classifier to use (webprofile or plus)
  - tomeeShutdownPort
```
protected java.lang.String tomeeShutdownPort
```
    The TomEE shutdown port.
  - tomeeShutdownAttempts
```
protected int tomeeShutdownAttempts
```
    The TomEE shutdown attempts.
  - tomeeShutdownCommand
```
protected java.lang.String tomeeShutdownCommand
```
    The TomEE shutdown command.
  - tomeeAjpPort
```
protected java.lang.String tomeeAjpPort
```
    The TomEE ajp port.
  - args
```
protected java.lang.String args
```
    The Args.
  - debug
```
protected boolean debug
```
    The Debug.
  - simpleLog
```
protected boolean simpleLog
```
    The Simple log.
  - extractWars
```
protected boolean extractWars
```
    The Extract wars.
  - stripWarVersion
```
protected boolean stripWarVersion
```
    The Strip war version.
  - stripVersion
```
protected boolean stripVersion
```
    The Strip version.
  - debugPort
```
protected int debugPort
```
    The Debug port.
  - webappResources
```
protected java.io.File webappResources
```
    The Webapp resources.
  - webappClasses
```
protected java.io.File webappClasses
```
    The Webapp classes.
  - catalinaBase
```
protected java.io.File catalinaBase
```
    The Catalina base.
  - context
```
protected java.lang.String context
```
    rename the current artifact
  - webappDir
```
protected java.lang.String webappDir
```
    relative to tomee.base.
  - appDir
```
protected java.lang.String appDir
```
    relative to tomee.base.
  - libDir
```
protected java.lang.String libDir
```
    relative to tomee.base.
  - mainDir
```
protected java.io.File mainDir
```
    The Main dir.
  - target
```
protected java.io.File target
```
    The Target.
  - config
```
protected java.io.File config
```
    The Config.
  - bin
```
protected java.io.File bin
```
    The Bin.
  - lib
```
protected java.io.File lib
```
    The Lib.
  - systemVariables
```
protected java.util.Map<java.lang.String,java.lang.String> systemVariables
```
    The System variables.
  - classpaths
```
protected java.util.List<java.lang.String> classpaths
```
    The Classpaths.
  - classpathSeparator
```
protected java.lang.String classpathSeparator
```
    The Classpath separator.
  - customizers
```
protected java.util.List<java.lang.String> customizers
```
    The Customizers.
  - jsCustomizers
```
protected java.util.List<java.lang.String> jsCustomizers
```
    The Js customizers.
  - groovyCustomizers
```
protected java.util.List<java.lang.String> groovyCustomizers
```
    The Groovy customizers.
  - project
```
protected MavenProject project
```
    The Project.
  - webappDefaultConfig
```
protected boolean webappDefaultConfig
```
    forcing nice default for war development (WEB-INF/classes and web resources)
  - quickSession
```
protected boolean quickSession
```
    use a real random instead of secure random. saves few ms at startup.
  - forceReloadable
```
protected boolean forceReloadable
```
    force webapp to be reloadable
  - forceJspDevelopment
```
protected boolean forceJspDevelopment
```
    force webapp to be reloadable
  - libs
```
protected java.util.List<java.lang.String> libs
```
    supported formats: --> groupId:artifactId:version... --> unzip:groupId:artifactId:version... --> remove:prefix (often prefix = artifactId)
  - endorsedLibs
```
protected java.util.List<java.lang.String> endorsedLibs
```
    The Endorsed libs.
  - javaagents
```
protected java.util.List<java.lang.String> javaagents
```
    The Javaagents.
  - persistJavaagents
```
protected boolean persistJavaagents
```
    The Persist javaagents.
  - webapps
```
protected java.util.List<java.lang.String> webapps
```
    The Webapps.
  - apps
```
protected java.util.List<java.lang.String> apps
```
    The Apps.
  - classes
```
protected java.io.File classes
```
    The Classes.
  - warFile
```
protected java.io.File warFile
```
    The War file.
  - workWarFile
```
protected java.io.File workWarFile
```
    The Work war file.
  - finalName
```
protected java.lang.String finalName
```
    The Final name.
  - artifactId
```
protected java.lang.String artifactId
```
    The Artifact id.
  - removeDefaultWebapps
```
protected boolean removeDefaultWebapps
```
    The Remove default webapps.
  - deployOpenEjbApplication
```
protected boolean deployOpenEjbApplication
```
    The Deploy open ejb application.
  - removeTomeeWebapp
```
protected boolean removeTomeeWebapp
```
    The Remove tomee webapp.
  - ejbRemote
```
protected boolean ejbRemote
```
    The Ejb remote.
  - packaging
```
protected java.lang.String packaging
```
    The Packaging.
  - checkStarted
```
protected boolean checkStarted
```
    The Check started.
  - checkStartedAttempts
```
protected int checkStartedAttempts
```
    The amount of attempts to check if the container is started.
  - useConsole
```
protected boolean useConsole
```
    The Use console.
  - tomeeAlreadyInstalled
```
protected boolean tomeeAlreadyInstalled
```
    The TomEE already installed.
  - settings
```
protected Settings settings
```
    The current user system settings for use in Maven.
  - useOpenEJB
```
protected boolean useOpenEJB
```
    use openejb-standalone automatically instead of TomEE
  - docBases
```
protected java.util.List<java.io.File> docBases
```
    for TomEE and wars only, which docBase to use for this war.
  - externalRepositories
```
protected java.util.List<java.io.File> externalRepositories
```
    for TomEE and wars only, add some external repositories to classloader.
  - inlinedServerXml
```
protected PlexusConfiguration inlinedServerXml
```
    server.xml configured inlined (is Server tag is the first child of inlinedServerXml)
  - inlinedTomEEXml
```
protected PlexusConfiguration inlinedTomEEXml
```
    tomee.xml configured inlined (is tomee tag is the first child of inlinedTomEEXml)
  - overrideOnUnzip
```
protected boolean overrideOnUnzip
```
    if a file is already there when unpacking tomee zip should it be overriden?
  - skipRootFolderOnUnzip
```
protected boolean skipRootFolderOnUnzip
```
    if a file is already there when unpacking tomee zip should it be overriden?
  - keystore
```
protected java.lang.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 java.io.File deployedFile
```
    The Deployed file.
  - server
```
protected RemoteServer server
```
    The Server.
  - container
```
protected java.lang.String container
```
    The Container.
- Constructor Detail
  - AbstractTomEEMojo
```
public AbstractTomEEMojo()
```
- Method Detail
  - execute
```
public void execute()
             throws MojoExecutionException,
                    MojoFailureException
```
    Throws:
    
    MojoExecutionException
    
    MojoFailureException
  - fixConfig
```
protected void fixConfig()
```
    Fix config.
  - getAdditionalClasspath
```
protected java.lang.String getAdditionalClasspath()
```
    Gets additional classpath.
    
    Returns:
    
    the additional classpath
  - destinationName
```
protected java.lang.String destinationName()
```
    Destination name string.
    
    Returns:
    
    the string
  - run
```
protected void run()
```
    Run.
  - generateJVMArgs
```
protected java.util.List<java.lang.String> generateJVMArgs()
```
    Generate jvm args list.
    
    Returns:
    
    the list
  - availableCommands
```
protected java.util.Collection<java.lang.String> availableCommands()
```
    Available commands collection.
    
    Returns:
    
    the collection
  - stopServer
```
protected void stopServer(java.util.concurrent.CountDownLatch stopCondition)
```
    Stop server.
    
    Parameters:
    
    stopCondition - the stop condition
  - handleLine
```
protected boolean handleLine(java.lang.String line)
```
    Handle line boolean.
    
    Parameters:
    
    line - the line
    
    Returns:
    
    the boolean
  - serverCmd
```
protected void serverCmd(RemoteServer server,
                         java.util.List<java.lang.String> strings)
```
    Server cmd.
    
    Parameters:
    
    server - the server
    
    strings - the strings
  - addShutdownHooks
```
protected void addShutdownHooks(RemoteServer server)
```
    Add shutdown hooks.
    
    Parameters:
    
    server - the server
  - getConnectAttempts
```
protected int getConnectAttempts()
```
    Gets connect attempts.
    
    Returns:
    
    the connect attempts
  - getWaitTomEE
```
protected boolean getWaitTomEE()
```
    Gets wait TomEE.
    
    Returns:
    
    the wait TomEE
  - getCmd
```
public abstract java.lang.String getCmd()
```
    Gets cmd.
    
    Returns:
    
    the cmd

Class AbstractTomEEMojo

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUIT_CMD

EXIT_CMD

TOM_EE

factory

resolver

local

remoteRepos

skipCurrentProject

tomeeVersion

tomeeGroupId

tomeeArtifactId

tomeeType

apacheRepos

tomeeClassifier

tomeeShutdownPort

tomeeShutdownAttempts

tomeeShutdownCommand

tomeeAjpPort

args

debug

simpleLog

extractWars

stripWarVersion

stripVersion

debugPort

webappResources

webappClasses

catalinaBase

context

webappDir

appDir

libDir

mainDir

target

config

bin

lib

systemVariables

classpaths

classpathSeparator

customizers

jsCustomizers

groovyCustomizers

project

webappDefaultConfig

quickSession

forceReloadable

forceJspDevelopment

libs

endorsedLibs

javaagents

persistJavaagents

webapps

apps

classes

warFile

workWarFile

finalName

artifactId

removeDefaultWebapps

deployOpenEjbApplication

removeTomeeWebapp

ejbRemote

packaging

checkStarted

checkStartedAttempts

useConsole

tomeeAlreadyInstalled

settings

useOpenEJB

docBases

externalRepositories