diff options
| author | Gintas Grigelionis <gintas@apache.org> | 2018-02-28 07:58:59 +0100 |
|---|---|---|
| committer | Gintas Grigelionis <gintas@apache.org> | 2018-02-28 08:00:45 +0100 |
| commit | 66b52f99e4306fe928aa5e497021cb51cb927e5e (patch) | |
| tree | c58d724bc70f01dcf464dc4c84832507ca8c4d82 /manual/Tasks/serverdeploy.html | |
| parent | 3e61185e19eca3ca70afeda3fb31a1a544f2b474 (diff) | |
| download | ant-66b52f99e4306fe928aa5e497021cb51cb927e5e.tar.gz | |
Use HTML 5(-ish), fix links
Diffstat (limited to 'manual/Tasks/serverdeploy.html')
| -rw-r--r-- | manual/Tasks/serverdeploy.html | 338 |
1 files changed, 158 insertions, 180 deletions
diff --git a/manual/Tasks/serverdeploy.html b/manual/Tasks/serverdeploy.html index bfe738eff..ec90ce1b1 100644 --- a/manual/Tasks/serverdeploy.html +++ b/manual/Tasks/serverdeploy.html @@ -29,99 +29,94 @@ <p>by</p> <!-- Names are in alphabetical order, on last name --> <ul> -<li>Christopher A. Longo (<a href="mailto:cal@cloud9.net">cal@cloud9.net</a>)</li> -<li>Cyrille Morvan (<a href="mailto:cmorvan@ingenosya.com">cmorvan@ingenosya.com</a>)</li> + <li>Christopher A. Longo (<a href="mailto:cal@cloud9.net">cal@cloud9.net</a>)</li> + <li>Cyrille Morvan (<a href="mailto:cmorvan@ingenosya.com">cmorvan@ingenosya.com</a>)</li> </ul> <hr/> <p>At present the tasks support:</p> <ul> -<li><a href="http://www.bea.com" target="_top">Weblogic</a> servers</li> -<li><a href="http://www.objectweb.org/jonas/" target="_top">JOnAS</a> -2.4 Open Source EJB server</li> + <li><a href="http://www.bea.com" target="_top">WebLogic</a> servers</li> + <li><a href="https://jonas.ow2.org/" target="_top">JOnAS</a> 2.4 Open Source EJB server</li> </ul> -<p> -Over time we expect further optional tasks to support additional J2EE Servers. -</p> +<p>Over time we expect further optional tasks to support additional J2EE Servers.</p> <hr/> <table> -<tr><td>Task</td><td colspan="2">Application Servers</td></tr> -<tr><td rowspan="4"><a href="#serverdeploy_element">serverdeploy</a></td><td colspan="2" align="center"><b>Nested Elements</b></td></tr> -<tr><td><a href="#serverdeploy_generic">generic</a></td><td>Generic task</td></tr> -<tr><td><a href="#serverdeploy_jonas">jonas</a></td><td>JOnAS 2.4</td></tr> -<tr><td><a href="#serverdeploy_weblogic">weblogic</a></td><td>Weblogic</td></tr> - + <tr><th>Task</th><th colspan="2">Application Servers</th></tr> + <tr><td rowspan="4"><a href="#serverdeploy_element">serverdeploy</a></td><th colspan="2">Nested Elements</th></tr> + <tr><td><a href="#serverdeploy_generic">generic</a></td><td>Generic task</td></tr> + <tr><td><a href="#serverdeploy_jonas">jonas</a></td><td>JOnAS 2.4</td></tr> + <tr><td><a href="#serverdeploy_weblogic">weblogic</a></td><td>WebLogic</td></tr> </table> <h2 id="serverdeploy_element">ServerDeploy element</h2> -<h3><b>Description:</b></h3> +<h3>Description</h3> -<p>The <code>serverdeploy</code> task is used to run a "hot" deployment tool for -vendor-specific J2EE server. The task requires nested elements which define -the attributes of the vendor-specific deployment tool being executed. -Vendor-specific deployment tools elements may enforce rules for which -attributes are required, depending on the tool. -</p> +<p>The <code>serverdeploy</code> task is used to run a "hot" deployment tool for vendor-specific +J2EE server. The task requires nested elements which define the attributes of the vendor-specific +deployment tool being executed. Vendor-specific deployment tools elements may enforce rules for +which attributes are required, depending on the tool.</p> -<h3>Parameters:</h3> -<table> +<h3>Parameters</h3> +<table class="attr"> <tr> - <td valign="top"><b>Attribute</b></td> - <td valign="top"><b>Description</b></td> - <td valign="top"><b>Required</b></td> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td valign="top">action</td> - <td valign="top">This is the action to be performed. For most cases this - will be "deploy". Some tools support additional actions, such as "delete", "list", - "undeploy", "update"...</td> + <td>action</td> + <td>This is the action to be performed. For most cases this will be <q>deploy</q>. Some tools + support additional actions, such + as <q>delete</q>, <q>list</q>, <q>undeploy</q>, <q>update</q>, ...</td> <td>Yes</td> </tr> <tr> - <td valign="top">source</td> - <td valign="top">A fully qualified path/filename of the component to be deployed. - This may be an .ear, .jar, .war, or any other type that is supported by the server. - </td> + <td>source</td> + <td>A fully qualified path/filename of the component to be deployed. This may be + an <samp>.ear</samp>, <samp>.jar</samp>, <samp>.war</samp>, or any other type that is + supported by the server.</td> <td>Tool dependent</td> </tr> </table> <h3>Nested Elements</h3> -<p>The serverdeploy task supports a nested <code>classpath</code> element to set the classpath.</p> +<p>The <code>serverdeploy</code> task supports a nested <code>classpath</code> element to set the +classpath.</p> <h3>Vendor-specific nested elements</h3> -<h3>Parameters used for all tools:</h3> -<table> +<h3>Parameters used for all tools</h3> +<table class="attr"> <tr> - <td valign="top"><b>Attribute</b></td> - <td valign="top"><b>Description</b></td> - <td valign="top"><b>Required</b></td> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td valign="top">classpath</td> - <td valign="top">The classpath to be passed to the JVM running the tool. - The classpath may also be supplied as a nested element.</td> + <td>classpath</td> + <td>The classpath to be passed to the JVM running the tool. The classpath may also be supplied + as a nested element.</td> <td>Tool dependent</td> </tr> <tr> - <td valign="top">server</td> - <td valign="top">The address or URL for the server where the component will be deployed.</td> + <td>server</td> + <td>The address or URL for the server where the component will be deployed.</td> <td>Tool dependent</td> </tr> <tr> - <td valign="top">username</td> - <td valign="top">The user with privileges to deploy applications to the server.</td> + <td>username</td> + <td>The user with privileges to deploy applications to the server.</td> <td>Tool dependent</td> </tr> <tr> - <td valign="top">password</td> - <td valign="top">The password of the user with privileges to deploy applications to the server.</td> + <td>password</td> + <td>The password of the user with privileges to deploy applications to the server.</td> <td>Tool dependent</td> </tr> </table> @@ -129,199 +124,182 @@ attributes are required, depending on the tool. <p>Also supported are nested vendor-specific elements.</p> <h3 id="serverdeploy_generic">Generic element</h3> -This element is provided for generic Java-based deployment tools. -The generic task accepts (but does not require) nested <code>arg</code> -and <code>jvmarg</code> elements. -A JVM will be spawned with the provided attributes. It is recommended -that a vendor-specific element be used over the generic one if at all -possible. +<p>This element is provided for generic Java-based deployment tools. The generic task accepts (but +does not require) nested <code>arg</code> and <code>jvmarg</code> elements. A JVM will be spawned +with the provided attributes. It is recommended that a vendor-specific element be used over the +generic one if at all possible.</p> <p>The following attributes are supported by the generic element.</p> -<table> +<table class="attr"> <tr> - <td valign="top"><b>Attribute</b></td> - <td valign="top"><b>Description</b></td> - <td valign="top"><b>Required</b></td> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td valign="top">classname</td> - <td valign="top">This is the fully qualified classname of the Java based - deployment tool to execute.</td> + <td>classname</td> + <td>This is the fully qualified classname of the Java based deployment tool to execute.</td> <td>Yes</td> </tr> </table> <h3>Nested Elements</h3> -<p>The generic element supports nested <code><arg></code> and <code><jvmarg></code> elements.</p> +<p>The generic element supports nested <code><arg></code> and <code><jvmarg></code> +elements.</p> <h3>Example</h3> -<p>This example shows the use of generic deploy element to deploy a component -using a Java based deploy tool:</p> +<p>This example shows the use of generic deploy element to deploy a component using a Java based +deploy tool:</p> <pre> - <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear"> - <generic classname="com.yamato.j2ee.tools.deploy.DeployTool" - classpath="${classpath}" - username="${user.name}" - password="${user.password}"> - <arg value="-component=WildStar"/> - <arg value="-force"/> - <jvmarg value="-ms64m"/> - <jvmarg value="-mx128m"/> - </generic> - </serverdeploy> -</pre> +<serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear"> + <generic classname="com.yamato.j2ee.tools.deploy.DeployTool" + classpath="${classpath}" + username="${user.name}" + password="${user.password}"> + <arg value="-component=WildStar"/> + <arg value="-force"/> + <jvmarg value="-ms64m"/> + <jvmarg value="-mx128m"/> + </generic> +</serverdeploy></pre> <h3 id="serverdeploy_weblogic">WebLogic element</h3> -<p> -The WebLogic element contains additional attributes to run the -<code>weblogic.deploy</code> deployment tool. -<p>Valid actions for the tool are <code>deploy</code>, <code>undeploy</code>, -<code>list</code>, <code>update</code>, and <code>delete</code>. -<p>If the action is <code>deploy</code> or <code>update</code>, -the <code>application</code> and <code>source</code> attributes must be set. -If the action is <code>undeploy</code> or <code>delete</code>, -the <code>application</code> attribute must be set. If the <code>username</code> -attribute is omitted, it defaults to "system". The <code>password</code> attribute is -required for all actions. -<p> -<table> +<p>The WebLogic element contains additional attributes to run the <code>weblogic.deploy</code> +deployment tool.</p> +<p>Valid actions for the tool are <q>deploy</q>, <q>undeploy</q>, <q>list</q>, <q>update</q>, +and <q>delete</q>.</p> +<p>If the action is <q>deploy</q> or <q>update</q>, the <var>application</var> and <var>source</var> +attributes must be set. If the action is <q>undeploy</q> or <q>delete</q>, +the <var>application</var> attribute must be set. If the <var>username</var> attribute is omitted, +it defaults to <q>system</q>. The <var>password</var> attribute is required for all actions.</p> + +<table class="attr"> <tr> - <td valign="top"><b>Attribute</b></td> - <td valign="top"><b>Description</b></td> - <td valign="top"><b>Required</b></td> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td valign="top">application</td> - <td valign="top">This is the name of the application being deployed</td> + <td>application</td> + <td>This is the name of the application being deployed</td> <td>Yes</td> </tr> <tr> - <td valign="top">component</td> - <td valign="top">This is the component string for deployment targets. - It is in the form <code><component>:<target1>,<target2>...</code> - Where component is the archive name (minus the .jar, .ear, .war - extension). Targets are the servers where the components will be deployed</td> + <td>component</td> + <td>This is the component string for deployment targets. It is in the + form <code><component>:<target1>,<target2>...</code> Where component is the + archive name (minus the <samp>.jar</samp>, <samp>.ear</samp>, <samp>.war</samp> extension). + Targets are the servers where the components will be deployed</td> <td>no</td> </tr> <tr> - <td valign="top">debug</td> - <td valign="top">If set to true, additional information will be - printed during the deployment process.</td> + <td>debug</td> + <td>If set to <q>true</q>, additional information will be printed during the deployment + process.</td> <td>No</td> </tr> </table> - <h3>Examples</h3> -<p>This example shows the use of serverdeploy to deploy a component to a WebLogic server:</p> +<p>This example shows the use of <code>serverdeploy</code> to deploy a component to a WebLogic +server:</p> <pre> - <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear"> - <weblogic application="myapp" - server="t3://myserver:7001" - classpath="${weblogic.home}/lib/weblogic.jar" - username="${user.name}" - password="${user.password}" - component="ejb_foobar:myserver,productionserver" - debug="true"/> - </serverdeploy> -</pre> - -<p>This example shows serverdeploy being used to delete a component from a -WebLogic server:</p> +<serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear"> + <weblogic application="myapp" + server="t3://myserver:7001" + classpath="${weblogic.home}/lib/weblogic.jar" + username="${user.name}" + password="${user.password}" + component="ejb_foobar:myserver,productionserver" + debug="true"/> +</serverdeploy></pre> + +<p>This example shows <code>serverdeploy</code> being used to delete a component from a WebLogic +server:</p> <pre> - <serverdeploy action="delete" source="${lib.dir}/ejb_myApp.jar"/> - <weblogic application="myapp" - server="t3://myserver:7001" - classpath="${weblogic.home}/lib/weblogic.jar" - username="${user.name}" - password="${user.password}"/> - </serverdeploy> -</pre> +<serverdeploy action="delete" source="${lib.dir}/ejb_myApp.jar"/> + <weblogic application="myapp" + server="t3://myserver:7001" + classpath="${weblogic.home}/lib/weblogic.jar" + username="${user.name}" + password="${user.password}"/> +</serverdeploy></pre> <h3 id="serverdeploy_jonas">JOnAS (Java Open Application Server) element</h3> -<p> -The JOnAS element contains additional attributes to run the -<code>JonasAdmin</code> deployment tool. -<p>Valid actions for the tool are <code>deploy</code>, <code>undeploy</code>, -<code>list</code> and <code>update</code>. -<p>You can't use <code>user</code> and <code>password</code> property with this -task. -<p> -<table> +<p>The JOnAS element contains additional attributes to run the <code>JonasAdmin</code> deployment +tool.</p> +<p>Valid actions for the tool are <q>deploy</q>, <q>undeploy</q>, <q>list</q> and <q>update</q>.</p> +<p>You can't use <var>user</var> and <var>password</var> property with this task.</p> +<table class="attr"> <tr> - <td valign="top"><b>Attribute</b></td> - <td valign="top"><b>Description</b></td> - <td valign="top"><b>Required</b></td> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> </tr> <tr> - <td valign="top">jonasroot</td> - <td valign="top">The root directory for JOnAS.</td> + <td>jonasroot</td> + <td>The root directory for JOnAS.</td> <td>Yes</td> </tr> <tr> - <td valign="top">orb</td> - <td valign="top">Choose your ORB : RMI, JEREMIE, DAVID, ... If omitted, it defaults - to the one present in classpath. The corresponding JOnAS JAR is - automatically added to the classpath. If your orb is DAVID (RMI/IIOP) you must - specify davidhost and davidport properties.</td> - <td>No</td> + <td>orb</td> + <td>Choose your ORB: <q>RMI</q>, <q>JEREMIE</q>, <q>DAVID</q>, ... The corresponding JOnAS JAR + is automatically added to the classpath. If your <var>orb</var> is <q>DAVID</q> (RMI/IIOP) you + must specify <var>davidhost</var> and <var>davidport</var> properties.</td> + <td>No; defaults to the ORB present in classpath</td> </tr> <tr> - <td valign="top">davidhost</td> - <td valign="top">The value for the system property : <code>david.CosNaming.default_host</code> .</td> + <td>davidhost</td> + <td>The value for the system property: <code>david.CosNaming.default_host</code>.</td> <td>No</td> </tr> <tr> - <td valign="top">davidport</td> - <td valign="top">The value for the system property : <code>david.CosNaming.default_port</code> .</td> + <td>davidport</td> + <td>The value for the system property: <code>david.CosNaming.default_port</code>.</td> <td>No</td> </tr> <tr> - <td valign="top">classname</td> - <td valign="top">This is the fully qualified classname of the Java based - deployment tool to execute. Default to <code>org.objectweb.jonas.adm.JonasAdmin</code></td> - <td>No</td> + <td>classname</td> + <td>This is the fully qualified classname of the Java based deployment tool to execute.</td> + <td>No; default is <code>org.objectweb.jonas.adm.JonasAdmin</code></td> </tr> - </table> <h3>Nested Elements</h3> -<p>The jonas element supports nested <code><arg></code> and <code><jvmarg></code> elements.</p> - +<p>The <code>jonas</code> element supports nested <code><arg></code> +and <code><jvmarg></code> elements.</p> <h3>Examples</h3> -<p>This example shows the use of serverdeploy to deploy a component to a JOnAS server:</p> +<p>This example shows the use of <code>serverdeploy</code> to deploy a component to a JOnAS +server:</p> <pre> - <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.jar"> - <jonas server="MyJOnAS" jonasroot="${jonas.root}"> - - <classpath> - <pathelement path="${jonas.root}/lib/RMI_jonas.jar"/> - <pathelement path="${jonas.root}/config/"/> - </classpath> - </jonas> - </serverdeploy> -</pre> - -<p>This example shows serverdeploy being used to list the components from a -JOnAS server and a WebLogic server:</p> +<serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.jar"> + <jonas server="MyJOnAS" jonasroot="${jonas.root}"> + <classpath> + <pathelement path="${jonas.root}/lib/RMI_jonas.jar"/> + <pathelement path="${jonas.root}/config/"/> + </classpath> + </jonas> +</serverdeploy></pre> + +<p>This example shows <code>serverdeploy</code> being used to list the components from a JOnAS +server and a WebLogic server:</p> <pre> - <serverdeploy action="list"/> - <jonas jonasroot="${jonas.root}" orb="JEREMIE"/> - <weblogic application="myapp" - server="t3://myserver:7001" - classpath="${weblogic.home}/lib/weblogic.jar" - username="${user.name}" - password="${user.password}"/> - </serverdeploy> -</pre> +<serverdeploy action="list"/> + <jonas jonasroot="${jonas.root}" orb="JEREMIE"/> + <weblogic application="myapp" + server="t3://myserver:7001" + classpath="${weblogic.home}/lib/weblogic.jar" + username="${user.name}" + password="${user.password}"/> +</serverdeploy></pre> </body> </html> |
