Oracle Coherence Monitor User Guide

Oracle Coherence Monitor

User Guide

Configure & Install - rtvquery Servlet
This section describes how to configure and install the rtvquery servlet on your application server (for example, Tomcat). The rtvquery servlet comes with the Data Server. This section includes:

Configuring rtvquery Servlet
Installing rtvquery Servlet
Deploying Multiple Servlets

The files for configuration and installation the rtvquery servlet are located in the servlets\rtvquery directory.

This section is intended for users with an application server (for example, Tomcat) and a standard working knowledge of servlet deployment.

Configuring rtvquery Servlet
The rtquery.properties file, located in the servlets\rtvquery directory, contains properties that determine servlet behavior. Edit this file to change any of the properties from their default values. The most important properties are DataserverHost and DataServerPort, which specify the hostname and port number of the Data Server to which the servlet is to connect. The default values are localhost and 3278, respectively (localhost indicates that the servlet and Data Server are running on the same machine). See the comments in the rtvquery.properties file for a description of the other properties and their default values.

NOTE: If you have already installed the servlet on your application server, you can edit the rtvquery.properties file on your application server. If you edit this file in servlets\rtvquery you must remake and reinstall rtvquery.war, described in Installing rtvquery Servlet (next).

After modifying the rtvquery.properties file you may need to restart your application server.

The web.xml file should be edited only if it is necessary to change the servlet authentication. By default, authentication is disabled, so any client can submit queries to the servlet. To enable authentication edit the web.xml file. Un-comment the authentication section, located at the end of the file, then remake and redeploy the rtvquery.war file. When authentication is enabled, the browser prompts the user for login information when the first request for a session is sent to the servlet. The user must enter a username and password that are valid for the application server (for example, Tomcat). For details, see the comments in the web.xml file.

Installing rtvquery Servlet
After you configure the servlet, you must install the servlet on your application server. The servlets\rtvquery directory contains an installation script to install the rtvquery servlet on the Tomcat instance included with RTView.

To install the rtvquery servlet:
In an initialized command window, go to the servlets\rtvquery directory and run the following scripts.

NOTE: These scripts require that you set the environment variable CATALINA_HOME to the location of your Tomcat installation directory, see the Setup section for details.

	make_war	This script creates a web archive (.war) named rtvquery.war.

	install_to_tomcat rtvquery	This script installs the web archive rtvquery.war to your Tomcat server. NOTE: This script will shutdown and restart Tomcat and requires administrative permissions.

NOTE: If you are using an application server other than Tomcat, install the rtvquery.war file on your application server according to instructions given with that product.

Deploying Multiple rtvquery Servlets
One instance of the rtvquery servlet provides access to one Data Server. To provide access to multiple Data Servers via the rtvquery servlet, you have two options:

(1) Deploy one instance of the servlet on multiple application (web) servers: With this option, if the Data Server runs on a different host than the application server or uses a port other than 3278, you must edit the DataServerHost and DataServerPort properties in the rtvdisplay.properties file accordingly. Repeat this for each application server on which the servlet is deployed.

(2) Deploy multiple instances of the servlet on the same application server: With this option, for each servlet instance you must edit the rtvdisplay.properties file to specify a unqiue DataServerHost and/or DataServerPort value. Then, before deploying rtvquery.war file, rename the file to a unique name for that application server (for example, rtvquery_dataserver1.war, rtvquery_dataserver2.war, and so forth). Use that filename when you install each .war file, for example:

    install_to_tomcat rtvquery_dataserver1

The name you choose for each .war file is also used in the URL when accessing that specific servlet. For example:

    http://somehost:8068/rtvquery_dataserver1/...
    http://somehost:8068/rtvquery_dataserver2/...

RTView contains components licensed under the Apache License Version 2.0.

JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only.

SL, SL-GMS, GMS, RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2011 Sherrill-Lubinski Corporation. All Rights Reserved.