
	caGrid 1.4 Introduce 1.4 Documentation Developers Guide Administrators Guide Extensions

Introduce 1.4 Administrators Guide

This guide describes the capabilities that any Introduce generated service has for configuring or administering the service. This list is a generic list that every Introduce service will have but keep in mind that if the service has extensions added it may have extra configuration options and administration utilities.


	Contents Deployment / Undeployment Deploy JBoss specific features Undeploy Configuration Files deploy.properties service.properties

Deployment / Undeployment

Introduce generated services come with the ability to be deployed and undeployed via executing ant targets in the top of the services directory. Below describes the execution of these tools and any extra options that might exist. Remember that if you are deploying to anything other than the Globus container you should first make sure that you have correctly deployed Globus to the web container. Please see Globus or caGrid documentation on how to install and prepare a grid service container.

If you would like to use the Introduce GUI to deploy the service you can find information on how to do this here.

Deploy

Each service that introduce generates comes with the ability to deploy itself to three types of containers: Tomcat, JBoss, and Globus, although use of the Globus container is strongly discouraged. In order to deploy an introduce generated service to the container it is required that ant is installed and that the container is installed as per the Introduce prerequisites. Once this is verified the service can be deployed by typing ant deploy[Tomcat,Globus,JBoss] as shown below for the Tomcat example.

 ant deployTomcat

If you want to skip deployment validation which may be used by certain Introduce extensions you can pass in a flag that disables deployment validation during the deployment process. This can be acomplished by setting the no.deployment.validation property during the execution of ant deploy[Tomcat,Globus,JBoss] as show below for the Tomcat example.

 ant -Dno.deployment.validation=true deployTomcat

The deploy targets also attempt to verify that the CATALINA_HOME or JBOSS_HOME environment variable has been set for deployments to Tomcat and JBoss respectively. If these environment variables are not set, the build will fail with an error message. To disable this behavior, call the deployment target with the property no.env.check set to true, as shown in this example.

 ant -Dno.env.check=true deployTomcat

JBoss specific features

Grid services may be deployed to JBoss as well using the same command line features as Tomcat, except calling the target 'deployJBoss' instead of 'deployTomcat'. An additional feature of the deployment allows for deployment into a specific node of JBoss. By default, the service will be deployed to the 'default' node, but by using the 'jboss.node.name' property, this can be changed.

 ant -Djboss.node.name=non-default-node deployJBoss

Undeploy

Introduce generated sevices also have the ability to undeploy themselves from a supported container. The undeploy will clean the service out of the container and will remove any jars that are not shared with other Introduce generated deployed services. Once a service is undeployed the container will have to be restarted. To undeploy a service go to the service directory and execute ant undeploy[Tomcat,Globus,JBoss] as shown below for the Tomcat example.

 ant undeployTomcat

If you would like to use the Introduce GUI to undeploy the service you can find information on how to do this here.

Configuration Files

Introduce has many configuration files that can be altered to change certain behavior of the service. All of these files are automatically modified by Introduce when using the graphical tool for deployment. The files listed below are files that user can safely modify prior to deployment of a service via the command line. There are many other files the user could modify which can change the behavior of the service however this is strongly discouraged and should only be done by someone with complete understanding of how Axis and Globus services are generated and configured. Below is a list of files relative to the service which are useful to modify prior to command line deployment and what they can be used for. After any modification of any of the below files the service would need to be redeployed to the grid container and the container would have to be restarted.

deploy.properties

The Index Service maintains a registry of services operating in the Grid. Services that wish to be listed in the Index Service's registry must register with the Index Service. When services register with the Index Service they can publish metadata about themselves. Clients and other services can discover registered services by query metadata published to the Index Service by registered services. An Introduce generated service is provided with the ability to register itself with the index service.

The configuration for registering with the Index Service is contained in the properties file, GENERATED_SERVICE_HOME/deploy.properties. This configuration allows registration to be enabled and disabled and allows the configuration of which Index Service to register to. The table below list each of registration properties that can be configured in the file GENERATED_SERVICE_HOME/deploy.properties:

Property Name	Value(s)	Description
perform.index.service.registration	true or false	Whether or not the service should register with the Index Service
index.service.url	URL	The URL of the Index Service to register with.
index.service.index.refresh_milliseconds	Integer	How often to reregister with the index service (this should be a relatively large amount of time and is simply usefull for makeing sure the index service does not loose your registration).
index.service.registration.refresh_seconds	Integer	This number specifies the period of the interval, in seconds, between attempts of the Index Service to retrieve metadata from the Grid service

service.properties

The service.properties file contains any properties that the service designer wanted the deployer of the service to be able to edit before the service was deployed. These properties are accessable to the service and may be used by the service for example to obtain the database connectivity information that it needs to utilize a backend database, or set some default values for analytical routines that the service provides.