Autovue Configuration Steps

If the AutoVue server will be accessed by clients outside a firewall, direct access non-standard ports (i.e. non-HTTP) are often blocked. To enable clients to access servers that are protected by firewalls, a servlet is provided to tunnel requests through the HTTP or HTTPS protocol. When tunneling is required, the AutoVue client encodes requests from the HTTP/HTTPS protocol and attempts to invoke the servlet on the specified server. The servlet decodes the parameters included in the request and forwards the request to the AutoVue server using a socket connection. The servlet also replies to the client machine using the same HTTP/HTTPS protocol.

Two changes are needed to configure the server.

A) Install the file vueservlet.jar into the Application server or Servlet engine. Follow the instructions provided with the Application server or Servlet engine.

Tunneling through J2EE-enabled Application Servers This section provides instructions for creating and deploying VueServlet for J2EE application servers. Creating a WAR File for VueServlet Complete the following instructions to create a WAR file for VueServlet. 1 Create a directory. Example: C:\csiwar 2 In the folder C:\csiwar, create a sub-directory WEB-INF. 3 In WEB-INF, create a directory lib: C:\csiwar\WEB-INF\lib 4 Copy vueservlet.jar to C:\csiwar\WEB-INF\lib. 5 Create a deployment descriptor. The deployment descriptor should be stored as a file named web.xml in the WEB-INF directory. • The following is the mandatory header for the web.xml document. It defines the document as an XML file and relates the file syntax to the DOCTYPE resource specified.

The <servlet-name> parameter is how the Servlet is known within the XML file.

The <servlet-class> parameter is the fully qualified Java programming language class name of the Servlet. The <url-pattern> parameter is how the Servlet is referenced from a Universal Resource Indicator (URI).

Update hostname with the name of AutoVue server machine.

Note The parameter structure must follow the order in the DTD definition. For example, all <servlet>s must be defined before any <servlet-mapping>s can be specified. • Update hostname in web.xml with the name of AutoVue server machine.

6. To create the WAR file, use the “jar” utility from the JavaTM Development Kit distribution. If you are in the root directory you created for the WAR contents (C:\csiwar), use the following command: jar cvf VueServlet.war WEB-INF Now you can deploy VueServlet.war using any J2EE compliant application server or Web container.

7 After the VueServlet is deployed, to access the content, type the following into your web browser:

http://host:port/<context>/servlet/VueServlet

The <context> parameter can be set in the deployment phase or set automatically by the application server. Some application servers allow you to specify the context name, but generally the WAR file name is used as the context.

B) Update the Web pages that embed the AutoVue client to include the full URL of the Servlet (something like http://servername/servlet/VueServlet) as the JVUESERVER parameter.

The VueServlet supports two parameters: the JVueServer parameter and the Verbose parameter. The JVueServer parameter needs to be set to the hostname:port value used when starting the AutoVue server. By default, localhost:5099 is used and will work if you installed the AutoVue server on the same machine as the Web server.

You can specify more than one hostname:port separated by semi-colons ( ; ) for fail-over. In other words, if one machine is down the servlet will try the next machine. The Verbose parameter enables verbose output. Both parameters are optional. If JVueServer is not specified, it defaults to localhost:5099. The servlet assumes that AutoVue server is running on the same machine as the Web server and communicates through port 5099. If Verbose not specified, it defaults to False.