This topic describes how to install the eXtreme Scale REST data service into a Web server.
The WebSphere eXtreme Scale REST data service is a Java Web application that can be deployed to any application server that supports Java servlet specification, Version 2.3 and a Java runtime environment, Version 5 or later.
The WebSphere eXtreme Scale REST data service includes a single WAR file wxsrestservice.war. The wxsrestservice.war includes a single servlet that acts as a gateway between your WCF Data Services client applications or any other HTTP REST client and an eXtreme Scale grid.
The REST data service includes a sample that allows you to quickly create an eXtreme Scale grid and interact with it using an eXtreme Scale client or the REST data service. See the topic, section for details on using the sample.
The wxsrestservice.ear includes the wxsrestservice.war and are both tightly coupled with the WebSphere eXtreme Scale runtime. If eXtreme Scale is upgraded to a new version or a fix pack applied, the wxsrestservice.war or wxsrestservice.ear will need to be manually upgraded to the version installed in this directory.
The gettingstarted directory contains a simple sample that demonstrates how to use the eXtreme Scale REST data service with an eXtreme Scale grid.
Packaging and deploying the REST data service
The REST data service is designed as a self-contained WAR module. To configure the REST data service, you must first package the REST data service configuration and optional eXtreme Scale configuration files into a JAR file or directory. This application packaging is then referenced by the web container server runtime. Figure 7 illustrates files used by the eXtreme Scale REST data service.
The REST service configuration JAR or directory must contain the following file:
wxsRestService.properties: The wxsRestService.properties file includes the configuration options for the REST data service. This includes the catalog service endpoints, ObjectGrid names to expose, trace options and more. See section : for details.
An example with the minimum required configuration file, where the entities are defined in XML on the servers:
restserviceconfig.jar: wxsRestService.properties
catalogServiceEndPoints=localhost:2809 objectGridNames=NorthwindGrid
An example with one entity, override XML files and entity classes:
restserviceconfig.jar: wxsRestService.properties
catalogServiceEndPoints=localhost:2809 objectGridNames=NorthwindGrid
com/acme/entities/Customer.class META-INF/objectGridClient.xml
<objectGrid name="CustomerGrid" entityMetadataXMLFile="emd.xml"/> META-INF/emd.xml
<entity class-name="com.acme.entities.Customer" name="Customer"/>
For details on the EntityManager API and configuring an eXtreme Scale client and server, see the WebSphere eXtreme Scale Administration Guide.