Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some docs

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113389 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
dion
2003-04-28 15:31:09 +00:00
parent 98525aa613
commit c74f8b1db5
3 changed files with 177 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
was40/xdocs/goals.xml
View File

@@ -3,61 +3,168 @@
<document>
<properties>
<title>Maven WebSphere 4.0 Plug-in Goals</title>
<author email="dion@apache.org">dIon Gillard</author>
<author email="kristen@multitask.com.au">Kristen Gillard</author>
</properties>
<body>
<goals>
<goal>
<name>was40</name>
<description>Obtain the list of nodes on the WebSphere Application Server</description>
<description>Default Goal - Obtains a list of available nodes
<p><i>There are no arguments passed for this goal.</i></p>
</description>
</goal>
<goal>
<name>was40:app-start</name>
<description>Start enterprise application</description>
<description>Starts an enterprise application
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.enterprise.app.name} - Name of the enterprise application to start<br/>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:app-stop</name>
<description>Stop an enterprise application</description>
<description>Stops an enterprise application
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.enterprise.app.name} - Name of the enterprise application to stop<br></br>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:deploy-ear</name>
<description>Deploy an enterprise application</description>
<description>Deploys an enterprise application to a given server group <b>or</b> application server
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.appserver} - Name of the application server to deploy the enterprise application<br/>
<b>or</b><br />
${maven.was40.serverGroup} - Name of the server group to deploy the enterprise application
</li>
<li>
${maven.was40.node} - Name of the node to deploy to<br/>
</li>
<li>
${maven.was40.home} - Home directory of WebSphere application server<br/>
</li>
<li>
${maven.was40.enterprise.app} - Name of the enterprise application to deploy<br/>
</li>
<li>
${maven.was40.enterprise.app.name} - Name you wish to give the application to deploy<br/>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:deploy-to-servergroup</name>
<description>Deploy an application to a server group</description>
<description>Deploys an application to the specified server group
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.node} - Name of the node in which the server group resides<br />
</li>
<li>
${maven.was40.enterprise.app} - Name of the enterprise application to deploy<br/>
</li>
<li>
${maven.was40.enterprise.app.name} - Name to give the enterprise application<br />
</li>
<li>
${maven.was40.serverGroup.name} - Name of the server group to deploy the enterprise application<br/>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:list-node</name>
<description>Obtain the list of nodes on the WebSphere Application Server</description>
<description>Obtains a list of available nodes<br/>
<i>There are no arguments passed to this goal.</i><br/>
</description>
</goal>
<goal>
<name>was40:start</name>
<description>Starts was40 Application Server</description>
<description>
Starts WebSphere
<p><i>There are no arguments passed for this goal.</i></p>
</description>
</goal>
<goal>
<name>was40:start-appserver</name>
<description>Start a websphere application server</description>
<description>Starts the specified Application Server
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.node} - Name of the node in which the application server resides<br/>
</li>
<li>
${maven.was40.appserver} - Name of the application server to start<br/>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:start-servergroup</name>
<description>Start a websphere server group</description>
<description>Start a websphere server group
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.serverGroup.name} - Name of the server group to start<br/>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:stop</name>
<description>Stops a websphere node</description>
<description>Stops a websphere node<br/>
<ul>
<li>
${maven.was40.node} - Name of the node to stop<br/>
i.e: <i><b>devserver_1</b></i>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:stop-appserver</name>
<description>Stop a websphere application server</description>
<description>
Stops the specified Application Server
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.node} - Name of the node in which the application server resides<br/>
</li>
<li>
${maven.was40.appserver} - Name of the application server to stop<br/>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:stop-servergroup</name>
<description>Stop a websphere server group</description>
<description>Stop a websphere server group
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.serverGroup.name} - Name of the server group to stop<br/>
</li>
</ul>
</description>
</goal>
<goal>
<name>was40:undeploy-ear</name>
<description>Remove an enterprise application</description>
<description>Remove an enterprise application<br/>
<ul>
<i>Required arguments to pass to this goal are:</i><br/>
<li>
${maven.was40.enterprise.app.name} - Name of the enterprise application to remove
</li>
</ul>
</description>
</goal>
</goals>
</body>

33
was40/xdocs/index.xml Normal file
View File

@@ -0,0 +1,33 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Maven WebSphere v4.0 Plug-in</title>
<author email="kristen@multitask.com.au">Kristen Gillard</author>
</properties>
<body>
<section name="Contents">
<p>The following sections are available in the WebSphere v4.0 Plug-in documentation</p>
<ol>
<li><a href="#Overview">An overview of how this plugin works</a></li>
<li><a href="#Futures">What's in store for the WebSphere v4.0 Plug-in</a></li>
</ol>
</section>
<section name="Overview">
<p>
This plugin allows the user to manage automated WebSphere Application Server application installations
</p>
</section>
<section name="Futures">
<ul>
<li>
In the future this will also manage the installation of <b>WAR</b> (Web Application installations)
</li>
<li>
Your suggestions are always welcome!
</li>
</ul>
</section>
</body>
</document>

56
was40/xdocs/properties.xml
View File

