You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by jl...@apache.org on 2012/12/28 09:31:43 UTC
svn commit: r1426430 - /openejb/site/trunk/content/deploy-tool.mdtext
Author: jlmonteiro
Date: Fri Dec 28 08:31:43 2012
New Revision: 1426430
URL: http://svn.apache.org/viewvc?rev=1426430&view=rev
Log:
Thx Danylo Vashchilenko
Modified:
openejb/site/trunk/content/deploy-tool.mdtext
Modified: openejb/site/trunk/content/deploy-tool.mdtext
URL: http://svn.apache.org/viewvc/openejb/site/trunk/content/deploy-tool.mdtext?rev=1426430&r1=1426429&r2=1426430&view=diff
==============================================================================
--- openejb/site/trunk/content/deploy-tool.mdtext (original)
+++ openejb/site/trunk/content/deploy-tool.mdtext Fri Dec 28 08:31:43 2012
@@ -1,14 +1,14 @@
Title: Deploy Tool
+
<a name="DeployTool-NAME"></a>
# NAME
-
openejb deploy - OpenEJB Deploy Tool
<a name="DeployTool-SYNOPSIS"></a>
# SYNOPSIS
- openejb deploy [#options](#options.html) <file> \[<file>...\]
+> openejb deploy [options](#DeployTool-OPTIONS) <file> \[<file> ...\]
<a name="DeployTool-NOTE"></a>
# NOTE
@@ -16,37 +16,37 @@ openejb deploy - OpenEJB Deploy Tool
The OpenEJB Deploy tool is an OPTIONAL tool that allows you to deploy into
a running server and get feedback as if the app was deployed and how it was
-deployed (deploymentIds, jndi names, etc.).
+deployed (deploymentIds, jndi names, etc.).
It can be used to deploy into an offline server, however in this scenario
-it simply copies the archive into the openejb.base/apps directory which is
+it simply copies the archive into the deployment directory (by default `openejb.base/apps`) which is
something that can be done manually with a simple copy command or drag and
drop.
The OpenEJB Deploy tool can be executed from any directory as long as
-<OPENEJB_HOME>/bin is in the system PATH. <OPENEJB_HOME> is the directory
+`openejb.home/bin` is in the system PATH. `openejb.home` is the directory
where OpenEJB was installed or unpacked. For for the remainder of this
document we will assume you unpacked OpenEJB into the directory
-C:\openejb-3.0.
+`C:\openejb-3.0` under Windows.
In Windows, the deploy tool can be executed as follows:
-*C:\openejb-3.0> bin\openejb deploy --help*
+> C:\openejb-3.0> bin\openejb deploy --help
In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows:
- \[user@host openejb-3.0](user@host-openejb-3.0.html)# bin/openejb deploy --help
+> user@host# bin/openejb deploy --help
Depending on your OpenEJB version, you may need to change execution bits to
make the scripts executable. You can do this with the following command.
- \[user@host openejb-3.0](user@host-openejb-3.0.html)# chmod 755 bin/openejb
+> user@host# chmod +x bin/openejb
From here on out, it will be assumed that you know how to execute the right
openejb script for your operating system and commands will appear in
shorthand as show below.
-*openejb deploy --help*
+> openejb deploy --help
<a name="DeployTool-DESCRIPTION"></a>
@@ -54,51 +54,68 @@ shorthand as show below.
The files passed to the Deploy Tool can be any combination of the
following:
- - ejb 1.1, 2.0, 2.1 or 3.0 jar
- - application client jar
- - ear file containing only libraries, ejbs and application clients --
+
+* EJB 1.1, 2.0, 2.1, 3.0 or 3.1 jar
+* application client jar
+* EAR file containing only libraries, EJBs and application clients --
everything else will be ignored.
-Archives ending in *.ear* or containing a META-INF/application.xml are
-assumed to be ear files.
+The type of the files passed is determined as follows:
-Archives containing a META-INF/ejb-jar.xml file or any classes annotated
-with @Stateless, @Stateful or @MessageDriven, are assumed to be *EJB*
-applications. EJB applications older that EJB 3.0 should contain a
-complete META-INF/ejb-jar.xml inside the jar, however we do not strictly
+* Archives ending in `.ear` or containing a `META-INF/application.xml` are
+assumed to be EAR files.
+* Archives containing a `META-INF/ejb-jar.xml` file or any classes annotated
+with `@Stateless`, `@Stateful` or `@MessageDriven`, are assumed to be *EJB*
+applications. EJB applications older that EJB 3.0 should contain a
+complete `META-INF/ejb-jar.xml` inside the jar, however we do not strictly
enforce that -- the act of it being incomplete makes it an EJB 3.0
application by nature.
-
-Archives containing a META-INF/application-client.xml or with a
-META-INF/MANIFEST.MF containing the "Main-Class" attribute, are assumed to
+* Archives containing a `META-INF/application-client.xml` or with a
+`META-INF/MANIFEST.MF` containing the `Main-Class` attribute, are assumed to
be *Application Client* archives.
<a name="DeployTool-OPTIONS"></a>
# OPTIONS
-
<table>
-<tr><td>-d, --debug </td><td>Increases the level of detail on validation errors and
-deployment summary.</td></tr>
-<tr><td>--dir </td><td>Sets the destination directory where the app will be deployed.
+<tr>
+<td>-d, --debug </td>
+<td>Increases the level of detail on validation errors and
+deployment summary.</td>
+</tr>
+
+<tr><td>--dir </td>
+<td>Sets the destination directory where the app will be deployed.
The default is <OPENEJB_HOME>/apps/ directory. Note when changing this
setting make sure the directory is listed in the openejb.xml via a
<Deployments dir=""/> tag or the app will not be picked up again on
restart.
</tr>
-<tr><td>-conf file </td><td>Sets the OpenEJB configuration to the specified file.</td></tr>
-<tr><td>-h, --help </td><td>Lists these options and exit.</td></tr>
-<tr><td>-o, --offline</td><td>Deploys the app to an offline server by copying the
+
+<tr><td>-conf file </td>
+<td>Sets the OpenEJB configuration to the specified file.</td></tr>
+
+<tr><td>-h, --help </td>
+<td>Lists these options and exit.</td></tr>
+
+<tr><td>-o, --offline</td>
+<td>Deploys the app to an offline server by copying the
archive into the server's apps/ directory. The app will be deployed when
the server is started. The default is online.</td></tr>
-<tr><td>-q, --quiet </td><td> Decreases the level of detail on validation and skips the
+
+<tr><td>-q, --quiet </td>
+<td> Decreases the level of detail on validation and skips the
deployment summary.</td></tr>
-<tr><td>-s, --server-url <url> </td><td> Sets the url of the OpenEJB server to which
+
+<tr><td>-s, --server-url <url> </td>
+<td> Sets the url of the OpenEJB server to which
the app will be deployed. The value should be the same as the JNDI
Provider URL used to lookup EJBs. The default is 'ejbd://localhost:4201'.
</td></tr>
-<tr><td>-v, --version</td><td> Prints the OpenEJB version and exits. </td></tr>
+
+<tr><td>-v, --version</td>
+<td> Prints the OpenEJB version and exits. </td></tr>
</table>
@@ -110,13 +127,13 @@ Provider URL used to lookup EJBs. The d
## Deploying multiple jar files
- *openejb deploy myapp\fooEjbs.jar myapp\barEjbs.jar*
+> openejb deploy myapp\fooEjbs.jar myapp\barEjbs.jar
Deploys the beans in the fooEjbs.jar first, then deploys the beans in the
barEjbs.jar. Wildcards can be used as well.
- *openejb deploy myapp\*.jar*
+> openejb deploy myapp\*.jar
<a name="DeployTool-OUTPUT"></a>
@@ -138,7 +155,7 @@ printed on the console
Jndi(name=AddServiceBeanLocal)
-Note: In the above case the command used is
-*C:\samples\Calculator-new>openejb deploy hello-addservice.jar*.
-This contains two EJBs AddServiceBean and HelloBean.
+Note: In the above case the command used is:
+> openejb deploy hello-addservice.jar
+The JAR file contains two EJBs: AddServiceBean and HelloBean.
\ No newline at end of file