http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/exec-mojo.md ---------------------------------------------------------------------- diff --git a/docs/maven/exec-mojo.md b/docs/maven/exec-mojo.md deleted file mode 100644 index 4435c7c..0000000 --- a/docs/maven/exec-mojo.md +++ /dev/null @@ -1,1551 +0,0 @@ -index-group=Unrevised -type=page -status=published -~~~~~~ -<div class="section"> -<h2>tomee:exec<a name="tomee:exec"></a></h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:exec</p> - -<p><b>Description</b>:</p> - -<div>(no description)</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>Requires a Maven project to be executed.</li> - -<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li> - -<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li> - </ul> - -<div class="section"> -<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - -<table class="mdtable"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><b><a href="#apacheRepos">apacheRepos</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>snapshots</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.apache-repos</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#appDir">appDir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>apps</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#apps">apps</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#args">args</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.args</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#attach">attach</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.attach</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#bin">bin</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/bin</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.bin</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#catalinaBase">catalinaBase</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.catalina-base</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#checkStarted">checkStarted</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.check-started</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#classifier">classifier</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#classpaths">classpaths</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#config">config</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/conf</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.conf</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#context">context</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>rename the current artifact<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#debug">debug</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debug</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#debugPort">debugPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>5005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.debugPort</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#deployOpenEjbApplication">deployOpenEjbApplication</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#distributionName">distributionName</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>tomee.zip</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.distribution-name</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#docBases">docBases</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>for TomEE and wars only, which docBase to use for this war.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#ejbRemote">ejbRemote</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ejb-remote</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#execFile">execFile</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}-exec.jar</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exec-file</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#externalRepositories">externalRepositories</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>for TomEE and wars only, add some external repositories to -classloader.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#forceReloadable">forceReloadable</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>force webapp to be reloadable<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.force-reloadable</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#javaagents">javaagents</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#keepServerXmlAsthis">keepServerXmlAsthis</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(Removed since 7.0.0)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.keep-server-xml</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#lib">lib</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/tomee/lib</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.lib</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#libDir">libDir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>lib</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#libs">libs</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>supported formats: --> groupId:artifactId:version... --> -unzip:groupId:artifactId:version... --> remove:prefix (often -prefix = artifactId)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#mainDir">mainDir</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#password">password</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#quickSession">quickSession</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>use a real random instead of secure random. saves few ms at -startup.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.quick-session</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#realm">realm</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#removeDefaultWebapps">removeDefaultWebapps</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-default-webapps</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#removeTomeeWebapp">removeTomeeWebapp</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.remove-tomee-webapps</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#runnerClass">runnerClass</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb.maven.plugin.runner.ExecRunner</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.runner-class</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#runtimeWorkingDir">runtimeWorkingDir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>.distribution</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.runtime-working-dir</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#script">script</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>bin/catalina[.sh|.bat]</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.script</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#simpleLog">simpleLog</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.simple-log</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#skipCurrentProject">skipCurrentProject</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipCurrentProject</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#skipWarResources">skipWarResources</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>when you set docBases to src/main/webapp setting it to true will -allow hot refresh.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.skipWarResources</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#systemVariables">systemVariables</a></b></td> - -<td><tt>Map</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#target">target</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeAjpPort">tomeeAjpPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8009</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.ajp</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeAlreadyInstalled">tomeeAlreadyInstalled</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.exiting</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeArtifactId">tomeeArtifactId</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>apache-tomee</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.artifactId</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeClassifier">tomeeClassifier</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>webprofile</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.classifier</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeGroupId">tomeeGroupId</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>org.apache.openejb</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.groupId</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeHost">tomeeHost</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeHttpsPort">tomeeHttpsPort</a></b></td> - -<td><tt>Integer</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.https</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeShutdownCommand">tomeeShutdownCommand</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>SHUTDOWN</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown-command</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeShutdownPort">tomeeShutdownPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8005</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.shutdown</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeVersion">tomeeVersion</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>-1</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.version</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#useConsole">useConsole</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.use-console</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#useOpenEJB">useOpenEJB</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>use openejb-standalone automatically instead of TomEE<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.openejb</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#user">user</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#warFile">warFile</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt>.<br /></td> - </tr> - -<tr class="a"> - -<td><b><a href="#webappClasses">webappClasses</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappClasses</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#webappDefaultConfig">webappDefaultConfig</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>forcing nice default for war development (WEB-INF/classes and web -resources)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappDefaultConfig</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#webappDir">webappDir</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>relative to tomee.base.<br /><b>Default value is</b>: <tt>webapps</tt>.<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#webappResources">webappResources</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.basedir}/src/main/webapp</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.webappResources</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#webapps">webapps</a></b></td> - -<td><tt>List</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /></td> - </tr> - -<tr class="b"> - -<td><b><a href="#zip">zip</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#zipFile">zipFile</a></b></td> - -<td><tt>File</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.zip-file</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3>Parameter Details<a name="Parameter_Details"></a></h3> - -<p><b><a name="apacheRepos">apacheRepos</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.apache-repos</tt></li> - -<li><b>Default</b>: <tt>snapshots</tt></li> - </ul><hr /> -<p><b><a name="appDir">appDir</a>:</b></p> - -<div>relative to tomee.base.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>apps</tt></li> - </ul><hr /> -<p><b><a name="apps">apps</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="args">args</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.args</tt></li> - </ul><hr /> -<p><b><a name="attach">attach</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.attach</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="bin">bin</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.bin</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/bin</tt></li> - </ul><hr /> -<p><b><a name="catalinaBase">catalinaBase</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.catalina-base</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/apache-tomee</tt></li> - </ul><hr /> -<p><b><a name="checkStarted">checkStarted</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.check-started</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="classifier">classifier</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li> - </ul><hr /> -<p><b><a name="classpaths">classpaths</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="config">config</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.conf</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/conf</tt></li> - </ul><hr /> -<p><b><a name="context">context</a>:</b></p> - -<div>rename the current artifact</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="debug">debug</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.debug</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="debugPort">debugPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.debugPort</tt></li> - -<li><b>Default</b>: <tt>5005</tt></li> - </ul><hr /> -<p><b><a name="deployOpenEjbApplication">deployOpenEjbApplication</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.deploy-openejb-internal-application</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="distributionName">distributionName</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.distribution-name</tt></li> - -<li><b>Default</b>: <tt>tomee.zip</tt></li> - </ul><hr /> -<p><b><a name="docBases">docBases</a>:</b></p> - -<div>for TomEE and wars only, which docBase to use for this war.</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="ejbRemote">ejbRemote</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.ejb-remote</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="execFile">execFile</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.exec-file</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}-exec.jar</tt></li> - </ul><hr /> -<p><b><a name="externalRepositories">externalRepositories</a>:</b></p> - -<div>for TomEE and wars only, add some external repositories to -classloader.</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="forceReloadable">forceReloadable</a>:</b></p> - -<div>force webapp to be reloadable</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.force-reloadable</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="javaagents">javaagents</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="keepServerXmlAsthis">keepServerXmlAsthis</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.keep-server-xml</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="lib">lib</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.lib</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/tomee/lib</tt></li> - </ul><hr /> -<p><b><a name="libDir">libDir</a>:</b></p> - -<div>relative to tomee.base.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>lib</tt></li> - </ul><hr /> -<p><b><a name="libs">libs</a>:</b></p> - -<div>supported formats: --> groupId:artifactId:version... --> -unzip:groupId:artifactId:version... --> remove:prefix (often -prefix = artifactId)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="mainDir">mainDir</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main</tt></li> - </ul><hr /> -<p><b><a name="password">password</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li> - </ul><hr /> -<p><b><a name="quickSession">quickSession</a>:</b></p> - -<div>use a real random instead of secure random. saves few ms at -startup.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.quick-session</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="realm">realm</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li> - </ul><hr /> -<p><b><a name="removeDefaultWebapps">removeDefaultWebapps</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.remove-default-webapps</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="removeTomeeWebapp">removeTomeeWebapp</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.remove-tomee-webapps</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="runnerClass">runnerClass</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.runner-class</tt></li> - -<li><b>Default</b>: <tt>org.apache.openejb.maven.plugin.runner.ExecRunner</tt></li> - </ul><hr /> -<p><b><a name="runtimeWorkingDir">runtimeWorkingDir</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.runtime-working-dir</tt></li> - -<li><b>Default</b>: <tt>.distribution</tt></li> - </ul><hr /> -<p><b><a name="script">script</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.script</tt></li> - -<li><b>Default</b>: <tt>bin/catalina[.sh|.bat]</tt></li> - </ul><hr /> -<p><b><a name="simpleLog">simpleLog</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.simple-log</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="skipCurrentProject">skipCurrentProject</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.skipCurrentProject</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="skipWarResources">skipWarResources</a>:</b></p> - -<div>when you set docBases to src/main/webapp setting it to true will -allow hot refresh.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.skipWarResources</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="systemVariables">systemVariables</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.Map</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="target">target</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}</tt></li> - </ul><hr /> -<p><b><a name="tomeeAjpPort">tomeeAjpPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.ajp</tt></li> - -<li><b>Default</b>: <tt>8009</tt></li> - </ul><hr /> -<p><b><a name="tomeeAlreadyInstalled">tomeeAlreadyInstalled</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.exiting</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="tomeeArtifactId">tomeeArtifactId</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.artifactId</tt></li> - -<li><b>Default</b>: <tt>apache-tomee</tt></li> - </ul><hr /> -<p><b><a name="tomeeClassifier">tomeeClassifier</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.classifier</tt></li> - -<li><b>Default</b>: <tt>webprofile</tt></li> - </ul><hr /> -<p><b><a name="tomeeGroupId">tomeeGroupId</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.groupId</tt></li> - -<li><b>Default</b>: <tt>org.apache.openejb</tt></li> - </ul><hr /> -<p><b><a name="tomeeHost">tomeeHost</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li> - -<li><b>Default</b>: <tt>localhost</tt></li> - </ul><hr /> -<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li> - -<li><b>Default</b>: <tt>8080</tt></li> - </ul><hr /> -<p><b><a name="tomeeHttpsPort">tomeeHttpsPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.Integer</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.https</tt></li> - </ul><hr /> -<p><b><a name="tomeeShutdownCommand">tomeeShutdownCommand</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.shutdown-command</tt></li> - -<li><b>Default</b>: <tt>SHUTDOWN</tt></li> - </ul><hr /> -<p><b><a name="tomeeShutdownPort">tomeeShutdownPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.shutdown</tt></li> - -<li><b>Default</b>: <tt>8005</tt></li> - </ul><hr /> -<p><b><a name="tomeeVersion">tomeeVersion</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.version</tt></li> - -<li><b>Default</b>: <tt>-1</tt></li> - </ul><hr /> -<p><b><a name="useConsole">useConsole</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.use-console</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="useOpenEJB">useOpenEJB</a>:</b></p> - -<div>use openejb-standalone automatically instead of TomEE</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.openejb</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="user">user</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li> - </ul><hr /> -<p><b><a name="warFile">warFile</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.${project.packaging}</tt></li> - </ul><hr /> -<p><b><a name="webappClasses">webappClasses</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.webappClasses</tt></li> - -<li><b>Default</b>: <tt>${project.build.outputDirectory}</tt></li> - </ul><hr /> -<p><b><a name="webappDefaultConfig">webappDefaultConfig</a>:</b></p> - -<div>forcing nice default for war development (WEB-INF/classes and web -resources)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.webappDefaultConfig</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="webappDir">webappDir</a>:</b></p> - -<div>relative to tomee.base.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>Default</b>: <tt>webapps</tt></li> - </ul><hr /> -<p><b><a name="webappResources">webappResources</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.webappResources</tt></li> - -<li><b>Default</b>: <tt>${project.basedir}/src/main/webapp</tt></li> - </ul><hr /> -<p><b><a name="webapps">webapps</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.util.List</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - </ul><hr /> -<p><b><a name="zip">zip</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.zip</tt></li> - -<li><b>Default</b>: <tt>true</tt></li> - </ul><hr /> -<p><b><a name="zipFile">zipFile</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.io.File</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.zip-file</tt></li> - -<li><b>Default</b>: <tt>${project.build.directory}/${project.build.finalName}.zip</tt></li> - </ul> - </div> - </div> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/help-mojo.adoc ---------------------------------------------------------------------- diff --git a/docs/maven/help-mojo.adoc b/docs/maven/help-mojo.adoc new file mode 100644 index 0000000..8ade7f8 --- /dev/null +++ b/docs/maven/help-mojo.adoc @@ -0,0 +1,115 @@ +:index-group: Unrevised +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published + + +tomee:help + +Full name: + +org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:help + +Description: + +Display help information on tomee-maven-plugin. Call mvn tomee:help +-Ddetail=true -Dgoal=<goal-name> to display parameter details. + +Attributes: + +The goal is thread-safe and supports parallel builds. + +Optional Parameters + +Name + +Type + +Since + +Description + +detail + +boolean + +- + +If true, display all settable properties for each goal.Default value is: +false.User property is: detail. + +goal + +String + +- + +The name of the goal for which to show help. If unspecified, all goals +will be displayed.User property is: goal. + +indentSize + +int + +- + +The number of spaces per indentation level, should be positive.Default +value is: 2.User property is: indentSize. + +lineLength + +int + +- + +The maximum length of a display line, should be positive.Default value +is: 80.User property is: lineLength. + +Parameter Details + +detail: + +If true, display all settable properties for each goal. + +Type: boolean + +Required: No + +User Property: detail + +Default: false + +goal: + +The name of the goal for which to show help. If unspecified, all goals +will be displayed. + +Type: java.lang.String + +Required: No + +User Property: goal + +indentSize: + +The number of spaces per indentation level, should be positive. + +Type: int + +Required: No + +User Property: indentSize + +Default: 2 + +lineLength: + +The maximum length of a display line, should be positive. + +Type: int + +Required: No + +User Property: lineLength + +Default: 80 http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/help-mojo.md ---------------------------------------------------------------------- diff --git a/docs/maven/help-mojo.md b/docs/maven/help-mojo.md deleted file mode 100644 index 430ee60..0000000 --- a/docs/maven/help-mojo.md +++ /dev/null @@ -1,149 +0,0 @@ -index-group=Unrevised -type=page -status=published -~~~~~~ -<div class="section"> -<h2>tomee:help<a name="tomee:help"></a></h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:help</p> - -<p><b>Description</b>:</p> - -<div>Display help information on tomee-maven-plugin.<br /> -Call <tt>mvn tomee:help -Ddetail=true --Dgoal=<goal-name></tt> to display parameter details.</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>The goal is thread-safe and supports parallel builds.</li> - </ul> - -<div class="section"> -<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - -<table class="mdtable"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><b><a href="#detail">detail</a></b></td> - -<td><tt>boolean</tt></td> - -<td><tt>-</tt></td> - -<td>If <tt>true</tt>, display all settable properties for each -goal.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>detail</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#goal">goal</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>The name of the goal for which to show help. If unspecified, all -goals will be displayed.<br /><b>User property is</b>: <tt>goal</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#indentSize">indentSize</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>The number of spaces per indentation level, should be positive.<br /><b>Default value is</b>: <tt>2</tt>.<br /><b>User property is</b>: <tt>indentSize</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#lineLength">lineLength</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <tt>80</tt>.<br /><b>User property is</b>: <tt>lineLength</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3>Parameter Details<a name="Parameter_Details"></a></h3> - -<p><b><a name="detail">detail</a>:</b></p> - -<div>If <tt>true</tt>, display all settable properties for each -goal.</div> - -<ul> - -<li><b>Type</b>: <tt>boolean</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>detail</tt></li> - -<li><b>Default</b>: <tt>false</tt></li> - </ul><hr /> -<p><b><a name="goal">goal</a>:</b></p> - -<div>The name of the goal for which to show help. If unspecified, all -goals will be displayed.</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>goal</tt></li> - </ul><hr /> -<p><b><a name="indentSize">indentSize</a>:</b></p> - -<div>The number of spaces per indentation level, should be positive.</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>indentSize</tt></li> - -<li><b>Default</b>: <tt>2</tt></li> - </ul><hr /> -<p><b><a name="lineLength">lineLength</a>:</b></p> - -<div>The maximum length of a display line, should be positive.</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>lineLength</tt></li> - -<li><b>Default</b>: <tt>80</tt></li> - </ul> - </div> - </div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/index.adoc ---------------------------------------------------------------------- diff --git a/docs/maven/index.adoc b/docs/maven/index.adoc new file mode 100644 index 0000000..c83c30c --- /dev/null +++ b/docs/maven/index.adoc @@ -0,0 +1,176 @@ +:index-group: TomEE +Maven Plugin +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published +:jbake-title: TomEE Maven Plugin + + +Inspired by the Jetty Maven Plugin, the TomEE Maven Plugin is a +feature-rich plugin that allows for: + +* Easy provisioning of a TomEE server +* Server start and stop +* Application deployment and undeployment + +Simply add the following to the , and optionally the ), section of your +`pom.xml` + +.... +<plugins> + <plugin> + <groupId>org.apache.openejb.maven</groupId> + <artifactId>tomee-maven-plugin</artifactId> + <version>1.7.1</version> + <configuration> + <tomeeVersion>1.7.1</tomeeVersion> + <tomeeClassifier>plus</tomeeClassifier> + </configuration> + </plugin> +</plugins> +.... + +###Plugin Goals + +Goal + +Description + +tomee:build + +Create TomEE, but do not run it. + +tomee:configtest + +Run the Apache Tomcat `configtest` command. + +tomee:debug + +Same as `run` but with debug activated on the default or specified port. + +tomee:deploy + +Deploy an application in a running TomEE. + +tomee:exec + +Undocumented. + +tomee:help + +Display help information on the tomee-maven-plugin. Call mvn tomee:help +-Ddetail=true -Dgoal=<goal-name> to display parameter details. + +tomee:list + +Largely inspired by the OpenEJB command helper, but with some +differences. List deployed EJB's in a running TomEE. + +tomee:run + +Start and wait for TomEE. + +tomee:start + +Start TomEE and continue. + +tomee:stop + +Stop a TomEE started with start command. + +tomee:undeploy + +Undeploy an application in a running TomEE + +Note that for the tomee:deploy and tomee:undeploy goals, the path can +either be specified within the section of the `pom.xml` using the +parameter, or it can be passed via the user property +tomee-plugin.archive. If a relative path is passed for the deploy path +archive, this must be relative to the TomEE server. + +Note 2: running tomee maven plugin you can type 'quit' directly in the +console to shutdown correctly the server. 'reload' is also available +when internal openejb application is deployed. + +###More Tweaks + +The lib tag allows to enrich the container with some additional +libraries. + +Some interesting patterns in addition to the default maven formats are +supported. + +* remove:<some prefix of jar in lib folder>: remove all jar starting +with the specified prefix +* unzip:<some maven zip>: extract the zip in lib folder +* ?name=<new-name>: rename the libary once copied in lib folder + +Note: the name tweak can be used to rename applications too + +###Provisioning Example + +This plugin is also usable in projects which are not war. For instance +you can use it in a pom project to setup a TomEE install, add libraries, +deploy apps then run the server. + +.... + <plugin> + <groupId>org.apache.openejb.maven</groupId> + <artifactId>tomee-maven-plugin</artifactId> + <version>1.7.1</version> + <configuration> + <tomeeVersion>1.7.1</tomeeVersion> + <tomeeClassifier>plus</tomeeClassifier> + <debug>false</debug> + <debugPort>5005</debugPort> + <args>-Dfoo=bar</args> + <config>${project.basedir}/src/test/tomee/conf</config> + <libs> + <lib>mysql:mysql-connector-java:5.1.20</lib> + </libs> + <webapps> + <webapp>org.superbiz:myapp:4.3?name=ROOT</webapp> + <webapp>org.superbiz:api:1.1</webapp> + </webapps> + <apps> + <app>org.superbiz:mybugapp:3.2:ear</app> + </apps> + <libs> + <lib>mysql:mysql-connector-java:5.1.21</lib> + <lib>unzip:org.superbiz:hibernate-bundle:4.1.0.Final:zip</lib> + <lib>remove:openjpa-</lib> + </libs> + </configuration> + </plugin> +.... + +###Auto Reloading Example + +.... +<plugin> + <groupId>org.apache.openejb.maven</groupId> + <artifactId>tomee-maven-plugin</artifactId> + <version>1.7.1</version> + <configuration> + <synchronization> + <extensions> + <extension>.class</extension> <!-- if you want to update each time you build with mvn compile --> + </extensions> + </synchronization> + <reloadOnUpdate>true</reloadOnUpdate> + </configuration> +</plugin> +.... + +The Synchronization block supports the following configuration options: + +* resourcesDir (default src/main/webapp) +* binariesDir (default target/classes) +* targetBinariesDir (default tomee/webapps/finalName/WEB-INF/classes) +* targetResourcesDir (default tomee/webapps/finalName) +* updateInterval (default 5 - in second) +* extensions (default html, xhtml, js and css) +* regex: a regex should match files to take into account when updating + +reloadOnUpdate means to reload the entire context (webapp). This means +undeploying/redeploying the application. http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/index.md ---------------------------------------------------------------------- diff --git a/docs/maven/index.md b/docs/maven/index.md deleted file mode 100644 index 1c004e7..0000000 --- a/docs/maven/index.md +++ /dev/null @@ -1,148 +0,0 @@ -index-group=TomEE Maven Plugin -type=page -status=published -title=TomEE Maven Plugin -~~~~~~ - -Inspired by the Jetty Maven Plugin, the TomEE Maven Plugin is a feature-rich -plugin that allows for: - - - Easy provisioning of a TomEE server - - Server start and stop - - Application deployment and undeployment - -Simply add the following to the <plugins>, and optionally the <pluginManagement>), section of your `pom.xml` - - <plugins> - <plugin> - <groupId>org.apache.openejb.maven</groupId> - <artifactId>tomee-maven-plugin</artifactId> - <version>1.7.1</version> - <configuration> - <tomeeVersion>1.7.1</tomeeVersion> - <tomeeClassifier>plus</tomeeClassifier> - </configuration> - </plugin> - </plugins> - -###Plugin Goals -<table class="mdtable"> -<tr class="a"> -<th>Goal</th> -<th>Description</th></tr> -<tr class="b"> -<td><a href="build-mojo.html">tomee:build</a></td> -<td>Create TomEE, but do not run it.</td></tr> -<tr class="a"> -<td><a href="configtest-mojo.html">tomee:configtest</a></td> -<td>Run the Apache Tomcat `configtest` command.</td></tr> -<tr class="b"> -<td><a href="debug-mojo.html">tomee:debug</a></td> -<td>Same as `run` but with debug activated on the default or specified port.</td></tr> -<tr class="a"> -<td><a href="deploy-mojo.html">tomee:deploy</a></td> -<td>Deploy an application in a running TomEE.</td></tr> -<tr class="b"> -<td><a href="exec-mojo.html">tomee:exec</a></td> -<td>Undocumented.</td></tr> -<tr class="a"> -<td><a href="help-mojo.html">tomee:help</a></td> -<td>Display help information on the tomee-maven-plugin.<br /> -Call <code>mvn tomee:help -Ddetail=true --Dgoal=<goal-name></code> to display parameter details.</td></tr> -<tr class="b"> -<td><a href="list-mojo.html">tomee:list</a></td> -<td>Largely inspired by the OpenEJB command helper, but with some differences. List deployed EJB's in a running TomEE.</td></tr> -<tr class="a"> -<td><a href="run-mojo.html">tomee:run</a></td> -<td>Start and wait for TomEE.</td></tr> -<tr class="b"> -<td><a href="start-mojo.html">tomee:start</a></td> -<td>Start TomEE and continue.</td></tr> -<tr class="a"> -<td><a href="stop-mojo.html">tomee:stop</a></td> -<td>Stop a TomEE started with start command.</td></tr> -<tr class="b"> -<td><a href="undeploy-mojo.html">tomee:undeploy</a></td> -<td>Undeploy an application in a running TomEE</td></tr></table> - - -Note that for the tomee:deploy and tomee:undeploy goals, the path can either be specified within the <configuration/> section of the `pom.xml` using the <path> parameter, or it can be passed via the user property tomee-plugin.archive. If a relative path is passed for the deploy path archive, this must be relative to the TomEE server. - -Note 2: running tomee maven plugin you can type 'quit' directly in the console to shutdown correctly the -server. 'reload' is also available when internal openejb application is deployed. - -###More Tweaks - -The lib tag allows to enrich the container with some additional libraries. - -Some interesting patterns in addition to the default maven formats are supported. - -* remove:<some prefix of jar in lib folder>: remove all jar starting with the specified prefix -* unzip:<some maven zip>: extract the zip in lib folder -* ?name=<new-name>: rename the libary once copied in lib folder - -Note: the name tweak can be used to rename applications too - -###Provisioning Example - -This plugin is also usable in projects which are not war. For instance you can use it in a pom -project to setup a TomEE install, add libraries, deploy apps then run the server. - - <plugin> - <groupId>org.apache.openejb.maven</groupId> - <artifactId>tomee-maven-plugin</artifactId> - <version>1.7.1</version> - <configuration> - <tomeeVersion>1.7.1</tomeeVersion> - <tomeeClassifier>plus</tomeeClassifier> - <debug>false</debug> - <debugPort>5005</debugPort> - <args>-Dfoo=bar</args> - <config>${project.basedir}/src/test/tomee/conf</config> - <libs> - <lib>mysql:mysql-connector-java:5.1.20</lib> - </libs> - <webapps> - <webapp>org.superbiz:myapp:4.3?name=ROOT</webapp> - <webapp>org.superbiz:api:1.1</webapp> - </webapps> - <apps> - <app>org.superbiz:mybugapp:3.2:ear</app> - </apps> - <libs> - <lib>mysql:mysql-connector-java:5.1.21</lib> - <lib>unzip:org.superbiz:hibernate-bundle:4.1.0.Final:zip</lib> - <lib>remove:openjpa-</lib> - </libs> - </configuration> - </plugin> - - -###Auto Reloading Example - - <plugin> - <groupId>org.apache.openejb.maven</groupId> - <artifactId>tomee-maven-plugin</artifactId> - <version>1.7.1</version> - <configuration> - <synchronization> - <extensions> - <extension>.class</extension> <!-- if you want to update each time you build with mvn compile --> - </extensions> - </synchronization> - <reloadOnUpdate>true</reloadOnUpdate> - </configuration> - </plugin> - -The Synchronization block supports the following configuration options: - -* resourcesDir (default src/main/webapp) -* binariesDir (default target/classes) -* targetBinariesDir (default tomee/webapps/finalName/WEB-INF/classes) -* targetResourcesDir (default tomee/webapps/finalName) -* updateInterval (default 5 - in second) -* extensions (default html, xhtml, js and css) -* regex: a regex should match files to take into account when updating - -reloadOnUpdate means to reload the entire context (webapp). This means undeploying/redeploying the application. http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/list-mojo.adoc ---------------------------------------------------------------------- diff --git a/docs/maven/list-mojo.adoc b/docs/maven/list-mojo.adoc new file mode 100644 index 0000000..05c6638 --- /dev/null +++ b/docs/maven/list-mojo.adoc @@ -0,0 +1,132 @@ +:index-group: Unrevised +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published + + +tomee:list + +Full name: + +org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:list + +Description: + +Highly inspired from openejb command helper but with some different +data. List deployed EJB in a running TomEE. + +Attributes: + +Requires a Maven project to be executed. + +Requires dependency resolution of artifacts in scope: runtime. + +Requires dependency collection of artifacts in scope: runtime. + +Optional Parameters + +Name + +Type + +Since + +Description + +password + +String + +- + +(no description)User property is: tomee-plugin.pwd. + +realm + +String + +- + +(no description)User property is: tomee-plugin.realm. + +tomeeHost + +String + +- + +(no description)Default value is: localhost.User property is: +tomee-plugin.host. + +tomeeHttpPort + +int + +- + +(no description)Default value is: 8080.User property is: +tomee-plugin.http. + +user + +String + +- + +(no description)User property is: tomee-plugin.user. + +Parameter Details + +password: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.pwd + +realm: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.realm + +tomeeHost: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.host + +Default: localhost + +tomeeHttpPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-plugin.http + +Default: 8080 + +user: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.user http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/list-mojo.md ---------------------------------------------------------------------- diff --git a/docs/maven/list-mojo.md b/docs/maven/list-mojo.md deleted file mode 100644 index ecf6673..0000000 --- a/docs/maven/list-mojo.md +++ /dev/null @@ -1,169 +0,0 @@ -index-group=Unrevised -type=page -status=published -~~~~~~ -<div class="section"> -<h2>tomee:list<a name="tomee:list"></a></h2> - -<p><b>Full name</b>:</p> - -<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:list</p> - -<p><b>Description</b>:</p> - -<div>Highly inspired from openejb command helper but with some different -data. List deployed EJB in a running TomEE.</div> - -<p><b>Attributes</b>:</p> - -<ul> - -<li>Requires a Maven project to be executed.</li> - -<li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li> - -<li>Requires dependency collection of artifacts in scope: <tt>runtime</tt>.</li> - </ul> - -<div class="section"> -<h3>Optional Parameters<a name="Optional_Parameters"></a></h3> - -<table class="mdtable"> - -<tr class="a"> - -<th>Name</th> - -<th>Type</th> - -<th>Since</th> - -<th>Description</th> - </tr> - -<tr class="b"> - -<td><b><a href="#password">password</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.pwd</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#realm">realm</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.realm</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#tomeeHost">tomeeHost</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>localhost</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.host</tt>.</td> - </tr> - -<tr class="a"> - -<td><b><a href="#tomeeHttpPort">tomeeHttpPort</a></b></td> - -<td><tt>int</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>tomee-plugin.http</tt>.</td> - </tr> - -<tr class="b"> - -<td><b><a href="#user">user</a></b></td> - -<td><tt>String</tt></td> - -<td><tt>-</tt></td> - -<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.user</tt>.</td> - </tr> - </table> - </div> - -<div class="section"> -<h3>Parameter Details<a name="Parameter_Details"></a></h3> - -<p><b><a name="password">password</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.pwd</tt></li> - </ul><hr /> -<p><b><a name="realm">realm</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.realm</tt></li> - </ul><hr /> -<p><b><a name="tomeeHost">tomeeHost</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.host</tt></li> - -<li><b>Default</b>: <tt>localhost</tt></li> - </ul><hr /> -<p><b><a name="tomeeHttpPort">tomeeHttpPort</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>int</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.http</tt></li> - -<li><b>Default</b>: <tt>8080</tt></li> - </ul><hr /> -<p><b><a name="user">user</a>:</b></p> - -<div>(no description)</div> - -<ul> - -<li><b>Type</b>: <tt>java.lang.String</tt></li> - -<li><b>Required</b>: <tt>No</tt></li> - -<li><b>User Property</b>: <tt>tomee-plugin.user</tt></li> - </ul> - </div> - </div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/tomee/blob/329eb60a/docs/maven/run-mojo.adoc ---------------------------------------------------------------------- diff --git a/docs/maven/run-mojo.adoc b/docs/maven/run-mojo.adoc new file mode 100644 index 0000000..91b909c --- /dev/null +++ b/docs/maven/run-mojo.adoc @@ -0,0 +1,1139 @@ +:index-group: Unrevised +:jbake-date: 2018-12-05 +:jbake-type: page +:jbake-status: published + + +tomee:run + +Full name: + +org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:run + +Description: + +Start and wait for TomEE. + +Attributes: + +Requires a Maven project to be executed. + +Requires dependency resolution of artifacts in scope: runtime+system. + +Requires dependency collection of artifacts in scope: runtime. + +Optional Parameters + +Name + +Type + +Since + +Description + +apacheRepos + +String + +- + +(no description)Default value is: snapshots.User property is: +tomee-plugin.apache-repos. + +appDir + +String + +- + +relative to tomee.base.Default value is: apps. + +apps + +List + +- + +(no description) + +args + +String + +- + +(no description)User property is: tomee-plugin.args. + +bin + +File + +- + +(no description)Default value is: +$\{project.basedir}/src/main/tomee/bin.User property is: +tomee-plugin.bin. + +catalinaBase + +File + +- + +(no description)Default value is: +$\{project.build.directory}/apache-tomee.User property is: +tomee-plugin.catalina-base. + +checkStarted + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.check-started. + +classpaths + +List + +- + +(no description) + +config + +File + +- + +(no description)Default value is: +$\{project.basedir}/src/main/tomee/conf.User property is: +tomee-plugin.conf. + +context + +String + +- + +rename the current artifact + +debug + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.debug. + +debugPort + +int + +- + +(no description)Default value is: 5005.User property is: +tomee-plugin.debugPort. + +deployOpenEjbApplication + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.deploy-openejb-internal-application. + +docBases + +List + +- + +for TomEE and wars only, which docBase to use for this war. + +ejbRemote + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-plugin.ejb-remote. + +externalRepositories + +List + +- + +for TomEE and wars only, add some external repositories to classloader. + +forceReloadable + +boolean + +- + +force webapp to be reloadableDefault value is: false.User property is: +tomee-plugin.force-reloadable. + +javaagents + +List + +- + +(no description) + +keepServerXmlAsthis + +boolean + +- + +(Removed since 7.0.0)Default value is: false.User property is: +tomee-plugin.keep-server-xml. + +lib + +File + +- + +(no description)Default value is: +$\{project.basedir}/src/main/tomee/lib.User property is: +tomee-plugin.lib. + +libDir + +String + +- + +relative to tomee.base.Default value is: lib. + +libs + +List + +- + +supported formats: --> groupId:artifactId:version... --> +unzip:groupId:artifactId:version... --> remove:prefix (often prefix = +artifactId) + +mainDir + +File + +- + +(no description)Default value is: $\{project.basedir}/src/main. + +password + +String + +- + +(no description)User property is: tomee-plugin.pwd. + +quickSession + +boolean + +- + +use a real random instead of secure random. saves few ms at +startup.Default value is: true.User property is: +tomee-plugin.quick-session. + +realm + +String + +- + +(no description)User property is: tomee-plugin.realm. + +reloadOnUpdate + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.reload-on-update. + +removeDefaultWebapps + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-plugin.remove-default-webapps. + +removeTomeeWebapp + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-plugin.remove-tomee-webapps. + +simpleLog + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.simple-log. + +skipCurrentProject + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.skipCurrentProject. + +skipWarResources + +boolean + +- + +when you set docBases to src/main/webapp setting it to true will allow +hot refresh.Default value is: false.User property is: +tomee-plugin.skipWarResources. + +synchronization + +Synchronization + +- + +(no description) + +synchronizations + +List + +- + +(no description) + +systemVariables + +Map + +- + +(no description) + +target + +File + +- + +(no description)Default value is: $\{project.build.directory}. + +tomeeAjpPort + +int + +- + +(no description)Default value is: 8009.User property is: +tomee-plugin.ajp. + +tomeeAlreadyInstalled + +boolean + +- + +(no description)Default value is: false.User property is: +tomee-plugin.exiting. + +tomeeArtifactId + +String + +- + +(no description)Default value is: apache-tomee.User property is: +tomee-plugin.artifactId. + +tomeeClassifier + +String + +- + +(no description)Default value is: webprofile.User property is: +tomee-plugin.classifier. + +tomeeGroupId + +String + +- + +(no description)Default value is: org.apache.openejb.User property is: +tomee-plugin.groupId. + +tomeeHost + +String + +- + +(no description)Default value is: localhost.User property is: +tomee-plugin.host. + +tomeeHttpPort + +int + +- + +(no description)Default value is: 8080.User property is: +tomee-plugin.http. + +tomeeHttpsPort + +Integer + +- + +(no description)User property is: tomee-plugin.https. + +tomeeShutdownCommand + +String + +- + +(no description)Default value is: SHUTDOWN.User property is: +tomee-plugin.shutdown-command. + +tomeeShutdownPort + +int + +- + +(no description)Default value is: 8005.User property is: +tomee-plugin.shutdown. + +tomeeVersion + +String + +- + +(no description)Default value is: -1.User property is: +tomee-plugin.version. + +useConsole + +boolean + +- + +(no description)Default value is: true.User property is: +tomee-plugin.use-console. + +useOpenEJB + +boolean + +- + +use openejb-standalone automatically instead of TomEEDefault value is: +false.User property is: tomee-plugin.openejb. + +user + +String + +- + +(no description)User property is: tomee-plugin.user. + +warFile + +File + +- + +(no description)Default value is: +latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging}. + +webappClasses + +File + +- + +(no description)Default value is: $\{project.build.outputDirectory}.User +property is: tomee-plugin.webappClasses. + +webappDefaultConfig + +boolean + +- + +forcing nice default for war development (WEB-INF/classes and web +resources)Default value is: false.User property is: +tomee-plugin.webappDefaultConfig. + +webappDir + +String + +- + +relative to tomee.base.Default value is: webapps. + +webappResources + +File + +- + +(no description)Default value is: +$\{project.basedir}/src/main/webapp.User property is: +tomee-plugin.webappResources. + +webapps + +List + +- + +(no description) + +Parameter Details + +apacheRepos: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.apache-repos + +Default: snapshots + +appDir: + +relative to tomee.base. + +Type: java.lang.String + +Required: No + +Default: apps + +apps: + +(no description) + +Type: java.util.List + +Required: No + +args: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.args + +bin: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.bin + +Default: $\{project.basedir}/src/main/tomee/bin + +catalinaBase: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.catalina-base + +Default: $\{project.build.directory}/apache-tomee + +checkStarted: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.check-started + +Default: false + +classpaths: + +(no description) + +Type: java.util.List + +Required: No + +config: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.conf + +Default: $\{project.basedir}/src/main/tomee/conf + +context: + +rename the current artifact + +Type: java.lang.String + +Required: No + +debug: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.debug + +Default: false + +debugPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-plugin.debugPort + +Default: 5005 + +deployOpenEjbApplication: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.deploy-openejb-internal-application + +Default: false + +docBases: + +for TomEE and wars only, which docBase to use for this war. + +Type: java.util.List + +Required: No + +ejbRemote: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.ejb-remote + +Default: true + +externalRepositories: + +for TomEE and wars only, add some external repositories to classloader. + +Type: java.util.List + +Required: No + +forceReloadable: + +force webapp to be reloadable + +Type: boolean + +Required: No + +User Property: tomee-plugin.force-reloadable + +Default: false + +javaagents: + +(no description) + +Type: java.util.List + +Required: No + +keepServerXmlAsthis: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.keep-server-xml + +Default: false + +lib: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.lib + +Default: $\{project.basedir}/src/main/tomee/lib + +libDir: + +relative to tomee.base. + +Type: java.lang.String + +Required: No + +Default: lib + +libs: + +supported formats: --> groupId:artifactId:version... --> +unzip:groupId:artifactId:version... --> remove:prefix (often prefix = +artifactId) + +Type: java.util.List + +Required: No + +mainDir: + +(no description) + +Type: java.io.File + +Required: No + +Default: $\{project.basedir}/src/main + +password: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.pwd + +quickSession: + +use a real random instead of secure random. saves few ms at startup. + +Type: boolean + +Required: No + +User Property: tomee-plugin.quick-session + +Default: true + +realm: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.realm + +reloadOnUpdate: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.reload-on-update + +Default: false + +removeDefaultWebapps: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.remove-default-webapps + +Default: true + +removeTomeeWebapp: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.remove-tomee-webapps + +Default: true + +simpleLog: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.simple-log + +Default: false + +skipCurrentProject: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.skipCurrentProject + +Default: false + +skipWarResources: + +when you set docBases to src/main/webapp setting it to true will allow +hot refresh. + +Type: boolean + +Required: No + +User Property: tomee-plugin.skipWarResources + +Default: false + +synchronization: + +(no description) + +Type: org.apache.openejb.maven.plugin.Synchronization + +Required: No + +synchronizations: + +(no description) + +Type: java.util.List + +Required: No + +systemVariables: + +(no description) + +Type: java.util.Map + +Required: No + +target: + +(no description) + +Type: java.io.File + +Required: No + +Default: $\{project.build.directory} + +tomeeAjpPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-plugin.ajp + +Default: 8009 + +tomeeAlreadyInstalled: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.exiting + +Default: false + +tomeeArtifactId: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.artifactId + +Default: apache-tomee + +tomeeClassifier: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.classifier + +Default: webprofile + +tomeeGroupId: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.groupId + +Default: org.apache.openejb + +tomeeHost: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.host + +Default: localhost + +tomeeHttpPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-plugin.http + +Default: 8080 + +tomeeHttpsPort: + +(no description) + +Type: java.lang.Integer + +Required: No + +User Property: tomee-plugin.https + +tomeeShutdownCommand: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.shutdown-command + +Default: SHUTDOWN + +tomeeShutdownPort: + +(no description) + +Type: int + +Required: No + +User Property: tomee-plugin.shutdown + +Default: 8005 + +tomeeVersion: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.version + +Default: -1 + +useConsole: + +(no description) + +Type: boolean + +Required: No + +User Property: tomee-plugin.use-console + +Default: true + +useOpenEJB: + +use openejb-standalone automatically instead of TomEE + +Type: boolean + +Required: No + +User Property: tomee-plugin.openejb + +Default: false + +user: + +(no description) + +Type: java.lang.String + +Required: No + +User Property: tomee-plugin.user + +warFile: + +(no description) + +Type: java.io.File + +Required: No + +Default: +latexmath:[${project.build.directory}/$]\{project.build.finalName}.$\{project.packaging} + +webappClasses: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.webappClasses + +Default: $\{project.build.outputDirectory} + +webappDefaultConfig: + +forcing nice default for war development (WEB-INF/classes and web +resources) + +Type: boolean + +Required: No + +User Property: tomee-plugin.webappDefaultConfig + +Default: false + +webappDir: + +relative to tomee.base. + +Type: java.lang.String + +Required: No + +Default: webapps + +webappResources: + +(no description) + +Type: java.io.File + +Required: No + +User Property: tomee-plugin.webappResources + +Default: $\{project.basedir}/src/main/webapp + +webapps: + +(no description) + +Type: java.util.List + +Required: No
