From c74f8b1db593715984cccb08f5eabe10f3ad1252 Mon Sep 17 00:00:00 2001 From: dion Date: Mon, 28 Apr 2003 15:31:09 +0000 Subject: [PATCH] Add some docs git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113389 13f79535-47bb-0310-9956-ffa450edef68 --- was40/xdocs/goals.xml | 135 +++++++++++++++++++++++++++++++++---- was40/xdocs/index.xml | 33 +++++++++ was40/xdocs/properties.xml | 56 +++++++-------- 3 files changed, 177 insertions(+), 47 deletions(-) create mode 100644 was40/xdocs/index.xml diff --git a/was40/xdocs/goals.xml b/was40/xdocs/goals.xml index 6b1f77b8..26861a6b 100644 --- a/was40/xdocs/goals.xml +++ b/was40/xdocs/goals.xml @@ -3,61 +3,168 @@ Maven WebSphere 4.0 Plug-in Goals - dIon Gillard + Kristen Gillard was40 - Obtain the list of nodes on the WebSphere Application Server + Default Goal - Obtains a list of available nodes +

There are no arguments passed for this goal.

+ was40:app-start - Start enterprise application + Starts an enterprise application +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.enterprise.app.name} - Name of the enterprise application to start
    +
    • +
+ was40:app-stop - Stop an enterprise application + Stops an enterprise application +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.enterprise.app.name} - Name of the enterprise application to stop

    +
    • +
+ was40:deploy-ear - Deploy an enterprise application + Deploys an enterprise application to a given server group or application server +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.appserver} - Name of the application server to deploy the enterprise application
    + or
    + ${maven.was40.serverGroup} - Name of the server group to deploy the enterprise application +
    • +
  • + ${maven.was40.node} - Name of the node to deploy to
    +
    • +
  • + ${maven.was40.home} - Home directory of WebSphere application server
    +
    • +
  • + ${maven.was40.enterprise.app} - Name of the enterprise application to deploy
    +
    • +
  • + ${maven.was40.enterprise.app.name} - Name you wish to give the application to deploy
    +
    • +
+ was40:deploy-to-servergroup - Deploy an application to a server group + Deploys an application to the specified server group +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.node} - Name of the node in which the server group resides
    +
    • +
  • + ${maven.was40.enterprise.app} - Name of the enterprise application to deploy
    +
    • +
  • + ${maven.was40.enterprise.app.name} - Name to give the enterprise application
    +
    • +
  • + ${maven.was40.serverGroup.name} - Name of the server group to deploy the enterprise application
    +
    • +
+ was40:list-node - Obtain the list of nodes on the WebSphere Application Server + Obtains a list of available nodes
+ There are no arguments passed to this goal.
+ was40:start - Starts was40 Application Server + + Starts WebSphere +

There are no arguments passed for this goal.

+ was40:start-appserver - Start a websphere application server + Starts the specified Application Server +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.node} - Name of the node in which the application server resides
    +
    • +
  • + ${maven.was40.appserver} - Name of the application server to start
    +
    • +
+ was40:start-servergroup - Start a websphere server group + Start a websphere server group +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.serverGroup.name} - Name of the server group to start
    +
    • +
+ was40:stop - Stops a websphere node + Stops a websphere node
+
    +
  • + ${maven.was40.node} - Name of the node to stop
    + i.e: devserver_1 +
    • +
+ was40:stop-appserver - Stop a websphere application server + + Stops the specified Application Server +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.node} - Name of the node in which the application server resides
    +
    • +
  • + ${maven.was40.appserver} - Name of the application server to stop
    +
    • +
+ was40:stop-servergroup - Stop a websphere server group + Stop a websphere server group +
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.serverGroup.name} - Name of the server group to stop
    +
    • +
+ was40:undeploy-ear - Remove an enterprise application + Remove an enterprise application
+
    + Required arguments to pass to this goal are:
    +
  • + ${maven.was40.enterprise.app.name} - Name of the enterprise application to remove +
    • +
+ diff --git a/was40/xdocs/index.xml b/was40/xdocs/index.xml new file mode 100644 index 00000000..7644224c --- /dev/null +++ b/was40/xdocs/index.xml @@ -0,0 +1,33 @@ + + + + + Maven WebSphere v4.0 Plug-in + Kristen Gillard + + + +
+

