Service Health Check Sample for REST

Use a REST client such as the following to invoke the Service Health Check request:

• POSTMAN: https://www.getpostman.com/postman
• GitHub: https://github.com/wiztools/rest-client/
• SoapUI: https://www.soapui.org/downloads

Deploying the Bookstore Sample

Deploy the DAA file of the sample, com.tibco.restbt.sample.bookstore.daa, to an ActiveMatrix Runtime Node using the ActiveMatrix Administrator UI.

Obtaining the Endpoint URL of the Service

You can obtain the Endpoint URL of the Service either from the Swagger UI or the Configuration tab.

• From Swagger UI:

  

  1. In ActiveMatrix Administrator, click Applications.
  2. Select com.tibco.restbt.sample.bookstore from the list of Applications.
  3. Click the General tab.
  4. Expand the BookStoreResource Service.
  5. Select the REST Binding, RESTService_Binding1.
  6. On the right side, select the Node and click .
  7. Note the Base URL mentioned on the Swagger UI page. For example, the Base URL in the following screenshot is test-workstation:9831/bookstore.

     

  8. Append /checkHealth to this URL to form the Endpoint URL. For example, the Endpoint URL for the above Base URL is:

     test-workstation:9831/bookstore/checkHealth

     Where, checkHealth is the operation name for executing Service Health Check.

• From the Configuration tab:

  

  1. In ActiveMatrix Administrator, click Applications.
  2. Select com.tibco.restbt.sample.bookstore from the list of Applications.
  3. Click the Configuration tab.
  4. Select the BookStoreResource Service.
  5. On the right, click Bindings.
  6. Select the REST Binding, RESTService_Binding1.
  7. Click Edit. The Edit Binding dialog is displayed.

     

  8. Note the Context root and Connector Name details displayed. The details are required to create the Endpoint URL.
  9. Use the Connector Name to find out the port number of the HTTP Connector as follows:
     1. Select Shared Objects > Resource Templates.
     2. Under Resource Templates > Type, select HTTP Connector.
     3. On the right, select the HTTP Connector. The connector name must be the same as the one displayed in the Edit Binding dialog.

        The port number is displayed in the Port field of the General tab.

        

  10. Create the Endpoint URL using the Context root and port number of the HTTP Connector. The format of the URL is:

      http://<host>:<port>/<Context root>/checkHealth

      Where:

      <host> is the IP address or name of the ActiveMatrix Administrator Host.

      <port> is the port number of the HTTP Connector used to access the Host.

      <Context root> is the context root associated with the Binding. For the bookstore sample, the context root is bookstore. The value of Context root can be got from the Edit Binding dialog box.

      checkHealth is the operation name for Service Health Check.

Running the Bookstore Sample

Sample Request and Response with XML Payload

Sample Request and Response with Standard JSON Payload

Sample Request and Response with Badgerfish JSON Payload

• HTTP Headers:

  To make a request with Badgerfish JSON Payload, the appropriate HTTP headers are:

  Accept = application/bjson
  Content-Type = application/bjson

• Request:

  Specify the appropriate request parameters as shown in the following example:

   {
    "HealthCheckRequest": {
      "@xmlns": {
        "$": "http:\/\/www.tibco.com\/healthcheck\/"
      },
      "hops": {
        "$": "-1"
      },
      "suppressStackTrace": {
        "$": "False"
      },
      "timeout": {
        "$": "30000"
      }
    }
  }

• Response:

  Following response is seen for the request in the above example:

   {
      "ns2:HealthCheckResponse": {
          "@xmlns": {
              "ns2": "http://www.tibco.com/healthcheck/"
          },
          "@correlationID": "013933c5-c725-448f-be71-4c8b042b3f50",
          "@applicationName": "com.tibco.restbt.sample.bookstore",
          "@status": "Passed",
          "Service": {
              "@bindingType": "REST",
              "@nodeName": "DevNode",
              "@hostName": "SystemHost",
              "@isSSLEnabled": "false",
              "@portTypeName": "BookStoreResource",
              "@responseTime": "2",
              "@ipAddress": "127.0.0.1",
              "@bindingName": "RESTService_Binding1",
              "@machineName": "test-workstation",
              "@environmentName": "DevEnvironment",
              "@name": "BookStoreResource",
              "@startTime": "21 May 2018 16:39:32,247",
              "@transportType": "HTTP",
              "@endTime": "21 May 2018 16:39:32,249",
              "@endpointURI": "urn:amx:DevEnvironment/com.tibco.restbt.sample.bookstore#service-binding(BookStoreResource/RESTService_Binding1)___1.0.0.v2014-12-31-1101",
              "@status": "Passed",
              "Component": {
                  "@nodeName": "DevNode",
                  "@componentType": "TIBCO-IT-JAVA",
                  "@hostName": "SystemHost",
                  "@environmentName": "DevEnvironment",
                  "@responseTime": "2",
                  "@name": "BookStoreResource",
                  "@startTime": "21 May 2018 16:39:32,242",
                  "@endTime": "21 May 2018 16:39:32,244",
                  "@version": "1.0.0.v2014-12-31-1101",
                  "@status": "Passed"
              }
          }
      }
  }

Sample Request and Response for Caching