Software Links
Getting Started
- A Globus Primer
- Globus Is Modular!
- Quickstart
- Installing GT
- Platform Notes
- GT Developer's Guide
- GT User's Guide
- Migrating Guides
Reference
Manuals
Common Runtime
Security
- GSI C
- GSI Java
- Java WS A&A
- C WS A&A (coming soon)
- CAS
- Delegation Service
- MyProxy
- GSI-OpenSSH
- SimpleCA
Data Mgt
WS MDS
Execution Mgt
Table of Contents
Java WS Core provides per-
gar
configuration
and supports configuration profiles. The configuration information of a
service is mainly encapsulated in two separate configuration files:
- server-config.wsdd (Web Service Deployment Descriptor) - contains information about the web service.
- jndi-config.xml (JNDI configuration file) - contains information about the resource management.
A service that supports security might also have the
security-config.xml
(security deployment
descriptor) file. Please see
Java WS A&A Security Descriptor Framework
for details.
All these configuration files are dropped into the
$GLOBUS_LOCATION/etc/<gar.id>/
directory during the deployment process.
The global properties are specified in the
<globalConfiguration>
section of
*server-config.wsdd
files in the
$GLOBUS_LOCATION/etc/globus_wsrf_core/
directory. The configuration item
name
corresponds
to the "name" attribute in a
<parameter>
sub element, and the
value
is put as a "value"
attribute within the same parameter element.
Table 1. General configuration parameters
Table 2. Standalone/embedded container-specific configuration parameters
| Name | Value | Description | Comments |
|---|---|---|---|
| containerTimeout | <int> | This parameter controls the container timeout. That is, the maximum amount of time the container will wait to receive a message from the client. By default it is set to 3 minutes. | Optional |
| webContext | <name> | This parameter specifies the context name under which the
services are published under:
http://<host>:<port>/<webContext>/services/MyService
.
By default "wsrf" name is used.
In Tomcat, this parameter is set to the web application's
name.
| Optional |
While there aren't a large number of parameters which you can use to tune the container for performance, configuring your container in a manner appropriate to the needs of your application can yield significant benefits. Having said that, these are very general guidelines which may not apply to every situation. In addition, many commonly used services have configuration recommendations. It is strongly suggested that you check the performance tuning guide for your particular service before attempting to change these settings on your own.
The first major parameters you can adjust are not strictly container parameters, but tweaking the parameters of the JVM in which your container is running can provide significant performance benefits. Each implementation of the JVM has it's own set of parameters which can be modified, however, all JVM's have parameters to change the heap memory usage. By default, the JVM claims 64 MB from the operating system. This will be too small for any real deployment of the container. For a service such as GRAM, which expects to process large numbers of jobs which may exist for an extended period of time, we recommend specifying at least 1024 MB for the maximum heap memory. In addition, you should specify the minimum amount of heap memory your container will use. To set these values for the container, execute this command:
GLOBUS_OPTIONS="-Xms256M -Xmx1024M"
This will tell the virtual machine to claim 256 MB as the minimum heap size and 1024 MB as the maximum heap size. As a general rule of thumb, if you specify more memory, your performance will improve. Of course, this is only the case if your machine has sufficient memory.
In addition, certain JVM implementations have additional parameters which can improve performance.
The
most notable is in the Sun JVM implementation. Specifying the process to be
-server
allows the JVM to run in "server" mode. The JVM will typically perform better on CPU intensive tasks
(like most GT containers) when in "server" mode. To set this value, add
-server
to your
GLOBUS_OPTIONS
variable:
GLOBUS_OPTIONS="$GLOBUS_OPTIONS -server"
The Container parameters also play a significant role in the performance of your container. The main parameters relate to threads.
Setting up threads for a container is as much an art as a science, so here are some guidelines for configuring your container. The number of threads determines how many concurrent requests your container can service. However, just setting this number to a high value is not a good solution, because each thread takes resources. Ideally, you would want to set this number to be equal to the number of processors your machine has, because that would mean that each thread is being serviced all the time (of course, that is assuming that your computer isn't doing anything else, which is never. That's why this is "ideally"). However, unless you are getting only 1 or 2 requests at a time, this will prevent requests from being processed in a timely manner. So, when configuring this value, you will generally want to find a balance between the number of requests you expect to receive and the resources available on the machine. You should usually try to set this value as low as you can. Having said that, if you expect a large number of requests and those requests are either completed quickly or do the work in a separate thread, the default value of 20 maximum threads is usually sufficient. However, in that scenario, you will probably want to set the minimum number of threads to 20 as well. That way you won't take time starting and stopping threads.
So, as a basic rule of thumb, the default thread configuration will be sufficient unless, you a) expect to receive a large number of concurrent requests which can be processed quickly (in which case you should make the minimum and maximum number of threads equal) or b) you will have a low number of concurrent requests that can be processed quickly (in which case, you might consider reducing the maximum number of threads) or c) you have will receive a large number of concurrent requests which take a long time to process (in which case you should increase the maximum number of threads). The third situation listed is definitely not ideal, because it will put a heavy load on the server with no real way to balance it. In this scenario, you should consider passing the processing from your service to the WorkManager. The specific configuration parameters are listed below.
Table 3. Container Thread Parameters
| Name | Value | Description | Comments |
|---|---|---|---|
| containerThreads | <int> | This parameter controls the initial thread pool size for the container. If not set, it defaults to 1. | Optional |
| containerThreadsMax | <int> | This parameter sets the maximum number of threads for the
container. By default it is set to 4 * the
containerThread
setting.
| Optional |
| containerThreadsHighWaterMark | <int> | This parameter controls when the thread pool of the
container should start shrinking (if the number of idle threads
exceeds this number). By default it is set to 2 * the
containerThread
setting.
| Optional |
The default Thread settings are as follows:
The connection timeout parameter in the client can also play a role in tuning performance. This is a new feature in the 4.2 release. It allows a client to keep the http connection open to the server across multiple requests. Setting this to a higher value will mean the same connection is used for longer. This can positively impact performance by eliminating some of the overhead involved in connecting to the server. However, this is not a magic bullet, so don't expect to see huge improvements from this parameter. If you have a long running task on the server, you will probably see modest improvement in the time required to actually submit the request to the server, but the latency in your request will likely make that mostly moot. Also, if you keep a connection open, you will be limiting the ability of other clients to connect. So this is a parameter that should be changed carefully, depending on your particular circumstances.
An example of a deployment descriptor for a CounterService:
<service name="CounterService" provider="Handler" use="literal" style="document"> <parameter name="className"
value="org.globus.wsrf.samples.counter.CounterService"/>
<parameter name="handlerClass" value="org.globus.axis.providers.RPCProvider"/>
<parameter name="scope" value="Application"/>
<wsdlFile>share/schema/core/samples/counter/counter_service.wsdl</wsdlFile>
<parameter name="allowedMethodsClass" value="com.counter.CounterPortType"/>
<parameter name="providers" value=" DestroyProvider SetTerminationTimeProvider
GetRPProvider SubscribeProvider GetCurrentMessageProvider"/>
</service>
Services are defined in a
<service>
element. The
"name" attribute of the
<service>
element defines the
remotely accessible name of the service. The service handle will have
the form of <hosting environment URL>/foo, where:
- the hosting environment URL typically is
http://<host>:<port>/wsrf/services. -
foo
is the name of the service
(
<service name="foo" ...>).
The
use
attribute should be set to
literal
and the
style
attribute to
document
for all WSRF/WSN based
services. The configuration information for a service is defined by
various
<parameter>
sub-elements within a
<service>
element. The configuration item
name
corresponds
to the "name" attribute in a
<parameter>
sub element, and
the
value
is put as a
"value" attribute within the same parameter
element.
Table 5. Axis Standard Parameters
| Name | Value | Description | Comments |
| className | <class> | This parameter specifies a class that implements the web service methods. | Required |
| handlerClass | <class> | This parameter specifies what dispatcher to use to send
a request to a service method. This parameter is required if
the
provider
attribute of the
service
is set to
Provider. The default
dispatcher we provide is called
org.globus.axis.providers.RPCProvider. It
enables special features such as operation providers or
security support.
| Recommended in our environment |
| scope | <value> | Scope value can be one of: Request (the default),Application, or Session. If Request scope is used, a new service object is created for each SOAP request that comes in for the service. If Application scope is used, only a single instance of the service object is created and used for all SOAP requests that come in for the service. If Session scope is used, a new service object is created for each session-enabled client who accesses the service. Note: Only Request and Application scopes are supported when used with org.globus.axis.providers.RPCProvider handlerClass. | Application scope is recommended |
| wsdlFile | <path> | This parameter points to a wsdl file for the service. The wsdl file must contain the wsdl:service entry. The file location can be relative or absolute. A relative file location is recommended. | Required in our environment |
| allowedMethods | <list of methods> | This parameter specifies a space or comma separated
list of method names that can be called via SOAP.
"*"
indicates that all
methods of the service class can be invoked via SOAP.
| Optional. By default all methods are allowed. |
Table 6. Java WS Core Parameters
| Name | Value | Description | Comments |
| loadOnStartup | <boolean> | If set to true this parameter will cause the web service and the corresponding ResourceHome (if any) to be initialized (with proper security settings if configured) at container startup. This is useful for restarting some tasks, etc. at container startup without having to call the service. Please check Section 1.1, “How can I force my service to initialize when the container starts?” for details. | Optional |
| allowedMethodsClass | <class> | This parameter is similar to the allowedMethods standard Axis property but it specifies a Java class or an interface that is introspected to come up with a list of allowed methods that can be called remotely on the service. It is useful for easily restricting the SOAP-accessible methods of the service. Usually the class specified in this parameter would be the remote interface class generated for the service. This parameter only has effect if used with org.globus.axis.providers.RPCProvider handlerClass. | Optional |
| providers | <list of providers> | This parameter specifies a space separated list of provider names or class names. Please see the Operation provider support section for details. This parameter only has effect if used with org.globus.axis.providers.RPCProvider handlerClass. | Optional |
Please see Custom Deployment for details on Axis Web Services Deployment Descriptor.
An example of a JNDI configuration bit for a CounterService:
<service name="CounterService"> <resource name="home"
type="org.globus.wsrf.samples.counter.CounterHome"> <resourceParams>
<parameter> <name>factory</name>
<value>org.globus.wsrf.jndi.BeanFactory</value>
</parameter> <parameter>
<name>resourceClass</name>
<value>org.globus.wsrf.samples.counter.PersistentCounter</value>
</parameter> <parameter>
<name>resourceKeyName</name>
<value>{http://counter.com}CounterKey</value>
</parameter> <parameter>
<name>resourceKeyType</name>
<value>java.lang.Integer</value> </parameter>
</resourceParams> </resource> </service>Each service in WSDD should have a matching entry in the JNDI
configuration file with the same name. Under each service entry in
JNDI different resource objects or entries might be defined. Please
see
Section 7, “JNDI, Resources and Objects”
for details.
Each service entry in JNDI should have a resource defined called
"home". That resource is the
ResourceHome
implementation for the service (as
specified by the
type
attribute).
Depending on the
ResourceHome
implementation different options can be configured for the
ResourceHome. Currently we have two
main base
ResourceHome
implementations:
org.globus.wsrf.impl.ResourceHomeImpl
and
org.globus.wsrf.impl.ServiceResourceHome.
Note:
All
"home"
resources must specify a
factory
parameter with
org.globus.wsrf.jndi.BeanFactory
value.
The
ResourceHomeImpl
is a generic and
reusable
ResourceHome
implementation. It supports persistent resources, resource caching,
resource sweeper, etc.
Table 7. ResourceHomeImpl parameters
| Name | Value | Description | Comments |
| resourceKeyName | <qname> | This parameter specifies a QName of the resource key.
The namespace is specified in the
{}. For example, this QName
will be used to discover the SOAP header that contains the
key of the resource in the request.
| Required |
| resourceKeyType | <class> | This parameter specifies the type of the resource key as a Java class. The key XML element is deserialized into this Java type. The Java type can be for any simple Java type, Axis generated bean, or a class with a type mapping. | Optional. Defaults to
java.lang.String
|
| resourceClass | <class> | This parameter specifies the classname of the resource object. This is used to ensure that right type of resource object is added to resource home and to instantiate the right object if the resource supports persistence. | Required |
| sweeperDelay | <long> | This parameter specifies how often the resource sweeper runs in milliseconds. | Optional. Defaults to 1 minute |
| cacheLocation | <jndi path> | This parameter specifies the JNDI location of the resource cache for this resource home. Please see Configuring Resource Cache below for details. | Optional |
If ResourceHomeImpl is configured with resource class that implements the PersistenceCallback interface it will store the resource objects wrapped in Java SoftReference. That allows the JVM to automatically reclaim these resource objects, thus reducing the memory usage. Since the JVM can decide to reclaim these objects at any point, sometimes a resource object can be reclaimed between two subsequent invocations on the same resource. This for example can cause the state of the resource to be reloaded from disk on each call. To prevent the JVM from reclaiming the resource objects so quickly a cache can be setup up to hold direct references to these objects. A basic LRU (least recently used) cache implementation is provided. Other cache implementations can be used as long as they implement the org.globus.wsrf.utils.cache.Cache interface.
To configure a cache for ResourceHomeImpl first define a cache resource entry in JNDI, for example:
<resource name="cache" type="org.globus.wsrf.utils.cache.LRUCache">
<resourceParams>
<parameter>
<name>factory</name>
<value>org.globus.wsrf.jndi.BeanFactory</value>
</parameter>
<parameter>
<name>timeout</name>
<value>120000</value>
</parameter>
<parameter>
<name>maxSize</name>
<value>1000</value>
</parameter>
</resourceParams>
</resource>
The "timeout" parameter (in ms) is used to specify the idle time of the resource object before it is removed from the cache. Also, the "maxSize" parameter can be used to specify the maximum size of the cache. By default the cache is configured without any size limit and 5 minutes timeout.
Once the cache resource entry is defined add the "cacheLocation" parameter to the service home resource. The "cacheLocation" parameter value is the JNDI name of the cache resource:
<service name="CounterService">
<resource name="home" type="...">
<resourceParams>
...
<parameter>
<name>cacheLocation</name>
<value>java:comp/env/services/CounterService/cache</value>
</parameter>
...
</resourceParams>
</resource>
...
<resource name="cache" type="org.globus.wsrf.utils.cache.LRUCache">
...
</resource>
</service>
Please note that once the object is removed from the cache it is still up to the JVM to actually reclaim the object. Also, the same cache resource can be reused in different services but usually one cache per service should be configured.
Java WS Core container and other GT services are configured to send out usage statistics. Please see the Usage Statistics section in the Java WS Core Admin Guide for more information.
The targets to which the usage statistics are sent to are
configured via the
usageStatisticsTargets
parameter defined in the
<globalConfiguration>
section of
the
$GLOBUS_LOCATION/etc/globus_wsrf_core/server-config.wsdd
file. The
usageStatisticsTargets
parameter specifies a space separated list of targets to which the usage
statistics of various components will be sent to. Each target is of
form:
host[:port]
(port is optional, if
not specified a default port will be assumed). By default usage
statistics are sent to
usage-stats.globus.org:4810.
To disable sending of the usage statistics remove this parameter, comment it out, or remove all of its values.
Configuration profiles allow for the same Java WS Core installation to have multiple configurations. That is, the same installation can be used to run different containers each with different configuration.
When a
.gar
file is
deployed, a
-Dprofile
option can be
specified to deploy the configuration files under a specific profile
name. If the profile name is specified, the deploy operation will drop
the configuration file as
$GLOBUS_LOCATION/etc/<gar.id>/<profile.name>-server-config.wsdd
and/or
$GLOBUS_LOCATION/etc/<gar.id>/<profile.name>-jndi-config.xml.
The configuration profiles can also be created by hand simply by copying
and/or renaming the configuration files appropriately. Each
configuration profile should duplicate the contents of
$GLOBUS_LOCATION/etc/globus_wsrf_core/server-config.wsdd
and
$GLOBUS_LOCATION/etc/globus_wsrf_core/jndir-config.xml
in order to have the basic functionality work properly.
Once a configuration profile is created, the
standalone container
can be
started with a
-profile
option to load
configuration files in a specific profile.
To create an
/etc/init.d
entry for
the standalone container do the following steps:
As root create
/etc/init.d/gt4containerscript with the following contents:ACCOUNT=globus GLOBUS_LOCATION=<globusLocation> INIT=$GLOBUS_LOCATION/etc/init.d/globus-ws-java-container su $ACCOUNT -c "$INIT $*"Set executable permissions on the
/etc/init.d/gt4containerscript and register it with theinit.dsystem:$ chmod +x /etc/init.d/gt4container $ /sbin/chkconfig -a gt4container
After this step the container should start automatically after the next reboot. Make sure the container is configured with a global security descriptor that explicitly points to long term credentials.
To start the container by hand run:
$ /etc/init.d/gt4container start
To stop the container by hand run:
$ /etc/init.d/gt4container stop