Web Service for Optimize for Infrastructure

This document covers the following topics:


General Information

This document describes the installation of the Natural for Ajax web service for Optimize for Infrastructure. This web service enables Optimize for Infrastructure to measure and display certain key performance indicators (KPIs) of the Natural for Ajax installation. The Optimize for Infrastructure documentation contains the definitions of these KPIs and describes how to make the web service known to Optimize for Infrastructure.

The web service is delivered as a web application (NJXOptimizeService.war).

Prerequisites

The following topics are covered below:

Java

Java 8 is required to run the web service. Therefore, your application server or web container must be started with Java 8.

Application Server

The following application servers are supported:

  • Wildfly Application Server 10 and 11.

  • IBM WebSphere Application Server 8.5.

Web Container

The following web container is supported:

  • Apache Tomcat 7, 8 and 9.

Installing the Web Service on Wildfly Application Server

The following topics are covered below:

Installation

The distributables for the different Wildfly Application Server versions are contained in the following directories:

Version Directory
WildFly 10 and 11 WildFly

Installing the Web Service on IBM WebSphere Application Server

The following topics are covered below:

Prerequisites

For IBM WebSphere Application Server, there are no specific prerequisites.

Installation

The distributables for IBM WebSphere Application Server are contained in the directory WebSphere.

The web service is installed using the Administration Console of IBM WebSphere Application Server.

The following is assumed:

  • <host> is the name of the machine on which the application server is installed.

  • <port> is the name of the port where the application server is installed. In a default installation, this is port 9080.

  • <adminport> is the name of the port where the Administration Console is installed. In a default installation, this is port 9060.

Start of instruction setTo install the web service

  1. Make sure the application server is running.

  2. Open your web browser and enter the following URL:

    http://<host>:<adminport>/ibm/console

    This opens the Administration Console.

  3. Deploy the web application NJXOptimizeService.war:

    1. Open the tree node Applications > Application Types > WebSphere enterprise applications.

    2. On the Enterprise applications page, choose Install.

    3. Select WebSphere/NJXOptimizeService.war as the path to the new application. Then choose Next.

    4. Choose Next. If additional information is required, you will be prompted.

    5. On the Select installation options page, select the Deploy Web services check box. Then choose Next.

    6. On the Map modules to servers page, select a cluster and server, select Natural for Ajax and choose Apply. Then choose Next.

    7. On the Map virtual hosts for Web modules page, select a virtual host, select Natural for Ajax and choose Next.

    8. On the Map context roots for Web modules page, enter "NJXOptimizeService" as context root and choose Next.

    9. On the Summary page, choose Finish.

    10. On the next page, choose Save.

Installing the Web Service on Apache Tomcat

The following topics are covered below:

Prerequisites

You need to add JAX-WS to your NJXOptimizeService web application:

  1. Download a version of JAX-WS from http://jax-ws.java.net/.

  2. Expand the JAX-WS archive and copy all *.jar file from the /lib directory into the WEB-INF/lib directory of the NJXOptimizeService web application.

  3. As of Java 11, the packages of the JavaBeans Activation Framework (JAF) have been removed from the distribution. As a consequence, applications running on Java 11 need the activation*.jar copied into the WEB-INF/lib directory of the NJXOptimizeService web application.

Start of instruction setTo install JAX-WS 2.0

  1. Download the JAX-WS 2.0 archive from the site indicated above.

  2. Unpack the archive.

  3. Copy the contents of the lib directory into the lib directory of your Apache Tomcat installation.

Installation

The distributables for Apache Tomcat are contained in the directory Tomcat.

The web service is installed using the Tomcat Manager.

The following is assumed:

  • <host> is the name of the machine on which Apache Tomcat is installed.

  • <port> is the name of the port where Apache Tomcat is installed. In a default installation, this is port 8080.

  • <tomcat> is the path to the directory in which Apache Tomcat is installed.

Start of instruction setTo install the web service

  1. Start Apache Tomcat.

  2. Open your web browser and enter the following URL:

    http://<host>:<port>/manager/html

    This opens the Tomcat Manager.

  3. Deploy the web application file NJXOptimizeService.war:

    • Under Select WAR file to upload select the path to the file NJXOptimizeService.war.

    • Choose Deploy.

Verifying the Installation

It is assumed that http://<host>:<port> is the URL of your application server or web container.

Start of instruction setTo verify the installation

  • Enter the following URL in your web browser:

    http://<host>:<port>/NJXOptimizeService/DataCollectionService?wsdl

    The WSDL definition of the web service should be displayed.