Package Docs: Odyssey-2

This page is the starting point for documentation of the odyssey-2 package, maintained on capo.

Configuration Options

Odyssey configuration is per-region. Accordingly the supported share types in the configuration area are admin, arch, regional, and share. It is not anticipated that arch will be very useful, as Odyssey is primarily implemented in Java and should behave identically regardless of the underlying architecture.

There is an XHier configuration file config/[share]/config which works in the usual XHier way. It has two parameters: CmdGate for indicating if the command-line gateway is to be active ("yes" or "no"), and WebGate for indicating if the local access web gateway is to be active ("yes" or "no").

In addition there is a config/[share]/jars directory, containing Java jar files or symlinks to the same. These are combined together per region to produce the complete list of jar files which will be available to the Odyssey JVM.

Data Files

In addition to files contained in the XHier data directory (for which see PackageDocumentationOdyssey2Data), the following directories are important:

• connect: Pipes and associated locks for gateway communication. See OdysseyConnectDirectory.
• export: XHier definitions for user and group odyssey.
• java-src: Region-specific Java code.
• java-doc: (not yet implemented) JavaDoc generated from the region-specific Java code (OdysseyJavaCode).
• java-jar: Combined set of jar files based upon configuration.
• java-cls: Compiled Java code from java-src.
• logs: Logs generated by the gateways and JVM processes. See OdysseyLogs.

Server Commands

• cgigate: See OdysseyAdapter.
• compileJava: A shell script used by the Install script that re-compiles the OdysseyJavaCode.
• restart: See OdysseyAdapter.
• runJava: A shell script that invokes Java with the correct environment.
• webgate: See OdysseyAdapter.
• websuid: The CGI used to run webgate; see OdysseyWebsuid.

Maintenance Commands

• odysseyClassPath: A shell script that gives the correct $CLASSPATH for running Java.
• makeFakeTemplates: A shell script that uses Lynx to download expanded versions of the Odyssey CLF implementation into a temporary directory.

User Commands

• getpw: An interface to the getpwnam, getpwent, getpwuid, etc. OS calls. See CommandDocumentationGetPW.
• odyssey: The Odyssey command-line gateway. See OdysseyAdapter.

-- IsaacMorland - 05 Jan 2007