The following sections are available in the WebSphere v4.0 Plug-in documentation

+
    +
  1. An overview of how this plugin works
    2. +
  2. What's in store for the WebSphere v4.0 Plug-in
    3. +
+
+
+

+ This plugin allows the user to manage automated WebSphere Application Server application installations +

+
+
+
    +
  • + In the future this will also manage the installation of WAR (Web Application installations) +
    • +
  • + Your suggestions are always welcome! +
    • +
+
+ + diff --git a/was40/xdocs/properties.xml b/was40/xdocs/properties.xml index 97a7d1c1..e326edd6 100644 --- a/was40/xdocs/properties.xml +++ b/was40/xdocs/properties.xml @@ -3,7 +3,7 @@ Maven WebSphere 4.0 Plug-in Properties - Kristen Gillard + dIon Gillard
@@ -18,8 +18,7 @@ Yes

Default value is - - .

+ NodeName.

@@ -38,12 +37,20 @@ Default Server.

+ + maven.was40.enterprise.app.name + Yes + +

Default value is + EnterpriseAppName.

+ + maven.was40.stopNode Yes

Default value is - ${maven.was40.cmd.node} stop.

+ ${maven.was40.cmd.node} stop {/${maven.was40.cmd.node}:${maven.was40.node}/}.

@@ -70,14 +77,6 @@ ${maven.was40.home}/bin.

- - maven.was40.servergroup.listClones - Yes - -

Default value is - ${maven.was40.cmd.serverGroup} listClones /${maven.was40.cmd.serverGroup}/.

- - maven.was40.cmd.node Yes @@ -91,7 +90,7 @@ Yes

Default value is - ${maven.was40.cmd.appserver} stop /${maven.was40.cmd.appserver}:${maven.was40.appserver}/.

+ ${maven.was40.cmd.appserver} stop {/${maven.was40.cmd.node}:${maven.was40.node}/${maven.was40.cmd.appserver}:${maven.was40.appserver}/}.

@@ -102,20 +101,12 @@ EnterpriseApp.

- - maven.was40.servergroup.remove - Yes - -

Default value is - ${maven.was40.cmd.serverGroup} remove /${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/.

- - maven.was40.servergroup.install Yes

Default value is - ${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}/.

+ ${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}/}.

@@ -123,7 +114,7 @@ Yes

Default value is - ${maven.was40.cmd.serverGroup} start /${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/.

+ ${maven.was40.cmd.serverGroup} start {/${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/}.

@@ -131,7 +122,7 @@ Yes

Default value is - ${maven.was40.cmd.appserver} start /${maven.was40.cmd.appserver}:${maven.was40.appserver}/.

+ ${maven.was40.cmd.appserver} start {/${maven.was40.cmd.node}:${maven.was40.node}/${maven.was40.cmd.appserver}:${maven.was40.appserver}/}.

@@ -139,8 +130,7 @@ Yes

Default value is - - .

+ ServerGroupName.

@@ -172,7 +162,7 @@ Yes

Default value is - ${maven.was40.cmd.enterprise} start /${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app}/.

+ ${maven.was40.cmd.enterprise} start {/${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app.name}/}.

@@ -180,7 +170,7 @@ Yes

Default value is - ${maven.was40.cmd.enterprise} stop /${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app}/ -force.

+ ${maven.was40.cmd.enterprise} stop {/${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app.name}/} -force.

@@ -188,7 +178,7 @@ Yes

Default value is - ${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}/.

+ ${maven.was40.cmd.serverGroup} stop {/${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/}.

@@ -196,7 +186,7 @@ Yes

Default value is - ${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}/.

+ ${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}/}.

@@ -212,7 +202,7 @@ Yes

Default value is - EARFILE.

+ EnterpriseApp.

@@ -228,7 +218,7 @@ Yes

Default value is - ${maven.was40.cmd.serverGroup} show /${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/.

+ ${maven.was40.cmd.serverGroup} show {/${maven.was40.cmd.serverGroup}:${maven.was40.serverGroup.name}/}.

@@ -236,7 +226,7 @@ Yes

Default value is - ${maven.was40.cmd.enterprise} remove /${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app}/ -recursive.

+ ${maven.was40.cmd.enterprise} remove {/${maven.was40.cmd.enterprise}:${maven.was40.enterprise.app.name}/} -recursive.