@@ -3,7 +3,7 @@
<document>
<properties>
<title>Maven WebSphere 4.0 Plug-in Properties</title>
<author email="kristen@multitask.com.au">Kristen Gillard</author>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name="Maven WebSphere 4.0 Plug-in Settings">
@@ -18,8 +18,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>
</code>.</p>
<code>NodeName</code>.</p>
</td>
</tr>
<tr>
@@ -38,12 +37,20 @@
<code>Default Server</code>.</p>
</td>
</tr>
<tr>
<td>maven.was40.enterprise.app.name</td>
<td>Yes</td>
<td>
<p>Default value is
<code>EnterpriseAppName</code>.</p>
</td>
</tr>
<tr>
<td>maven.was40.stopNode</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.node} stop</code>.</p>
<code>${maven.was40.cmd.node} stop {/${maven.was40.cmd.node}:${maven.was40.node}/}</code>.</p>
</td>
</tr>
<tr>
@@ -70,14 +77,6 @@
<code>${maven.was40.home}/bin</code>.</p>
</td>
</tr>
<tr>
<td>maven.was40.servergroup.listClones</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.serverGroup} listClones /${maven.was40.cmd.serverGroup}/</code>.</p>
</td>
</tr>
<tr>
<td>maven.was40.cmd.node</td>
<td>Yes</td>
@@ -91,7 +90,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.appserver} stop /${maven.was40.cmd.appserver}:${maven.was40.appserver}/</code>.</p>
<code>${maven.was40.cmd.appserver} stop {/${maven.was40.cmd.node}:${maven.was40.node}/${maven.was40.cmd.appserver}:${maven.was40.appserver}/}</code>.</p>
</td>
</tr>
<tr>
@@ -102,20 +101,12 @@
<code>EnterpriseApp</code>.</p>
</td>
</tr>
<tr>
<td>maven.was40.servergroup.remove</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.serverGroup} remove /${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/</code>.</p>
</td>
</tr>
<tr>
<td>maven.was40.servergroup.install</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.enterprise} install /${maven.was40.cmd.node}:${maven.was40.node}/ ${maven.was40.enterprise.app}.ear -appname ${maven.was40.enterprise.app} -defappservers /${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/</code>.</p>
<code>${maven.was40.cmd.enterprise} install {/${maven.was40.cmd.node}:${maven.was40.node}/} ${maven.was40.enterprise.app} -appname {${maven.was40.enterprise.app.name}} -defappserver {/${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/}</code>.</p>
</td>
</tr>
<tr>
@@ -123,7 +114,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.serverGroup} start /${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/</code>.</p>
<code>${maven.was40.cmd.serverGroup} start {/${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/}</code>.</p>
</td>
</tr>
<tr>
@@ -131,7 +122,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.appserver} start /${maven.was40.cmd.appserver}:${maven.was40.appserver}/</code>.</p>
<code>${maven.was40.cmd.appserver} start {/${maven.was40.cmd.node}:${maven.was40.node}/${maven.was40.cmd.appserver}:${maven.was40.appserver}/}</code>.</p>
</td>
</tr>
<tr>
@@ -139,8 +130,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>
</code>.</p>
<code>ServerGroupName</code>.</p>
</td>
</tr>
<tr>
@@ -172,7 +162,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.enterprise} start /${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app}/</code>.</p>
<code>${maven.was40.cmd.enterprise} start {/${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app.name}/}</code>.</p>
</td>
</tr>
<tr>
@@ -180,7 +170,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.enterprise} stop /${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app}/ -force</code>.</p>
<code>${maven.was40.cmd.enterprise} stop {/${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app.name}/} -force</code>.</p>
</td>
</tr>
<tr>
@@ -188,7 +178,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.serverGroup} stop /${maven.was40.cmd.serverGroup}:${${maven.was40.cmd.appserver} start /${maven.was40.cmd.node}:${maven.was40.node}/${maven.was40.cmd.appserver}:${maven.was40.serverGroup.name}/</code>.</p>
<code>${maven.was40.cmd.serverGroup} stop {/${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/}</code>.</p>
</td>
</tr>
<tr>
@@ -196,7 +186,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.enterprise} install /${maven.was40.cmd.node}:${maven.was40.node}/ ${maven.was40.enterprise.app}.ear -appname ${maven.was40.enterprise.app} -defappserver /${maven.was40.cmd.node}:${maven.was40.node}/${maven.was40.cmd.appserver}:${maven.was40.appserver}/</code>.</p>
<code>${maven.was40.cmd.enterprise} install {/${maven.was40.cmd.node}:${maven.was40.node}/} ${maven.was40.enterprise.app} -appname {${maven.was40.enterprise.app.name}} -defappserver {/${maven.was40.cmd.node}:${maven.was40.node}/${maven.was40.cmd.appserver}:${maven.was40.appserver}/}</code>.</p>
</td>
</tr>
<tr>
@@ -212,7 +202,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>EARFILE</code>.</p>
<code>EnterpriseApp</code>.</p>
</td>
</tr>
<tr>
@@ -228,7 +218,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.serverGroup} show /${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/</code>.</p>
<code>${maven.was40.cmd.serverGroup} show {/${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/}</code>.</p>
</td>
</tr>
<tr>
@@ -236,7 +226,7 @@
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.was40.cmd.enterprise} remove /${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app}/ -recursive</code>.</p>
<code>${maven.was40.cmd.enterprise} remove {/${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app.name}/} -recursive</code>.</p>
</td>
</tr>
</table>