http://git-wip-us.apache.org/repos/asf/tomee/blob/b93bd755/docs/maven/start-mojo.md ---------------------------------------------------------------------- diff --git a/docs/maven/start-mojo.md b/docs/maven/start-mojo.md new file mode 100644 index 0000000..85c2013 --- /dev/null +++ b/docs/maven/start-mojo.md @@ -0,0 +1,1395 @@ +index-group=Unrevised +type=page +status=published +~~~~~~ +<div class="section"> +<h2>tomee:start<a name="tomee:start"></a></h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:start</p> + +<p><b>Description</b>:</p> + +<div>Start and forget 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+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="#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="a"> + +<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="b"> + +<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="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="#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="b"> + +<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="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="#reloadOnUpdate">reloadOnUpdate</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.reload-on-update</tt>.</td> + </tr> + +<tr class="a"> + +<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="b"> + +<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="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="#synchronization">synchronization</a></b></td> + +<td><tt>Synchronization</tt></td> + +<td><tt>-</tt></td> + +<td>(no description)<br /></td> + </tr> + +<tr class="a"> + +<td><b><a href="#synchronizations">synchronizations</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="#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> + </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="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="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="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="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="reloadOnUpdate">reloadOnUpdate</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.reload-on-update</tt></li> + +<li><b>Default</b>: <tt>false</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="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="synchronization">synchronization</a>:</b></p> + +<div>(no description)</div> + +<ul> + +<li><b>Type</b>: <tt>org.apache.openejb.maven.plugin.Synchronization</tt></li> + +<li><b>Required</b>: <tt>No</tt></li> + </ul><hr /> +<p><b><a name="synchronizations">synchronizations</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="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> + </div> + </div> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/tomee/blob/b93bd755/docs/maven/stop-mojo.md ---------------------------------------------------------------------- diff --git a/docs/maven/stop-mojo.md b/docs/maven/stop-mojo.md new file mode 100644 index 0000000..e6fb3ef --- /dev/null +++ b/docs/maven/stop-mojo.md @@ -0,0 +1,1328 @@ +index-group=Unrevised +type=page +status=published +~~~~~~ +<div class="section"> +<h2>tomee:stop<a name="tomee:stop"></a></h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:stop</p> + +<p><b>Description</b>:</p> + +<div>Stop a TomEE started with start command.</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="#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="a"> + +<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="b"> + +<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="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="#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="b"> + +<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="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="#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="a"> + +<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="b"> + +<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="a"> + +<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="b"> + +<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="a"> + +<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="b"> + +<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="a"> + +<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="b"> + +<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="a"> + +<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="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="#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="a"> + +<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="b"> + +<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="a"> + +<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="b"> + +<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="a"> + +<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="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> + +<tr class="a"> + +<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="b"> + +<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="a"> + +<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="b"> + +<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="a"> + +<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="b"> + +<td><b><a href="#webapps">webapps</a></b></td> + +<td><tt>List</tt></td> + +<td><tt>-</tt></td> + +<td>(no description)<br /></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="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="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="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="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="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> + </div> + </div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/tomee/blob/b93bd755/docs/maven/undeploy-mojo.md ---------------------------------------------------------------------- diff --git a/docs/maven/undeploy-mojo.md b/docs/maven/undeploy-mojo.md new file mode 100644 index 0000000..54edb7e --- /dev/null +++ b/docs/maven/undeploy-mojo.md @@ -0,0 +1,209 @@ +index-group=Unrevised +type=page +status=published +~~~~~~ +<div class="section"> +<h2>tomee:undeploy<a name="tomee:undeploy"></a></h2> + +<p><b>Full name</b>:</p> + +<p>org.apache.openejb.maven:tomee-maven-plugin[:Current Version]:undeploy</p> + +<p><b>Description</b>:</p> + +<div>Simply undeploy an application 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>Required Parameters<a name="Required_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="#path">path</a></b></td> + +<td><tt>String</tt></td> + +<td><tt>-</tt></td> + +<td>(no description)<br /><b>User property is</b>: <tt>tomee-plugin.archive</tt>.</td> + </tr> + </table> + </div> + +<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="path">path</a>:</b></p> + +<div>(no description)</div> + +<ul> + +<li><b>Type</b>: <tt>java.lang.String</tt></li> + +<li><b>Required</b>: <tt>Yes</tt></li> + +<li><b>User Property</b>: <tt>tomee-plugin.archive</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/b93bd755/docs/messagedrivencontainer-config.md ---------------------------------------------------------------------- diff --git a/docs/messagedrivencontainer-config.md b/docs/messagedrivencontainer-config.md new file mode 100644 index 0000000..3362a4f --- /dev/null +++ b/docs/messagedrivencontainer-config.md @@ -0,0 +1,67 @@ +index-group=Unrevised +type=page +status=published +title=MessageDrivenContainer Configuration +~~~~~~ + + +A MessageDrivenContainer can be declared via xml in the `<tomee-home>/conf/tomee.xml` file or in a `WEB-INF/resources.xml` file using a declaration like the following. All properties in the element body are optional. + + <Container id="myMessageDrivenContainer" type="MESSAGE"> + activationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec + instanceLimit = 10 + messageListenerInterface = javax.jms.MessageListener + resourceAdapter = Default JMS Resource Adapter + </Container> + +Alternatively, a MessageDrivenContainer can be declared via properties in the `<tomee-home>/conf/system.properties` file or via Java VirtualMachine `-D` properties. The properties can also be used when embedding TomEE via the `javax.ejb.embeddable.EJBContainer` API or `InitialContext` + + myMessageDrivenContainer = new://Container?type=MESSAGE + myMessageDrivenContainer.activationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec + myMessageDrivenContainer.instanceLimit = 10 + myMessageDrivenContainer.messageListenerInterface = javax.jms.MessageListener + myMessageDrivenContainer.resourceAdapter = Default JMS Resource Adapter + +Properties and xml can be mixed. Properties will override the xml allowing for easy configuration change without the need for ${} style variable substitution. Properties are not case sensitive. If a property is specified that is not supported by the declared MessageDrivenContainer a warning will be logged. If a MessageDrivenContainer is needed by the application and one is not declared, TomEE will create one dynamically using default settings. Multiple MessageDrivenContainer declarations are allowed. +# Supported Properties +<table class="mdtable"> +<tr> +<th>Property</th> +<th>Type</th> +<th>Default</th> +<th>Description</th> +</tr> +<tr> + <td>activationSpecClass</td> + <td>String</td> + <td>org.apache.activemq.ra.ActiveMQActivationSpec</td> + <td> +Specifies the activation spec class +</td> +</tr> +<tr> + <td>instanceLimit</td> + <td>int</td> + <td>10</td> + <td> +Specifies the maximum number of bean instances that are +allowed to exist for each MDB deployment. +</td> +</tr> +<tr> + <td>messageListenerInterface</td> + <td>String</td> + <td>javax.jms.MessageListener</td> + <td> +Specifies the message listener interface handled by this container +</td> +</tr> +<tr> + <td>resourceAdapter</td> + <td>String</td> + <td>Default JMS Resource Adapter</td> + <td> +The resource adapter delivers messages to the container +</td> +</tr> +</table> http://git-wip-us.apache.org/repos/asf/tomee/blob/b93bd755/docs/multicast-discovery.md ---------------------------------------------------------------------- diff --git a/docs/multicast-discovery.md b/docs/multicast-discovery.md new file mode 100644 index 0000000..3acb839 --- /dev/null +++ b/docs/multicast-discovery.md @@ -0,0 +1,83 @@ +index-group=Unrevised +type=page +status=published +title=Multicast (UDP) Discovery +~~~~~~ + +Multicast is the preferred way to broadcast the heartbeat on the network. +The simple technique of broadcasting a non-changing service URI on the +network has specific advantages to multicast. The URI itself is +essentially stateless and there is no "i'm alive" URI or an "i'm dead" URI. + +In this way the issues with UDP being unordered and unreliable melt away as +state is no longer a concern and packet sizes are always small. +Complicated libraries that ride atop UDP and attempt to offer reliability +(retransmission) and ordering on UDP can be avoided. As well the +advantages UDP has over TCP are retained as there are no java layers +attempting to force UDP communication to be more TCP-like. The simple +design means UDP/Multicast is only used for discovery and from there on out +critical information is transmitted over TCP/IP which is obviously going to +do a better job at ensuring reliability and ordering. + +# Server Configuration + +When you boot the server there should be a `conf/multicast.properties` file +containing: + + + server = org.apache.openejb.server.discovery.MulticastDiscoveryAgent + bind = 239.255.2.3 + port = 6142 + disabled = true + group = default + + +Just need to enable that by setting `disabled=false`. All of the above +settings except `server` can be changed. The `port` and `bind` must +be valid for general multicast/udp network communication. + +The `group` setting can be changed to further group servers that may use +the same multicast channel. As shown below the client also has a `group` +setting which can be used to select an appropriate server from the +multicast channel. + +# Multicast Client + +The multicast functionality is not just for servers to find each other in a +cluster, it can also be used for EJB clients to discover a server. A +special `multicast://` URL can be used in the `InitialContext` properties to +signify that multicast should be used to seed the connection process. Such +as: + + Properties p = new Properties(); + p.put(Context.INITIAL_CONTEXT_FACTORY, + "org.apache.openejb.client.RemoteInitialContextFactory"); + p.put(Context.PROVIDER_URL, "multicast://239.255.2.3:6142?group=default"); + InitialContext remoteContext = new InitialContext(p); + +The URL has optional query parameters such as `schemes` and `group` and +`timeout` which allow you to zero in on a particular type of service of a +particular cluster group as well as set how long you are willing to wait in +the discovery process till finally giving up. The first matching service +that it sees "flowing" around on the UDP stream is the one it picks and +sticks to for that and subsequent requests, ensuring UDP is only used when +there are no other servers to talk to. + +Note that EJB clients do not need to use multicast to find a server. If +the client knows the URL of a server in the cluster, it may use it and +connect directly to that server, at which point that server will share the +full list of its peers. + +# Multicast Servers with TCP Clients + +Note that clients do not need to use multicast to communicate with servers. +Servers can use multicast to discover each other, but clients are still +free to connect to servers in the network using the server's TCP address. + + Properties p = new Properties(); + p.put(Context.INITIAL_CONTEXT_FACTORY, "org.apache.openejb.client.RemoteInitialContextFactory"); + p.put(Context.PROVIDER_URL, "ejbd://192.168.1.30:4201"); + InitialContext remoteContext = new InitialContext(p); + +When the client connects, the server will send the URLs of all the servers +in the group and failover will take place normally.
