THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Commands | Description |
|---|---|
Display help information | |
Print arguments to STDOUT | |
Load a file or URL to the current shell | |
Clear the terminal screen | |
Set a variable | |
Unset a variable | |
Exit GShell | |
Start a server | |
Stop the server | |
Wait for the server to start | |
Start an application client | |
Connect to a Geronimo server | |
Save the username and password for this connection | |
Disconnect from a Geronimo server | |
Deploy a module | |
Redeploy a module | |
Undeploy a module | |
Distribute a module | |
Start a module | |
Restart a module | |
Stop a module | |
List modules | |
List targets | |
Install plug-ins into the server | |
Install library | |
Install a plug-in | |
Extract a Geronimo server from the current one | |
Create a new instance | |
Connect to a remote GShell server | |
Start a remote GShell server | |
Monitor cluster heartbeat | |
Administer cluster | |
Generate WSDL file from class | |
Generate JAX-WS artifacts from class | |
Generate Java classes from WSDL | |
Generate JAX-WS artifacts from WSDL |
Running GShell and Getting Help
...
Note: Windows users, use forward slash "/" instead of the traditional back slash "\" when specifying as directory paths seperators within GShell commands. Using back slash may cause errors in processing the command.
...
| No Format |
|---|
geronimo/start-server -A <JAR> -D <name=value> -G <name=value> -H <dir> -J <flag> -P <name> -b -j <dir> -l <file> -m <module> -p <port> -q -t <time> -u <user> -v -w <password> --secure |
These commands options are described in the following table except besides the general options:
Option | Usage | Description |
|---|---|---|
-A, or --javaagent | -A <JAR> | Identify the specific Java Agent with a JAR file containing its path. To disable it, set it to 'none'. |
-D, or --property | -D <name=value> | Define system properties. |
-G, or --gproperty | -G <name=value> | Define org.apache.geronimo properties. This option is probably used if you start two or more Geronimo instances on your server. |
-H, or --home | -H <dir> | Provide a specific Geronimo home directory. This option is probably used if you start two or more Geronimo instances on your server. |
-J, or --javaopt | -J <flag> | Set a Java Virtual Machine (JVM) flag. |
-P, or --profile | -P <name> | Select a configuration profile. |
-b, or --background | -b | If provided, the server process will run in the background. |
-j, or --jvm | -j <dir> | Use a specific JVM for the server process. |
-l, or --logfile | -l <file> | Capture the console output to a log file. |
-m, or --module | -m <module> | Start up a specific module. |
-q, or --quiet | -q | Suppress warning and informative message. |
-t, or --timeout | -t <time> | Identify the timeout in seconds. |
-v, or --verbose | -v | Enable verbose output, resulting in more console output than is normally present. |
...
If successfully installed, the library will be found in <Geronimo<geronimo_HOME>home>/repository, where <Geronimo<geronimo_HOME>home> is the server's installation directory.
...
| No Format |
|---|
deploy/assemble -a <artifact> -f <format> -g <groupId> -l -p <port> -s <server hostname> -t <path> -u <user> -w <password> -s <server hostname> -p <port> --secure |
The options are explainied explained in the following table:
Option | Usage | Description |
|---|---|---|
-a, or --artifact | -a <artifact> | Can be used to provide the server artifact name. |
-f, or --format | -f <format> | Can be used to specify if the assembly is in .zip or tar.gz format. |
-g, or --groupId | -g <groupId> | Can be used to specify the group ID of the library. |
-t, or --path | -t <path> | Can be used to provide the assembly location, where your specific plug-ins are stored. The default location is |
-l-l, or --list | -l | Can be used to refresh the plug-in list. |
...
Your successfully assembled server will be found in <Geronimo<geronimo_HOME>home>/var/temp, where <Geronimo<geronimo_HOME>home> is the server's installation directory.
Creating a new instance
The deploy/new-instance command can be used to creating a new server instance from the current one, and uses this syntax:
| No Format |
|---|
deploy/new-instance <SERVER_NAME> -u <user> -w <password> -s <server hostname> -p <port> --secure
|
where SERVER_NAME is the name of the new instance. Look into Running Multiple Geronimo Instances for more information about how to initiate the new instance.
Connecting to a remote Gshell
This remote/rsh can be used to execute gshell commands on a remote Gshell server.
| No Format |
|---|
remote/rsh tcp://<REMOTEIP>:<PORT> <GShellCommand>
|
Where REMOTEIP is the IP address on which the remote GShell server is running, PORT is the listening port on the remote Gshell server and GShellCommand is the command which can be executed in any GShell environment.
Starting a remote GShell
The remote/rsh-server command can be used to start a remote GShell session for listening on a port to accept requests from foreign address.
| No Format |
|---|
remote/rsh-server tcp://<LOCALIP>:<PORT>
|
where LOCALIP is the IP address of the GShell server, PORT is the listening port that you can specify any unoccupied port number.
Monitoring cluster heartbeat
The cluster/heartbeat command can be used to monitor cluster heartbeat when you enabled plugin based Farming.
| No Format |
|---|
cluster/heartbeat -f <Regex>
|
where Regex is the regular expression to filter heartbeat data displayed. You can use --filter other than -f option.
Administering cluster
The cluster/deploy command can be used to deploy/undeploy a plugin or a list of plugins on a specified cluster. This command is only workable when you enabled Plugin based Farming and performed the command on a controller node.
| No Format |
|---|
cluster/deploy ACTION -c <clustername> -l <pluginlistname> -a <pluginartifactID>
|
The options are explained in the following table:
Option | Usage | Description |
|---|---|---|
ACTION | add/remove | Action (add/remove) to perform |
-c, or --cluster) | -c <clustername> | Can be used to specify name of the cluster to perform action on |
-l, or --pluginlist | -l <pluginlist> | Can be used to specify name of the plugin List to perform action on |
-a, or --pluginartifact | -a <pluginartifactID> | Can be used to specify name of the plugin to perform action on |
See general options for information about other options of this command.
Generating WSDL file from class
The jaxws/java2ws command can be used to generate a WSDL file, wrapper bean, server side code and client side code from a Web service endpoint's implementation (SEI) class and associated types classes. It uses this syntax:
| No Format |
|---|
jaxws/java2ws -databinding <jaxb or aegis> -frontend <jaxws or simple> -wsdl -wrapperbean -client -server -ant -wrapperbean -o
<output-file> -d <resource-directory> -s <source-directory> -classdir <compile-classes-directoty> -cp <class-path> -soap12 -t
<target-namespace> -beans <pathname of the bean definition file> -servicename <service-name> -portname <port-name> -address
<address> -createxsdimports -h -v -verbose -quiet <classname>
|
These options are described in the following table:
Option | Usage | Description |
|---|---|---|
-help or -h | -help or -h | Can be used to obtain the help information. |
--databinding | -databinding <jaxb or aegis> | Can be used to specify the data binding (jaxb or aegis). By default it is jaxb for jaxws frontend, and aegis for simple frontend. |
-frontend | -frontend <jaxws or simple> | Can be used tp specify the frontend. Jaxws and the simple frontend are supported. |
-wsdl | -wsdl | Can be used to generate the WSDL file. |
-client | -client | Can be used to generate client side code. |
-server | -server | Can be used to generate server side code. |
-ant | -ant | Can be used to generate an Ant |
-wrapperbean | -wrapperbean | Can be used to generate the wrapper and fault bean. |
-o | -o <output-file> | Can be used to specify the name of the generated WSDL file. |
-d | -d <resource-directory> | Can be used to specify the directory in which the resource files are located. The wsdl file will be placed into this directory by default. |
-s | -s <source-directory> | Can be used to specify the directory in which the generated source files (wrapper bean ,fault bean ,client side or server side code) are located. |
-classdir | -classdir <compile-classes-directoty> | Can be used to specify the directory in which the generated sources are compiled into. If not specified, the files are not compiled. |
-cp | -cp <class-path> | Can be used to specify the SEI and types class search path of directories and zip/jar files. |
-soap12 | -soap12 | Can be used to indicate that the generated WSDL is to include a SOAP 1.2 binding. |
-t | -t <target-namespace> | Can be used to specify the target namespace in the generated WSDL file. |
-beans | -beans <pathname of the bean definition file> | Can be used to specify the path and name of the generated bean definition file. |
-servicename | -servicename <service-name> | Can be used to specify the value of the generated service element's name attribute. |
-portname | -portname <port-name> | Can be used to specify the port name to use in the generated WSDL. |
-address | -address <address> | Can be used to specify the port address. |
-createxsdimports | -createxsdimports | Can be used to output schemas to separate files and load them by imports instead of inlining them into the WSDL. |
-v | -v | Can be used to obtain the version number. |
-verbose | -verbose | Can be used to display comments during the code generation process. |
-quiet | -quiet | Can be used to suppress comments during the code generation process. |
<classname> | <classname> | Can be used to specify the name of the SEI class. |
Generating JAX-WS artifacts from class
The jaxws/wsgen command can be used to generate necessary portable artifacts for JAX-WS applications from Java classes. Unlike jaxws/java2ws, this command generates a WSDL file only when requested. It uses this syntax:
| No Format |
|---|
jaxws/wsgen -classpath <path> -cp <path> -d <directory> -extension -help -keep -r <directory> -verbose -version -wsdl[:protocol]
-servicename <name> -portname <name>
|
These options are described in the following table:
Option | Usage | Description |
|---|---|---|
-classpath or -cp | -classpath <path> or -cp <path> | Can be used to specify the location of the service implementation class. |
-d | -d <directory> | Can be used to specify the directory in which the generated output files will be placed. |
-extension | -extension | Can be used to allow custom extensions for functionality not specified by the JAX-WS specification. Use of the extensions can result in applications that are not portable or do not interoperate with other implementations. Here is a list of the extentions available:
|
-help | -help | Can be used to obtain the help information. |
-keep | -keep | Can be used to keep the generated source files. |
-r | -r <directory> | Can be used to specify the directory in which generated WSDL file is placed. This parameter is only used in conjunction with the -wsdl parameter. |
-verbose | -verbose | Can be used to output messages about what the compiler is doing. |
-version | -version | Can be used to obtain the version number. If you specify this option, only the version information will be output and normal command processing will not occur. |
-wsdl | -wsd [:protocol] | Can be used to direct wsgen to generate a WSDL file and is typically used by a developer to review a WSDL file before the endpoint is deployed. By default, wsgen does not generate a WSDL file. The protocol can be used to specify the protocol used in the wsdl:binding, and is optional. Valid values for protocol are soap 1.1 and Xsoap 1.2. The default value is soap 1.1. The Xsoap 1.2 value can only be used in conjunction with the |
-servicename | -servicename <name> | Can be used to specify a wsdl:service name to be generated in the WSDL file. This parameter is only used in conjunction with the -wsdl option. |
Generating Java classes from WSDL
The jaxws/wsdl2java command can be used to create Java SEI classes from WSDL, and uses this syntax:
| No Format |
|---|
jaxws/wsdl2java -fe <front-end-name>* -db <data-binding-name>* -wv <wsdl-version> -p <[wsdl-namespace = ]package-name>* -sn
<service-name> -b <bindling-file-name> -catalog <catalog-file-name> -d <output-directory> -compile -classdir <compile-classes-directory> -impl -server -client
-all -autoNameResolution -defaultValues<=class-name-for-DefaultValueProvider> -ant -nexclude <schema-namespace [=java=package-
name]>* -exsh <<true,false>> -dns <<true,false>> -dex <<true,false>> -validate -keep -wsdllocation <wsdlLocation> -xjc
<xjc-arguments> -noAddressBinding -h -v -verbose -quiet <wsdlurl>
|
These options are described in the following table:
Option | Usage | Description |
|---|---|---|
-help or -h | -help or -h | Can be used to obtain the help information. |
-fe | -fe <frontend-name> | Can be used to specify the frontend. By default it is JAXWS frontend. Currently only JAXWS frontend is supported. |
-db | -db <databinding-name> | Can be used to specify the data binding. By default it is jaxb. Currently only JAXB databinding is supported. |
-wv | -wv <wsdl-version> | Can be used to specify the wsdl version. By default it is WSDL 1.1. Currently only WSDL 1.1 version is supported. |
-p | -p <[wsdl-namespace = ] package-name>* | Can be used to specify zero or more package names for the generated code. |
-sn | -sn <service-name> | Can be used to specify the WSDL service name for the generated code. |
-b | -b <bindling-file-name> | Can be used to specify zero or more JAXWS or JAXB binding files. You can use spaces to separate more than one entry. |
-catalog | -catalog <catalog-file-name> | Can be used to specify catalog file that maps the imported wsdl/schema. |
-d | -d <output-directory> | Can be used to specify the directory into which the generated code files are written. |
-compile | -compile | Can be used to compile generated Java files. |
-classdir | -classdir <compile-classes-directory> | Can be used to specify the directory into which the compiled class files are written. |
-impl | -impl | Can be used to generate starting point code for an implementation object. |
-client | -client | Can be used to generate starting point code for a client mainline. |
-server | -server | Can be used to generate starting point code for a server mainline. |
-all | -all | Can be used to generate all starting point code: types, service proxy, service interface, server mainline, client mainline, implementation object, and an Ant |
-autoNameResolution | -autoNameResolution | Can be used to automatically resolve naming conflicts without binding customizations. |
-defaultValues | -defaultValues=[DefaultValueProvider impl] | Can be used to generate default values for the impl and client. You can also provide a custom default value provider. The default provider is RandomValueProvider. |
-ant | -ant | Can be used to generates the Ant |
-nexclude | -nexclude <schema-namespace [=java=package-name]>* | Can be used to ignore the specified WSDL schema namespace when generating code. This option can be specified multiple times. Java package name used by types described in the excluded namespace(s) can also be specified. The java package name is optional. |
-exsh | -exsh <<true,false>> | Can be used to enable or disable processing of implicit SOAP headers (SOAP headers defined in the wsdl:binding but not wsdl:portType section.) By default it is false. |
-dns | -dns <<true,false>> | Can be used to enable or disable the loading of the default namespace package name mapping. Default is true and http://www.w3.org/2005/08/addressing=org.apache.cxf.ws.addressingnamespace package mapping will be enabled. |
-dex | -dex <<true,false>> | Can be used to enable or disable the loading of the default excludes namespace mapping. Default is true. |
-validate | -validate | Can be used to enable validating the WSDL before generating the code. |
-keep | -keep | Can be used to indicate that the code generator will not overwrite any preexisting files. You will be responsible for resolving any resulting compilation issues. |
-wsdlLocation | -wsdllocation <wsdlLocation> | Can be used to specify the value of the @WebServiceClient annotation's wsdlLocation property. |
-xjc | -xjc <xjc-arguments> | Can be used to specify a comma separated list of arguments that are passed directly to the XJC processor when using the JAXB databinding. A list of available XJC plugins can be obtained using |
-noAddressBinding | -noAddressBinding | Can be used to direct the code generator to generate the older CXF proprietary WS-Addressing types instead of the JAX-WS 2.1 compliant WS-Addressing types. |
-v | -v | Can be used to obtain the version number. |
-verbose | -verbose | Can be used to display comments during the code generation process. |
-queit | -quiet | Can be used to suppress comments during the code generation process. |
<wsdlurl> | <wsdlurl> | Can be used to specify the path and name of the WSDL file in generating the code. |
Generating JAX-WS artifacts from WSDL
The jaxws/wsimport command can be used to generates the required portable artifacts for JAX-WS Web service applications from an existing WSDL file. It uses this syntax:
| No Format |
|---|
jaxws/wsimport -b <path> -B <jaxbOption> -catalog <file> -d <directory> -extension -help -httpproxy:<host>:<port> -keep -p <pkg>
-quiet -s <directory> -target <version> -verbose -version -wsdllocation <location>
|
These options are described in the following table:
Option | Usage | Description |
|---|---|---|
-b | <path> | Can be used to specify the external JAX-WS or JAXB binding files. You can specify multiple JAX-WS and JAXB binding files by using the -b option; however, each file must be specified with its own -b option. |
-B | -B <jaxbOption> | Can be passed to JAXB schema complier. |
-catalog | -catalog <file> | Can be used to specify the catalog file that resolves external entity references. It supports TR9401, XCatalog, and OASIS XML Catalog formats. |
-d | <directory> | Can be used to specify the directory in which the generated output files are placed. |
-extension | -extension | Can be used to allow custom extensions for functionality that are not specified by the JAX-WS specification. The use of custom extensions can result in applications that are not portable or do not interoperate with other implementations. |
-help | -help | Can be used to obtain the help information. |
-httpproxy | -httpproxy:<host>:<port> | Can be used to specify an HTTP proxy. The default port value is 8080. |
-keep | -keep | Can be used to keep the generated source files. |
-p | -p <pkg> | Can be used to specify a target package with this command-line option and overrides any WSDL file and schema binding customization for the package name and the default package name algorithm defined in the JAX-WS specification. |
-s | -s <directory> | Can be used to specify the directory in which the generated source files are placed. |
-target | -target <version> | Can be used to specify the version of JAXWS specification in generating the code. |
-verbose | -verbose | Can be used to output messages about what the compiler is doing. |
-version | -version | Can be used to obtain the version information. If you specify this option, only the version information is included in the output and normal command processing does not occur. |
-wsdlLocation | -wsdllocation <location> | Can be used to specify the @WebServiceClient.wsdlLocation value. |