jcscoobyrs 2005/10/10 23:14:02
Added: modules/core/src/META-INF/org.openejb.cli validate.help
stop.examples deploy.help stop.help start.examples
deploy.examples start.help validate.examples
Log:
Updated per David to have new approach for help and examples.
Revision Changes Path
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/validate.help
Index: validate.help
===================================================================
Usage: openejb validate [options] JARFILES...
OPTIONS
-v Sets the output level to 1. This will output
just the minumum details on each failure.
-vv Default. Sets the output level to 2. Outputs one
line summaries of each failure. This is the
default output level.
-vvv Sets the output level to 3. Outputs verbose
details on each failure, usually with details on
how to correct the failures.
-xml Outputs information in well-formed XML.
-nowarn Suppresses warnings.
-version Print the version.
-help Print this help message.
-examples Show examples of how to use the options.
OpenEJB -- EJB Container System and EJB Server.
For updates and additional information, visit
http://www.openejb.org
Bug Reports to <[email protected]>
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/stop.examples
Index: stop.examples
===================================================================
Usage: openejb stop [options]
Example: Simplest scenario
openejb stop
That's it. This connects to the server running on the default host
address (127.0.0.1) and port (4201) and sends it a stop request.
Example: -h
openejb stop -h 10.45.67.8
Sends a stop request to the server running on IP 10.45.67.8 and port 4201.
DNS names can also be used.
openejb stop -h myhost.foo.com
Sends a stop request to the server running on myhost.foo.com and port 4201.
Example: -p
openejb stop -p 8765
Sends a stop request to the server running on IP 127.0.0.1 and port 8765.
Bug Reports to <[email protected]>
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/deploy.help
Index: deploy.help
===================================================================
Usage: openejb deploy [options] JARFILES...
OPTIONS
-m Move the jar to the OPENEJB_HOME/beans directory. Will
not overwrite the jar if there is an existing jar with
the same name in the OPENEJB_HOME/beans directory. Add
the -f option to force the overwrite.
-c Copy the jar to the OPENEJB_HOME/beans directory. Will
not overwrite the jar if there is an existing jar with
the same name in the OPENEJB_HOME/beans directory. Add
the -f option to force the overwrite.
-f Forces a move or a copy, overwriting any previously
existing jar with the same name.
-a Automate deployment as much as possible. Applies
all automation related flags (-C & -D).
-C Automatically assigns each bean in the jar to the
first container of the appropriate bean type.
-D Automatically assigns the OpenEJB deployment ID
for each bean by using the <ejb-name> in your
ejb-jar.xml. The deployment ID uniquely identifies
the bean in the OpenEJB container system and is used
by most servers as the client-side JNDI name. No
two beans can share the same deployment ID.
-d dir Sets the OPENEJB_HOME to the specified directory.
-l file Sets the log4j configuration to the specified file.
-conf file Sets the OpenEJB configuration to the specified file.
-version Print the version.
-help Print this help message.
-examples Show examples of how to use the options.
See http://www.openejb.org/deploy.html for more information.
OpenEJB -- EJB Container System and EJB Server.
For updates and additional information, visit
http://www.openejb.org
Bug Reports to <[email protected]>
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/stop.help
Index: stop.help
===================================================================
Usage: openejb stop [options]
Stops the OpenEJB Remote Server.
OPTIONS
-h host The host address of the Remote Server.
Default host address is 127.0.0.1.
-p port The port of the Remote Server.
Default port is 4201.
-help Print this help message.
-examples Show examples of the stop command
See http://www.openejb.org/remote-server.html for more information.
OpenEJB -- EJB Container System and EJB Server.
For OpenEJB updates and additional information, visit
http://www.openejb.org
Bug Reports to <[email protected]>
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/start.examples
Index: start.examples
===================================================================
Usage: openejb start [options]
Example: Simplest scenario
openejb start
That's it. The server will start up and bind to IP 127.0.0.1 and port 4201.
The following properties would then be used to get an InitialContext
from the Remote Server.
java.naming.factory.initial = org.openejb.client.JNDIContext
java.naming.provider.url = 127.0.0.1:4201
java.naming.security.principal = myuser
java.naming.security.credentials = mypass
Example: -h
openejb start -h 10.45.67.8
This is the most common way to use the OpenEJB Remote Server. The server
will start
up and bind to IP 10.45.67.8 and port 4201.
The following properties would then be used to get an InitialContext
from the Remote Server.
java.naming.factory.initial = org.openejb.client.JNDIContext
java.naming.provider.url = 10.45.67.8:4201
java.naming.security.principal = myuser
java.naming.security.credentials = mypass
DNS names can also be used.
openejb start -h myhost.foo.com
The following properties would then be used to get an InitialContext
from the Remote Server.
java.naming.factory.initial = org.openejb.client.JNDIContext
java.naming.provider.url = myhost.foo.com:4201
java.naming.security.principal = myuser
java.naming.security.credentials = mypass
Example: -p
openejb start -p 8765
The server will start up and bind to IP 127.0.0.1 and port 8765.
The following properties would then be used to get an InitialContext
from the Remote Server.
java.naming.factory.initial = org.openejb.client.JNDIContext
java.naming.provider.url = 127.0.0.1:8765
java.naming.security.principal = myuser
java.naming.security.credentials = mypass
Example: -conf file
openejb start -conf C:\openejb\conf\mytest.conf
Sets the openejb.configuration system variable to the file
C:\openejb\conf\mytest.conf. When the server starts up and
the initializes OpenEJB, this configuration will be
used to assemble the container system and load beans.
Example: --admin-ip addresses
openejb start --admin-ip 192.168.1.12
Adds 192.168.1.12 to the list of IP addresses that are
authorized to shutdown the server or access the server
via a telnet client. The host that this server was
started on is always allowed to administer the server.
Multiple hosts can be given administrative access to
this server by listing all the host names separated
by commas as such:
openejb start --admin-ip 192.168.1.12,joe.foo.com,robert
The first host in the string names the host explicitly
using an IP address (192.168.1.12).
The second host in uses a DNS name (joe.foo.com) to refer
to the hosts IP address. The DNS name will be resolved
and the IP will be added to the admin list.
The third address refers to a the host by a name (robert)
that the opperating system is able to resolve into a valid
IP address. This is usually done via a hosts file, interal
DNS server, or Windows Domain Server.
Example: --local-copy
openejb start --local-copy=true
Instructs the container system to marshal (ie, copy) all
calls between beans are required by the EJB 1.1 specification.
openejb start --local-copy=false
Instructs the container system to not marshal (copy) calls
between beans. The container system as will pass parameters
and return values without copying or marshalling as is
required for EJB 2.0 Local interfaces.
Bug Reports to <[email protected]>
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/deploy.examples
Index: deploy.examples
===================================================================
Usage: openejb deploy [options] JARFILES...
Example: Multiple jar files
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
Example: -m
openejb deploy -m myapp\myEjbs.jar
Deploys the beans in the jar, moving the entire jar from
myapp\myEjbs.jar to OPENEJB_HOME\beans\myEjbs.jar.
If the jar OPENEJB_HOME\beans\myEjbs.jar already existed, it will
not be overwritten. Supply the -f to force an overwrite.
openejb deploy -m -f myapp\myEjbs.jar
Example: -c
openejb deploy -c myapp\myEjbs.jar
Same as using -m, except the jar is copied not moved. The -f also
can be used with a -c to force an overwrite if the file is already
present.
Example: -C
openejb deploy -C myapp\myEjbs.jar
Deploys the beans in the jar, does not prompt you to assign each
bean to a container. Instead, each bean will automatically be
assigned to the first container of the appropriate type.
Example: -D
openejb deploy -D myapp\myEjbs.jar
Deploys the beans in the jar, does not prompt you to assign each
bean a deployment ID. Instead, the deployment ID for each bean
will automatically be assigned using the <ejb-name> of the bean
as it is in the META-INF/ejb-jar.xml of the jar file.
The deployment ID uniquely identifies the bean in the OpenEJB
container system. No two beans can share the same deployment ID.
The deployment ID is also used by most servers as the client-side
JNDI name for doing JNDI lookups.
See http://www.openejb.org/deploymentids.html for more details.
Example: -a
openejb deploy -a myapp\myEjbs.jar
Applies all automation related flags. Currently equivalent to:
openejb deploy -C -D myapp\myEjbs.jar
As more automation options are added, they will also be applied
when using the -a option.
Example: -d dir
openejb deploy -d C:\openejb myapp\myEjbs.jar
Sets the OPENEJB_HOME to the C:\openejb directory. This will
cause the deploy tool to treat the C:\openejb as the directory
where OpenEJB was installed.
Example: -conf file
openejb deploy -conf C:\openejb\conf\mytest.conf myapp\myEjbs.jar
Sets the openejb.configuration system variable to the file
C:\openejb\conf\mytest.conf. When the beans are deployed the
beans will be to be mapped to the containers and resources in the
configuration file C:\openejb\conf\mytest.conf. If the deploy
tool needs update the configuration, the mytest.conf file will be
modified.
Example: Combinations of options
openejb deploy -c -a C:\foo\bar.jar D:\my\beans\*.jar
openejb deploy -c -C /foo/bar.jar
openejb deploy -m -a /home/dblevins/mybeans/*.jar
openejb deploy -D -m /home/dblevins/mybeans/*.jar
openejb deploy -a /openejb/beans/*.jar
openejb deploy -a C:\openejb\beans\*.jar
Bug Reports to <[email protected]>
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/start.help
Index: start.help
===================================================================
Usage: openejb start [options]
Starts OpenEJB as an EJB Server that can be accessed by remote
clients via the OpenEJB Remote Server.
ALWAYS check your openejb.log file for warnings immediately after
starting the Remote Server.
OpenEJB issues warnings when it works around a potential problem,
encounters something it didn't expect, or when OpenEJB wants to
let you know something may not work as you expected it.
OPTIONS
-h host Binds the Remote Server to the specified host address.
Default host address is 127.0.0.1.
-p port Binds the Remote Server to the specified port.
Default port is 4201.
-t int Sets the number of concurrent threads the Remote
server should use to service requests from clients.
Default number of threads is 20.
-d dir Sets the OPENEJB_HOME to the specified directory.
-l file Sets the log4j configuration to the specified file.
-conf file Sets the OpenEJB configuration to the specified file.
-version Print the version.
-help Print this help message.
-examples Show examples of how to use the options.
--admin-ip A comma delimited list of hosts and IP addresses that
are allowed to administer this server.
--local-copy=[true|false]
When set to true, the container system will marshall
(ie, copy) all calls between beans are required by
the EJB 1.1 specification. When set to false, the
container system will pass parameters and return
values without copying or marshalling as is required
for EJB 2.0 Local interfaces. Default is true.
See http://www.openejb.org/remote-server.html for more information.
OpenEJB -- EJB Container System and EJB Server.
For OpenEJB updates and additional information, visit
http://www.openejb.org
Bug Reports to <[email protected]>
1.1
openejb1/modules/core/src/META-INF/org.openejb.cli/validate.examples
Index: validate.examples
===================================================================
Usage: openejb validate [options] JARFILES...
Example: Multiple jar files
openejb validate myapp\fooEjbs.jar myapp\barEjbs.jar
Validates the beans in the fooEjbs.jar first, then validates the
beans in the barEjbs.jar. Wildcards can be used as well.
openejb validate myapp\*.jar
Example: -v
openejb validate -v myapp\myEjbs.jar
Validates the beans in the jar, outputting just the minumum details
on each failure.
Example: -vv
openejb validate -vv myapp\myEjbs.jar
Validates the beans in the jar, outputting one line summaries of
each failure. This is the default output level.
Example: -vvv
openejb validate -vv myapp\myEjbs.jar
Validates the beans in the jar, outputting verbose details on each
failure, usually with details on how to correct the failures.
Example: -nowarn
openejb validate -nowarn myapp\myEjbs.jar
Outputs only the failures and errors, no warnings.
Example: -xml
openejb validate -xml myapp\myEjbs.jar
Outputs the validation information in XML format.
Example: Combinations of options
openejb validate -vv -nowarn C:\foo\bar.jar D:\my\beans\*.jar
openejb validate -vvv /foo/bar.jar
openejb validate -xml /home/dblevins/mybeans/*.jar
Bug Reports to <[email protected]>
