Genero Archive deployment service

A deployment service has been written in Genero and can be accessible on a base URL of /ws/r/services/DeploymentService. It provides several actions in the form of REST APIs.

The deployment service is a Web service provided for the Genero Application Server. To prevent this application being accessed remotely, the default configuration restricts access to the localhost (127.0.0.1). If you want to enable it for other client machines / IP addresses, you must customize the ALLOW_FROM tag or remove the ACCESS_CONTROL tag. The service configuration can be found at $FGLDIR/web_utilities/services/DeploymentService.xcf.

Table 1. Actions available for the Genero Archive deployment service
Action Description HTTP request details
deploy Deploys a Genero Archive on the Genero Application Server by calling gasadmin --deploy-archive.

Returns the command result in XML format.

HTTP PUT request of following form:
URL: /ws/r/services/DeploymentService/deploy?archive=name
Note: archive=name is mandatory to identify the archive on the GAS.

To send the archive to the Genero Application Server, you could use curl with a PUT instruction:

curl -X PUT -T test.gar 
http://app_server:port/connector
/ws/r/services/DeploymentService/
deploy?archive=name
where:
  • app_server is the server name or IP address.
  • port is the port where the application server or Web server is listening.
  • connector is the Genero Application Server connector (/gas, for example).
enable Enables all applications and services of a given archive by calling gasadmin --enable-archive.

Returns the command result in XML format.

HTTP GET request of following form:

URL: /ws/r/services/DeploymentService/enable?archive=name

disable Disables all applications and services of given archive by calling gasadmin -–disable-archive.

Returns the command result in XML format.

HTTP GET request of following form:

URL: /ws/r/services/DeploymentService/disable?archive=name

undeploy Undeploys a genero archive on the Genero Application Server by calling gasadmin –-undeploy-archive. HTTP GET request of following form:

URL: /ws/r/services/DeploymentService/undeploy?archive=name

list Returns a list and status of all archives available on the Genero Application Server by calling gasadmin --list-archive.

Returns the command result in XML format.

HTTP GET request of following form:

URL: /ws/r/services/DeploymentService/list

cleanup The cleanup operation is not available withthe REST service, as it requires user interaction to its prompts. To perform a cleanup operation, you must use gasadmin on the application server(performed by gasadmin --clean-archives). N/A