Skip to topic | Skip to bottom
Grimoires
Grimoires.InstallationManual102

Start of topic | Skip to actions

Grimoires 1.0.2 Installation Manual

Grimoires directory structure

  • src/: source code
  • lib/: where Grimoires server jar is generated, and all third party jars required by Grimoires
  • docs/: documentation
    • api/: javadoc
  • wsdl/: wsdl files and xsd schemas for all Grimoires services
  • config/: configuration files for various containers
    • axis/: configuration files for standard Apache Tomcat
    • gt4/: configuration files for GT4 container
    • omii/: configuration files for OMII 2.0 without signed SOAP message support
    • omii-sec/: configuration files for OMII 1.2.0 with signed SOAP message support
  • dist/: where binary release files (war file or gar file) for various containers are generated
    • client/: Grimoires client
    • server/: Grimoires server
  • wstester/: junit test suite
  • GShell/: Grimoires shell, Grimoires' command line client tool
  • licenses/: third party licenses
  • init.properties: set up the compilation and deployment options for Grimiores. Users need to edit this before compilation and deployment.
  • build.xml: Ant build file containing all ant targets to compile and deploy Grimoires. Users do not need to edit this file to compile and deploy Grimoires.

Configuration

init.properties

All the configurable options to compile and deploy Grimoires are in init.properties.

  • [Required] Target container: omii-sec, omii, axis, or gt4. For instance,
container = omii

Grimoires has three target containers, OMII 1.2.0, Tomcat 5.0, GT4. Here, omii stands for OMII 1.2.0, axis for Tomcat 5.0, and gt4 for GT4. In addition, omii stands for a Grimoires without signed SOAP message support in OMII 1.2.0, while omii-sec for a Grimoires with signed SOAP message support in OMII 1.2.0. (NOTE: Deploying a secure Grimoires in OMII 2.0.0 is in progress.)

  • OMII specific options, which are REQUIRED if "container = omii" or "container = omii-sec" is set. For instance,
tomcat.host = http://gallagher
tomcat:port = 18080
omii.context.path = grimoires
omii.tomcat.username = tomcat
omii.tomcat.password = tomcat

In the above case, Grimoires will be deployed in http://gallagher:18080/grimoires. The username of a valid tomcat account of a manager role is "tomcat", and the corresponding password is "tomcat".

  • Axis specific options, which are REQUIRED if "container = axis" is set. For instance,
axis.tomcat.url = http://localhost:8080/
axis.context.path = grimoires
axis.tomcat.username = tomcat
axis.tomcat.password = tomcat

In the above case, Grimoires will be deployed in http://localhost:8080/grimoires. The username of a valid tomcat account of a manager role is "tomcat", and the corresponding password is "tomcat".

  • GT4 specific options, which are REQUIRED if "container = gt4" is set. For instance,
gt4.url = http://localhost:8080
gt4.home = /home/gt395/gt4 

grimoires.properties

Currently, grimoires.properties controls the RDF triple store configuration in Grimoires. In Grimoires source code, grimoires.properties is in src/. After Grimoires is deployed, grimiores.properties appears in grimoires/WEB-INF/classes, assuming Grimiores is deployed under grimoires/. All the options controlling Grimiores' runtime behavior appear here. Currently it is used to decide the Jena backend of Grimoires. A grimoires.properties file looks like:

# configuration of backends for grimoires
# store states the RDF backend used by grimoires
# All triple store types
# sesame: sesame repository, which includes (file-backed) memory, native, rdbms
# memory: jena in-memory
# file: jena file-backed in-memory
# bdb: jena Berkeley DB
# mysql: jena MySQL
# postgresql: jena PostgreSQL

# Various Sesame repositories
store = sesame

# Sesame in-memory repository
sesame.repository = memory
sesame.inferencing = false
sesame.sync = false
#sesame.file = c:\\sesame.rdf
#sesame.format = ntriples
#sesame.syncDelay = 60000

# Sesame rdbms-based repository 
# sesame.repository = rdbms
# sesame.sync = false
# sesame.jdbcDriver = org.postgresql.Driver
# sesame.jdbcUrl = jdbc:postgresql://localhost/sesame
# sesame.user = sesame
# sesame.password = sesame

# Sesame native repository
# sesame.repository = native
# sesame.sync = false
# sesame.dir =  c:\\sesame

# An Jena in-memory backend
# store = memory

# Memory model backed by files
###################
# store = file
# root = L:\\Documents and Settings\\wf\\My Documents\\workspace\\Grimoires\\store\\

# Berkeley DB store
###################
# store = bdb
# dbfile = c:\\BDBStore
# dbname = Grimoires

# MySQL
###################
# store = mysql
# url = jdbc:mysql://localhost:3306/grimoires
# user = grimoires
# password = grimoires


# PostgreSQL
###################
# store = postgresql
# url = jdbc:postgresql://localhost/Grimoires_Benchmark
# user = grimoires
# password = grimoires

There are various triple stores supported by Grimoires. We use the "store" property to denote different triple store configurations. E.g., "sesame" represents a Sesame repository, which includes (file-backed) in-memory, native, rdbms-based Sesame repository. "memory" represents a Jena in-memory store. "file" represents a Jena file-backed in-memory store. "bdb" represents a Jena Berkeley DB based store. "mysql" represents a Jena MySQL?-based store. "postgresql" represents a Jena PostgreSQL?-based store. To configure, choose any of these store types, as well as its associated properties, and comment all other properties.

Deployment

build.xml

After you set up the options in init.properties to the proper values in your environment, you can call the ant targets in build.xml to compile and deploy Grimoires to your selected container. Here we list all the ant targets for public use:

  • undeploy: undeploy Grimoires from the container, based on the options set up in init.properties.
  • test-install: Test whether Grimoires is deployed in a container properly. It will access each deployed Grimoires service using http protocol, and print the information it get. For instance, it will get http://localhost:18080/grimoires/services/publish. If the publish servie is successfully deployed, you will see
<h1>publish</h1>
<p>Hi there, this is an AXIS service!</p>
<i>Perhaps there will be a form for invoking the service here...</i>

-- WeijianFang - 26 Jul 2005
to top


Copyright 2004 by the University of Southampton