GT 3.9.3 Java WS Core : User's Guide

Introduction

[End user-friendly introduction AND references to the Toolkit-level User's Guide where they can find general end user-oriented information]

Command-line tools

globus-start-container

Tool description

Starts a standalone container. By default the container is started on port 8080 and is accessible via HTTP. On successful startup a list of services will be displayed on the console. By default a secure container is started on port 8443 and is accessible via HTTPS

Command syntax

globus-start-container [options]
-help

Displays help information about the command.
-p <port>

Sets the port number for the container.
-quiet

Does not show a list of services at startup.
-secure

Starts a secure container.
-containerDesc <file>

Specifies a container security descriptor file.
-profile <name>

Specifies a configuration profile name for the container.

globus-stop-container

Tool description

Stops a standalone container. By default this command will attempt to stop a container running on localhost:8080. It will perform a sort shutdown.

Command syntax

globus-stop-container [options] ['soft' | 'hard']
Where 'soft' option will let the threads to die naturally, while 'hard' will force an immediate JVM shutdown.

wsrf-destroy

Tool description

Destroys a resource.

Command syntax

wsrf-destroy [options]

wsrf-set-termination-time

Tool description

Sets a termination time of a resource.

Command syntax

wsrf-set-termination-time [options] <seconds> | 'infinity'

wsrf-query

Tool description

Queries resource property document of a resource. By default, a simple XPath query is assumed that returns the entire resource property document.

Command syntax

wsrf-query [options] [query expression] [dialect]

wsrf-get-property

Tool description

Gets a single resource property from a resource.

Command syntax

wsrf-get-property [options] <property>

The <property> is a QName of the resource property in the string form: {namespaceURI}localPart.

wsrf-get-properties

Tool description

Gets multiple resource properties from a resource.

Command syntax

wsrf-get-properties [options] <property1> [<property2>... <propertyN>]

Each <propertyN> is a QName of the resource property in the string form: {namespaceURI}localPart.

wsrf-insert-property

Tool description

Inserts a property into the resource property document of a resource.

Command syntax

wsrf-insert-property [options] <propertyValueFile>

The <propertyValueFile> is a XML file that contains the value of the resource property. The QName of the property is the outer most element.

wsrf-update-property

Tool description

Updates property value in the resource property document of a resource.

Command syntax

wsrf-update-property [options] <propertyValueFile>

The <propertyValueFile> is a XML file that contains the value of the resource property. The QName of the property is the outer most element.

wsrf-delete-property

Tool description

Deletes a resource property from the resource property document of a resource.

Command syntax

wsrf-delete-property [options] <property>

The <property> is a QName of the resource property in the string form: {namespaceURI}localPart.

wsn-get-current-message

Tool description

Gets the current message associated with the specified topic.

Command syntax

wsn-get-current-message [options] <topic>

The <topic> is a QName of the resource property in the string form: {namespaceURI}localPart.

wsn-pause-subscription

Tool description

Pauses a subscription (notifications on that subscription will not be sent out until it is resumed)

Command syntax

wsn-pause-subscription [options]

wsn-resume-subscription

Tool description

Resumes a subscription (notifications on that subscription will be sent out again)

Command syntax

wsn-resume-subscription [options]

wsn-subscribe

Tool description

Subscribes to a topic.

Command syntax

wsn-subscribe [options] <topic>

The <topic> is a QName of the resource property in the string form: {namespaceURI}localPart.

Subscribe-specific options in addition to the common options:

-r, --resDescFile <file>

Specifies a file containing a resource security descriptor for the notification consumer resource.
-b, --subEpr <file>l

Specifies a file to which the subscription resource EPR will be saved.

ant deployGar

Tool description

Deploys a gar file (Ant task).

Command syntax

ant -f $GLOBUS_LOCATION\share\globus_wsrf_common\build-packages.xml deployGar -Dgar.file=<gar.file> [-Dprofile=<profile>]

The <gar.file> is an absolute path to the gar file to be deployed. The optional -Dprofile argument specifies the profile name under which the configuration files in the gar will be deployed under. Please see (XXX: configuration profiles) for details.

ant undeployGar

Tool description

Undeploys a gar file (Ant task).

Command syntax

ant -f $GLOBUS_LOCATION\share\globus_wsrf_common\build-packages.xml undeployGar -Dgar.id=<gar.id>

The <gar.id> is the base name of the gar file without the .gar extension to undeploy. For example if gar file is "foo.gar" than the gar id is "foo".

Common Command syntax

Some clients share the same command line options:

-h, --help

Displays help information about the command.
-d, --debug

Enables debug mode. For example, full stack traces of errors will be displayed.
-e, --eprFile <file>

Specifies a XML file that contains the endpoint reference
-s, --service <url>

Specifies the service URL.
-k, --key <name value>

Specifies the resource key. The name is the QName of the resource key in the string form: {namespaceURI}localPart, while the value is the simple value of the key. For complex keys use the --eprFile option. Example: 

-k {http://www.globus.org}MyKey 123
-f, --descriptor <file>

Specifies a client security descriptor. Overrides all other security settings.
-a, --anonymous

Enables anonymous authentication. Only supported with GSI Secure Conversation authentication mechanism.
-g, --delegation <mode>

Enables delegation. mode can be either 'limited' or 'full'. Only supported with GSI Secure Conversation authentication mechanism.
-l, --contextLifetime <value>

Sets the lifetime of the client security context. value is in milliseconds. Only supported with GSI Secure Conversation authentication mechanism.
-m, --securityMech <type>

Specifies the authentication mechanism. type can be 'msg' for GSI Secure Message, or 'conv' for GSI Secure Conversation.
-c, --serverCertificate <file>

Specifies the server's certificate file used for encryption. Only needed for GSI Secure Message authentication mechanism.
-p, --protection <type>

Specifies the protection level. type can be 'sig' for signature or 'enc' for encryption.
-z, --authorization <type>

Specifies authorization type. type can be 'self', 'host', or 'none'.

Graphical user interfaces

Overview of the purpose and functionality of the GUI

There is no support for this type of interface for Java WS Core.

Troubleshooting

Currently, no common problems are reported.

In general, if you want to investigate a problem on your own please see the Debugging and Logging section for details on how to turn on debugging. Also, please note that most of the command line clients have -debug option that will display more detailed error messages including the error stack traces. Also, searching the mailing lists such as discuss@globus.org or developer-discuss@globus.org (before posting a message) can also be very fruitful. Finally, if you think you have found a bug please report it in our Bugzilla system. Please include as much as detail about the problem as possible.