Deploying the REST data service on WebSphere Application Server

This topic describes how to configure the WebSphere® eXtreme Scale REST data service on WebSphere Application Server or WebSphere Application Server Network Deployment Version 6.1.0.25 or or later. These instructions also apply to deployments whereWebSphere eXtreme Scale is integrated with the WebSphere Application Server deployment.

Before you begin

You must have one of the following environments on your system to configure and deploy the REST data service for WebSphere eXtreme Scale.

Procedure

  1. Configure and start a data grid.
    1. For details on configuring a data grid for use with the REST data service, see Starting a data grid for REST data services in WebSphere Application Server.
    2. Verify that a client can connect to and access entities in the data grid. For an example, see Tutorial: Getting started with WebSphere eXtreme Scale.
  2. Build the eXtreme Scale REST service configuration JAR or directory. See the information about packaging and deploying the REST service in Installing the REST data service.
  3. Add the REST data service configuration JAR or directory to the application server classpath:
    1. Open the WebSphere Application Server administrative console
    2. Navigate to Environment > Shared libraries
    3. Click New
    4. Add the following entries into the appropriate fields:
      • Name: extremescale_rest_configuration
      • Classpath: <REST service configuration jar or directory>
    5. Click OK
    6. Save the changes to the master configuration
  4. Add the WebSphere eXtreme Scale client runtime JAR, wsogclient.jar, and the REST data service configuration JAR or directory to the application server classpath. This step is not necessary if WebSphere eXtreme Scale is integrated with the WebSphere Application Server installation.

    1. Open theWebSphere Application Server administrative console.
    2. Navigate to Environment > Shared libraries.
    3. Click New.
    4. Add the following entries into the fields:
      • Name: extremescale_client_v71
      • Classpath: wxs_home/lib/wsogclient.jar
      Remember: Add each path on a separate line.
    5. Click OK.
    6. Save the changes to the master configuration.
  5. Install the REST data service EAR file, wxsrestservice.ear, to the WebSphere Application Server using the administrative console:
    1. Open the WebSphere Application Server administrative console.
    2. Click Applications > New application.
    3. Browse to the /lib/wxsrestservice.ear file on the file system and select it and click Next.
      • If using WebSphere Application Server Version 7.0, click Next.
      • If using WebSphere Application Server Version 6.1, enter a Context Root value with the name: /wxsrestservice and continue to the next step.
    4. Choose the detailed installation option, and click Next.
    5. On the application security warnings screen, click Continue.
    6. Choose the default installation options, and click Next.
    7. Choose a server to map the application to, and click Next.
    8. On the JSP reloading page, use the defaults, and click Next.
    9. On the shared libraries page, map the wxsrestservice.war module to the shared libraries that you defined:
      • extremescale_rest_configuration
      • extremescale_client_v71
      Tip: This shared library is required only if WebSphere eXtreme Scale is not integrated with WebSphere Application Server.
    10. On the map shared library relationship page, use the defaults, and click Next.
    11. On the map virtual hosts page, use the defaults, and click Next.
    12. On the map context roots page, set the context root to: wxsrestservice
    13. On the Summary screen, click Finish to complete the installation.
    14. Save the changes to the master configuration.
  6. Start the wxsrestservice REST data service application:
    1. Go to the application in the administrative console.
      • WebSphere Application Server Version 7.0: In the administrative console, click Applications > Application Types > WebSphere Applications.
      • WebSphere Application Server Version 6.1: In the administrative console, click Applications > Enterprise Applications.
    2. Check the check box next to the wxsrestservice application, and click Start.
    3. Review the SystemOut.log file for the application server profile. When the REST data service has started successfully, the following message is displayed in the SystemOut.log file for the server profile:

      CWOBJ4000I: The WebSphere eXtreme Scale REST data service has been started.

  7. Verify the REST data service is working: The port number can be found in the SystemOut.log file within the application server profile logs directory by looking at the first port displayed for message identifier: SRVE0250I. The default port is 9080.

    For example:http://localhost:9080/wxsrestservice/restservice/NorthwindGrid/ Result: The AtomPub service document is displayed.

    For example: http://localhost:9080/wxsrestservice/restservice/NorthwindGrid/$metadata. The Entity Model Data Extensions (EDMX) document is displayed.

  8. To stop the data grid processes, use CTRL+C in the respective command window.