Back to Contents | GAS Configuration File Overview

Service List - Configuration Reference

For a Web service application to be serviced by the Genero Application Server, you must provide the details for that application in either the Genero Application Server configuration file or in an external application server configuration file. This section of the documentation outlines the rules for writing the XML that defines an application; for information about the general process of defining applications and groups, refer to the Adding a Web Service Application section of this manual.

SERVICE_LIST

The SERVICE_LIST element provides a list of groups and Web services applications (for those Web services applications defined within the Genero Application Server configuration file). It takes an attribute MaxLicenseConsumption, which takes an integer specifying the maximum number of licenses that can be consumed by all Web Services specified in the list of services contained within the SERVICE_LIST tags.

Syntax:

<SERVICE_LIST MaxLicenseConsumption="numLicenses"> [ <GROUP ...> [...] ] [ <APPLICATION ...> [...] ] </SERVICE_LIST>

Notes:

The SERVICE_LIST element may contain the following child elements (described below):

Zero or more GROUP elements (optional).
Zero or more APPLICATION elements (optional).

Example:

<CONFIGURATION>
  <APPLICATION SERVER>
    ...
    <SERVICE_LIST MaxLicenseConsumption="10">
      ...
    </SERVICE_LIST>
  </APPLICATION_SERVER>
</CONFIGURATION>

WARNING! You must include the SERVICE_LIST element, even if the Genero Application Server does not have any Web Services to define. In this situation, you simply specify an empty SERVICE_LIST element.

Back to the top

GROUP

The GROUP element allows you to specify a directory where external Web service application configuration files are located. Once a GROUP has been declared, an administrator can add an external Web service application configuration file into the specified directory, and the Genero Application Server will be able to locate and use that file without having to be restarted.

It takes an attribute Id, which specifies the unique identifier for this group. When calling an application defined by an external application configuration file, you must provide the group Id and the name of the external Web service application configuration file name (without the extension), which is typically the name of the Web service application.

Syntax:

<GROUP Id="groupName"> path </GROUP>

Notes:

groupName is a string that uniquely identifies the group.
path is the directory path where the external Web service application configuration files are to be placed.

Usage Example:

 <GROUP id="mygroup">/home/myuser/config</GROUP>

Back to the top

APPLICATION

An APPLICATION element defines an application. For each Web Service you wish to make accessible through the Genero Application Server, you must create an APPLICATION element. The APPLICATION element can have up to four attributes defined:

Id (required for Web services applications defined within the Genero Application Server configuration file; optional for applications defined in an external application configuration file) - A string to uniquely identify this Web service application configuration element. The Id specified is compared to the application name in the request.
Parent - A string that identifies the parent application, or the application from which this application will inherit its default configuration/settings.
MaxLicenseConsumption - A non-negative Integer specifying the maximum license consumption.
Abstract - Defines whether this application configuration element is an abstract application. It expects a boolean string; the valid values for this type are "TRUE" and "FALSE". An Abstract application can not instantiate Virtual Machines. Abstract configurations are used purely in the scope of future inheritance of the configuration for other Web services applications. Abstract applications can only be defined in the application server configuration file, they cannot be defined in an external application configuration file.

Note: With the release of Genero 2.0, Web services are named applications as they host several Web services in one DVM.

When you define a Web service application, you can specify the following elements (described below):

Zero or more RESOURCE elements (optional).
Zero or one EXECUTION element (optional).
Zero or more TIMEOUT elements (optional).

Example:

<APPLICATION Id="webapp" Parent="abswebapp">
  <EXECUTION>
    <PATH>$(res.path.fgldir.demo)</PATH>
    <MODULE>webapp.42r</MODULE>
  </EXECUTION>
  <TIMEOUT> </TIMEOUT>
</APPLICATION>

Back to the top

RESOURCE

The RESOURCE element defines a resource available for this application. For more information on defining resources, refer to the Resources section in this manual.

Back to the top

EXECUTION

The EXECUTION element sets the runtime environment for the application by specifying the parameters for executing a Web application. You can reference a predefined SERVICE_APPLICATION_EXECUTION_COMPONENT to inherit the runtime environment settings of that component by including the Using attribute, specifying the unique identifier for that execution component, and/or you can set individual execution elements specific to the application.

Settings defined locally within the EXECUTION element override settings defined in included execution components.

Possible execution elements include:

Zero or more ENVIRONMENT_VARIABLE elements.
Zero or one PATH element.
Zero or one DVM element.
Zero or one MODULE element.
Zero or one AUTHENTICATION element.
Zero or one POOL element.

For more information on defining execution elements, refer to Setting the Execution Environment.

Usage Examples:

<EXECUTION Using="cpn.ws.execution.local" />

<EXECUTION Using="cpn.ws.execution.local">
  <ENVIRONMENT_VARIABLE Id="FGLGUI>1</ENVIRONMENT_VARIABLE>
</EXECUTION>

Back to the top

TIMEOUT

The TIMEOUT element sets the timeouts for the Web services application. You can reference a predefined SERVICE_APPLICATION_TIMEOUT_COMPONENT to inherit the timeout settings of that component by including the Using attribute, specifying the unique identifier for that timeout component, and/or you can set individual timeout elements specific to the application.

Settings defined locally within the TIMEOUT element override those settings defined in a referenced SERVICE_APPLICATION_TIMEOUT_COMPONENT.

Possible timeout elements include:

Zero or one DVM_AVAILABLE element.
Zero or one DVM_FREE element.
Zero or one REQUEST_QUEUE element.
Zero or one REQUEST_RESULT element.

For more information on setting timeout parameters, refer to Application Timeouts.

Usage Examples:

<TIMEOUT Using="cpn.ws.timeout.set1" />

<TIMEOUT>
  <DVM_AVAILABLE>10</DVM_AVAILABLE>
  <DVM_FREE>10</DVM_FREE>
  <REQUEST_QUEUE>10</REQUEST_QUEUE>
  <REQUEST_RESULT>240</REQUEST_RESULT>
</TIMEOUT>

Back to the top