maven-plugins/jboss/xdocs/properties.xml

190 lines
6.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>JBoss Properties</title>
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<section name="JBoss Settings">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.jboss.home</td>
<td>No</td>
<td>
<p>
Location of JBoss home (i.e. where JBoss is installed on your
local drive. Example: <code>c:/jboss-3.2.2</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jboss.conf.dir</td>
<td>Yes</td>
<td>
<p>
Location of where the application-specific JBoss conf files are
located. Example: <code>conf/jboss/conf</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jboss.deploy.dir</td>
<td>Yes</td>
<td>
<p>
Location of where the application-specific JBoss deploy files are
located. Example: <code>conf/jboss/deploy</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jboss.appconf.dir</td>
<td>Yes</td>
<td>
<p>
Location of application configuration files. These files will
be copied to the JBoss conf/ server configuration directory (and
will thus be in the server classpath). Example:
<code>conf/application</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jboss.conf.name</td>
<td>Yes</td>
<td>
<p>
Name of the specific JBoss server configuration we are creating.
Default value is <code>${pom.artifactId}</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jboss.hostname</td>
<td>Yes</td>
<td>
<p>
Hostname on which JBoss is executing. Default value is
<code>localhost</code>
</p>
</td>
</tr>
<tr>
<td>maven.jboss.port</td>
<td>Yes</td>
<td>
<p>
Port on which JBoss' jmx-console is available. Default value is
<code>8080</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jboss.jmx.url.deploy.${maven.jboss.version}</td>
<td>Yes</td>
<td>
<p>
URL at which an http get will deploy a target.
</p>
<p>
Default value for JBoss 3.0 is
<code>http://${maven.jboss.hostname}:${maven.jboss.port}/jmx-console/HtmlAdaptor?action=invokeOpByName&amp;name=jboss.system:service%3DMainDeployer&amp;methodName=deploy&amp;argType=java.lang.String&amp;arg=</code>
</p>
<p>
Default value for JBoss 3.2 is
<code>http://${maven.jboss.hostname}:${maven.jboss.port}/jmx-console/HtmlAdaptor?action=invokeOpByName&amp;name=jboss.system:service%3DMainDeployer&amp;methodName=deploy&amp;argType=java.net.URL&amp;arg0=</code>
</p>
</td>
</tr>
<tr>
<td>maven.jboss.jmx.url.undeploy.${maven.jboss.version}</td>
<td>Yes</td>
<td>
<p>
URL at which an http get will undeploy a target.
</p>
<p>
Default value for JBoss 3.0 is
<code>http://${maven.jboss.hostname}:${maven.jboss.port}/jmx-console/HtmlAdaptor?action=invokeOpByName&amp;name=jboss.system:service%3DMainDeployer&amp;methodName=undeploy&amp;argType=java.lang.String&amp;arg=</code>
</p>
<p>
Default value for JBoss 3.2 is
<code>http://${maven.jboss.hostname}:${maven.jboss.port}/jmx-console/HtmlAdaptor?action=invokeOpByName&amp;name=jboss.system:service%3DMainDeployer&amp;methodName=undeploy&amp;argType=java.net.URL&amp;arg0=</code>
</p>
</td>
</tr>
<tr>
<td>maven.jboss.script.dir</td>
<td>Yes</td>
<td>
<p>
Location of scripts to start/stop/etc the jboss container. A
user who wants to provide his own script will override this
property in his project <code>project.properties</code>/
<code>build.properties</code>.
</p>
<p>
If you write your own script you have access to the following
filters:
</p>
<ul>
<li><code>@maven.jboss.home@</code></li>
<li><code>@jboss.server.home.dir@</code></li>
<li><code>@jboss.server.home.url@</code></li>
<li><code>@maven.jboss.conf.name@</code></li>
<li><code>@maven.jboss.version@</code></li>
<li><code>@maven.jboss.hostname@</code></li>
</ul>
</td>
</tr>
<tr>
<td>maven.jboss.version</td>
<td>Yes</td>
<td>
<p>
The plugin now supports JBoss 3.2.x by default. Support for
JBoss 3.0.x is still available by setting the
<code>maven.jboss.version=3.0</code> property. This property
defaults to <code>3.2</code>.
</p>
</td>
</tr>
<tr>
<td>maven.jboss.debug.port</td>
<td>Yes</td>
<td>
<p>
The port to connect to or the shared mem address to use in
the debug scripts. This property
defaults to <code>4142</code>.
</p>
</td>
</tr>
</table>
</section>
</body>
</document>