This page describes an older version of the product. The latest stable version is 12.3.

REST Manager API


The XAP Manager provides a REST Manager API for managing the GigaSpaces application environment.

To begin, start a standalone XAP Manager on your machine using the following command:

./gs-agent.sh --manager-local
gs-agent.bat --manager-local

After the XAP Manager has started, browse to localhost:8090 and start working with the API.

See also:

You must start a XAP Manager to access the REST Manager API. You can also start a cluster of XAP Managers to ensure high availability. To learn more about the XAP Manager, refer to XAP Manager.

The REST Manager API was built with Swagger . Swagger provides typical information for each operation (parameters, responses, etc.). In addition, you can experiment with it by setting parameters and clicking the Try it out! button from within the documentation. This invokes the operation, and you can see the response code and body, as well as the curl command and request URL that were used to invoke the command. If you are familiar with the older Admin API, most of this is self explanatory. You can also download the yaml specification and use Swagger’s Online Editor to generate a client in your favourite language.

image

Long-Running Operations

In the Admin API, long-running operations (for example, deploy and undeploy) are asynchronous with no future or callback. You can either track progress manually, or use various ‘andWait’ overloads (for example, deployAndWait). The REST Manager API cannot use andWait so you must poll for completion, but each such operation behaves differently.

Instead, the REST Manager API contains Request functionality. Each long-running operation creates a request and returns its ID, so you can poll on the request ID and check the status (running/successful/failed). The request exposes additional useful information:

  • Who started the request (IP and user)
  • When the request was started and completed
  • If the request failed, an error message
  • Additional properties on the request execution

By default, the system keeps up to 100,000 completed requests (configurable), and purges the oldest as needed.

Processing Unit Deployment and Upload

Deploying a Processing Unit requires uploading a resource (JAR/WAR/ZIP) to the XAP Manager, but due to technical issues we currently can’t include both a binary file and a JSON payload in the same REST operation. Instead, there are two operations:

  • Upload a resource.
  • Deploy a Processing Unit, and provide a name of a previously uploaded resource.

This also means that when you undeploy a Processing Unit, the resource does not get deleted. If you want to delete it you must execute a separate REST operation (if you want to undeploy/redeploy with the same JAR. there’s no need to remove it). Currently you cannot delete/replace a JAR file if a deployed Processing Unit is using it.

Security

Security needs to be explicitly enabled. As with any other grid component, to enable the security add the system property -Dcom.gs.security.enabled=true. For more information, see the Security topics in the Administration guide. By default, to get you up and running, if nothing was configured the fallback security implementation uses a local file to save credentials (see File-Based Security.

When security is enabled, the REST Manager API performs basic authentication and checks if the user has sufficient privileges to execute the operation.

Note

Basic authentication does not encrypt user credentials, so running a XAP Manager in a secure environment without SSL is a security hazard; the system detects this and aborts. You must explicitly enable or disable the SSL by setting the system property com.gs.manager.rest.ssl.enabled.

You can either:

  • Disable SSL explicitly (not recommended).
  • Enable SSL, and the system will generate a certificate for you.
  • Enable SSL and provide a trusted certificate that you own.

An auto-generated certificate provides reasonable security, but if your enterprise security guidelines are more strict you can provide your own certificate.

Finally, if you need to configure something that we don’t expose (we use Jetty under the hood to host the web app), you can provide your own jetty.xml file via a system property.

Port System Property Default
Enable/disable com.gs.manager.rest.ssl.enabled must be explicitly set
Keystore path com.gs.manager.rest.ssl.keystore-path
Keystore password com.gs.manager.rest.ssl.keystore-password
Custom config com.gs.manager.rest.jetty.config

Operations

You can perform a wide variety of operations on all of the environment components listed below. The available operations, request parameters and URLs are listed on each relevant page of the local XAP Manager.

Online Editor

You can download the yaml configuration file from http://localhost:8090/v1/xap-manager-api.yaml and import or copy and past the yaml content into the Swagger Editor .

image

From the Swagger user interface, you can generate client code in your preferred language:

image