= The Friendly Step-by-Step Guide for Setting Up the Summa Search Webservice =

See also: SummaStorage

=== Step 1, Get a Tomcat Servlet Container ===
Download a recent (''and stable'') version of the Apache Tomcat. [[http://tomcat.edu.brock.dk/apache/tomcat/tomcat-5/v5.5.20/bin/apache-tomcat-5.5.20.tar.gz|Fx. 5.5.20]], and unpack it to an appropriate place.

=== Step 2, Configure Your Tomcat ===
''Append'' the following all-in--nut-cracking-no-brain security policy to your ''conf/catalina.policy'' file:

{{{
grant {
      permission java.security.AllPermission;
};
}}}

Set the service ports in ''conf/server.xml'' as you wish. You want to pay attention to the following:
 * The port specified in the Server element. This is the ''shutdown port''.
 * The non-SSL HTTP/1.1 Connector element
 * All other Connector elements (if any) can be removed.

=== Step 3, Install on Configure the summaws Webservice ===
Get ''summaws.war'' from the latest summa build. At the moment of writing this can be obtained from ''hera'', ''/home/java-3part/summa/build-4217/summaws.war''. Put it in your Tomcats ''webapps'' directory.

From your Tomcat root dir, do

{{{
cd webapps && mkdir summaws && cd summaws && unzip ../summaws.war
}}}

From the Tomcat root dir the relevant configuration files can now be found in ''webapps/summaws/WEB-INF/classes''. Here's a checklist:

 * '''searchEngine.properties.xml'''
   * paths should be correct
   * io_service should be something like //localhost:7999/SummaDOMSStorage
 * '''cluster.properties.xml'''
   * Set correct paths
 * '''log4j.xml'''
   * Set correct paths and log levels
 * '''Suggestion.properties.xml'''
   * Set correct path

== Step 4, Start the Tomcat ==
From the Tomcat root directory do

{{{
bin/startup.sh
}}}

To shut down the Tomcat issue

{{{
bin/shutdown.sh
}}}


== Step 5, Testing the Webservice ==
You can obtain a list of services on http://alhena:7920/summaws/services (without a trailing slash!). You should be able to derive the method calling syntax from the examples below - ''keeping in mind that method arguments must be listed in reverse!'':

 * A search for ''utf8'' : http://alhena:7920/summaws/services/SummaSearch?method=simpleSearch&arg0=0&arg1=10&arg2=utf8
 * Get the record corresponding to the Fedora PID ''sb:Filetype_utf8'': http://alhena:7920/summaws/services/SummaSearch?method=getRecord&arg0=oai:sb:Filetype_utf8