LEADERS Documentation > System Setup

Contents

1. Source Code and Binaries
   • Prerequisite Software
     • Operating System
     • Java Virtual Machine
     • Servlet Engine
     • Installing CVS and downloading sources
     • Installing Apache Ant and building binaries.
2. Server Setup
   • Initialising Tomcat
   • Application Layout
   • Application Configuration

Application Layout

This section describes the organisation of the LEADERS application as a web application conformant to the Servlet 2.3 Specification, i.e. as it will appear within the TOMCAT_HOME directory structure when the .zip and .war files have been installed according to the instructions above. The commentary below applies to both the toolkit files and the application files, although they may be on entirely separate Tomcat servers.

The LEADERS toolkit/application appears as a hierarchy of directories and files. The hierarchy can be accessed in the application distribution war file, or, when expanded by the servlet container (Tomcat) in a directory under the webapps directory. By default the toolkit is in a webapps/leaders and the application in webapps/leaderswsclient. Besides the directory under webapps, there will be other directories which hold the data files. In the demonstrator these are within the TOMCAT_HOME/archive directory as described above.

These directories contain the EADs, EACs, TEIs and Images, used for indexing and display. In order for the application to know where those directories are, the leaders.properties file must be configured.

The webapps/leaders and webapps/leaderswsclient directories, when installed in Tomcat, will have the following hierarchy:

Top-level directory i.e. leaders and leaderswsclient

This directory, that will have the same name as the war file, is also the document root of the application. In here is the sitemap.xmap file used by Cocoon to control all of the application flow. This file is automatically created at the application startup. Also here are the files (or directories) used to build the application user interface. In the case of leaders these are:

/css

Contains the cascading stylesheets

/js

Contains a JavaScript file, which displays an error message.

/stylesheets

Contains the .xsl stylesheets used to create the hit list and detailed displays.

/xml

Contains the welcome, search and on-line help files with related images.

/xsp

Contains the .xsp scripts used to pass parameters through the application.

/WEB-INF/

This directory contains files and directories that are not visible to the application's users. Among the files are the configuration files, that determine the application behaviour and functionality.

/WEB-INF/classes/

This directory contains the Java class files, and associated resources, of the LEADERS application.

/WEB-INF/lib/

This directory contains JAR files required by the LEADERS application.

Application Configuration

Before using the LEADERS application, a property with the location of the LEADERS archive must be set up for both the toolkit and wsclient applications.

The configuration of the LEADERS archive properties is done in the Tomcat Web Server Administration Tool:

1. Open the tool and go into Tomcat Server/Service/Host/Context(/leaders)/Resources/Environment Entries and click on the leaders.archive entry





2. Change the value according to your installation. NOTE: If you are under a Windows operating system you should use double backslash for the directory separator. For instance if the leaders archive was under c:\archive, the value would be c:\\archive
3. Save the changes by clicking on the Save button
4. Commit the changes to update the server, by clicking on the Commit changes button
5. Start or Reload the LEADERS application in the Tomcat Web Application Manager




6. Repeat the steps above for the leaderswsclient context

To run the application, point your web browser at http://tomcat_url:port/leaderswsclient/.

The LEADERS application also has an additional file for more detailed configuration. This file, leaders.properties is in the LEADERS archive directory.

To configure the properties, just open the properties files with a text editor. Changes made to the properties will only take effect after saving the properties file and restarting the Tomcat engine.

The properties have the following format: property.name=property_value.When configuring the application, look carefully at the property description (which appears before the property), before changing the property_value.

NOTE: Changing a property.name can cause unexpected application behaviour.

Sample leaders.properties file

# ====================================================================================== #
# LEADERS APPLICATION PROPERTIES                                                         #
# ====================================================================================== #

#
# GLOBAL PROPERTIES
application.name=LEADERS
# The application URL. If the application is running behind a firewall or a proxy, use the
# URL to access the application from outside the firewall or proxy
application.url=http://127.0.0.1:8080/leaders

#
# BASE DIRECTORIES PROPERTIES
# This properties are going to be passed as parameters to the indexing stylesheet and are
# also used for document display
eac.base.dir=/archive/docs/eacdocs
ead.base.dir=/archive/docs/eaddocs
img.base.dir=/archive/docs/images
tei.base.dir=/archive/docs/teidocs
xsl.base.dir=/archive/docs/stylesheets

#
# INDEX PROPERTIES
# The directory of the files to create the XML files for indexing
files.to.xml.dir=/archive/docs/eaddocs
# The stylesheet to generate the XML files for indexing
files.to.xml.xsl=/Users/miguel/Develop/java/leaders/bookmarc/web/stylesheets/index/eadindex.xsl
# The directory of the XML files to create the index
xml.to.index.dir=/archive/indexxml
# The index directory
index.dir=/archive/index
# Type of index creation
# Options are: 
#	. true: overwrites previous index, if it exists, otherwise creates new index
#			the previous index gets unavailable during creation
#	. false: updates the existing index, if it exists, otherwise creates new index
#			 the index is always available
index.create=true

#
# WEB SERVICES PROPERTIES
# The Web Service URL. If the Web Services are running behind a firewall or a proxy, use 
# the URL to access the application from outside the firewall or proxy
ws.url=http://127.0.0.1:8080/leaders/services/IndexSearchWS
# The Web Service deployment descriptor file location, relative to the WEB-INF directory
ws.deploy.file=classes/uk/ac/ucl/leaders/ws/deploy.wsdd
# The Web Service undeployment descriptor file location, relative to the WEB-INF directory
ws.undeploy.file=classes/uk/ac/ucl/leaders/ws/undeploy.wsdd

#
# LOGGER PROPERTIES
# The logger output directory
logger.dir=/archive/logs
# The logger identification
logger.id=uk.ac.ucl.leaders
# The detail of logger information. Options are: debug, info, warn, error
logger.level=debug
# Format of the logger messages
logger.pattern=%d{dd-MM-yyyy HH:mm:ss} %p [%t] {%F} - %m%n
logger.date.pattern='.'yyyy-MM-dd