Cocoon Installation Case

Introduction - Cocoon Installation Case (Solaris 8)

I have successfully been able to get Cocoon V1.7.4 to work with the following combination of software :

The additional tools listed below are required to perform this installation :

What follows is some step by step info on how I got it all working. I am submitting this for two reasons: one, as a reference for me for installations on other machines at a later date and two, to provide some help to poor (hardware) engineers like myself who expect install instructions to include every step to actually get the product working !!

Hope this is useful to someone.

How to do it !

I followed the standard Cocoon install instructions but without success. (Most of it is there but it could be a bit clearer.)

I have listed below the key steps that actually got the combination shown above to work.

I have included sections on installing Java SDK, Apache and Jakarta-Tomcat to avoid any possible ambiguity. So, there may be more detail than is actually required - but why not - as long as it all works in the end !

The relevant sections of the modified files mentioned have been partially listed.

The steps listed below mention my own machine name and my own specific paths. Substitute your own naturally. I thought it was better to leave them in to avoid the "path to your..." directives which can sometimes be ambiguous when it comes to how paths are specified within the Windows and Solaris environments i.e forward ("/") and backward slashes ("\") etc ..

Warning : This is long and verbose ! The steps and file listings should be read in the order given i.e top down to bottom.

Before I started this setup on my machine, I did not have any pre-existing Jakarta-Tomcat, Cocoon, or even anything in the CLASSPATH env variable. It was a completely new install on a fresh Solaris 8 SPARC machine.

OK lets go....

Java SDK SE V1.3 Beta Refresh

Apache V1.3.12 HTTP Server

/usr/local/apache/bin/apxs

     ....................
     my $CFG_LD_SHLIB      = q(ld);    # substituted via Makefile.tmpl
     my $CFG_LDFLAGS_SHLIB = q(-G);    # substituted via Makefile.tmpl  
     ....................
    

/usr/local/apache/conf/httpd.conf

     ....................
     #
     # ServerName allows you to set a host name which is sent back to clients for
     # your server if it's different than the one the program would get (i.e., use
     # "www" instead of the host's real name).
     #
     # Note: You cannot just invent host names and hope they work. The name you 
     # define here must be a valid DNS name for your host. If you don't understand
     # this, ask your network administrator.
     # If your host doesn't have a registered DNS name, enter its IP address here.
     # You will have to access it by its address (e.g., http://123.45.67.89/)
     # anyway, and this will make redirections work in a sensible way.
     #
     ServerName shaggy.blimp.au
     ....................
     #
     # Port: The port to which the standalone server listens. For
     # ports < 1023, you will need httpd to be run as root initially.
     #
     Port 80
     ....................
     

Jakarta-Tomcat V3.1

/usr/local/apache/conf/httpd.conf

     ...........
     #
     # VirtualHost example:
     # Almost any Apache directive may go into a VirtualHost container.
     #
     #<VirtualHost ip.address.of.host.some_domain.com>
     #    ServerAdmin webmaster@host.some_domain.com
     #    DocumentRoot /www/docs/host.some_domain.com
     #    ServerName host.some_domain.com
     #    ErrorLog logs/host.some_domain.com-error_log
     #    CustomLog logs/host.some_domain.com-access_log common
     #</VirtualHost>
     
     #<VirtualHost _default_:*>
     #</VirtualHost>
     
     include /usr/local/jakarta-tomcat/conf/tomcat-apache.conf
 
    

/work/test/jakarta-tomcat/build.sh


     #! /bin/sh

     JAVA_HOME=/usr/local/j2sdk1_3_0beta_refresh 
     
     if [ -z "$JAVA_HOME" ]
     then
     JAVACMD=`which java`
     if [ -z "$JAVACMD" ]
     then
     echo "Cannot find JAVA. Please set your PATH."
     exit 1
     fi
     JAVA_BINDIR=`dirname $JAVACMD`
     JAVA_HOME=$JAVA_BINDIR/..
     fi
     
     JAVACMD=$JAVA_HOME/bin/java
     
     cp=../jakarta-ant/lib/ant.jar:\
     ../jakarta-tools/moo.jar:\
     ../jakarta-ant/lib/xml.jar:\
     ../build/tomcat/classes:\
     $JAVA_HOME/lib/tools.jar:\
     $JAVA_HOME/lib/dev.jar
     
     $JAVACMD -classpath $cp:$CLASSPATH org.apache.tools.ant.Main "$@"

    

/usr/local/jakarta-tomcat/bin/tomcat.sh

     #!/bin/sh
     #
     
     # Shell script to start and stop the server
     
     # There are other, simpler commands to startup the runner. The two
     # commented commands good replacements. The first works well with
     # Java Platform 1.1 based runtimes. The second works well with
     # Java2 Platform based runtimes.
     
     TOMCAT_HOME=/usr/local/jakarta-tomcat
     
     JAVA_HOME=/usr/local/j2sdk1_3_0beta_refresh

     .........
    

Cocoon V1.7.4

/usr/local/jakarta-tomcat/bin/tomcat.sh

     .................
     CLASSPATH=$TOMCAT_HOME/classes

     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/xerces_1_0_3.jar
     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/xalan_1_0_1.jar
     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/fop_0_12_1.jar
     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/servlet_2_2.jar
     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/cocoon.jar
     
     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/webserver.jar
     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/jasper.jar
     CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/xml.jar
     #CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/servlet.jar
     CLASSPATH=$CLASSPATH:$JAVA_HOME/lib/tools.jar

     .................
    

/usr/local/jakarta-tomcat/conf/web.xml

     <?xml version="1.0" encoding="ISO-8859-1"?>
     
     <!DOCTYPE web-app
         PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
         "http://java.sun.com/j2ee/dtds/web-app_2.2.dtd">
     
     <web-app>
         <servlet>
             <servlet-name>
                 default
             </servlet-name>
             <servlet-class>
                 org.apache.tomcat.servlets.DefaultServlet
             </servlet-class>
     	<load-on-startup>
                 -2147483646
     	</load-on-startup>
         </servlet>
         <servlet>
             <servlet-name>
                 invoker
             </servlet-name>
     <!--
                 org.apache.tomcat.servlets.NoInvokerServlet
     -->
             <servlet-class>
                 org.apache.tomcat.servlets.InvokerServlet
             </servlet-class>
         </servlet>
         <servlet>
             <servlet-name>
                 jsp
             </servlet-name>
             <servlet-class>
                 org.apache.jasper.runtime.JspServlet
             </servlet-class>
     
     <!-- uncomment the following to use Jikes for JSP compilation
     
             <init-param>
                 <param-name>jspCompilerPlugin</param-name>
                 <param-value>org.apache.jasper.compiler.JikesJavaCompiler</param-value>
             </init-param>
     
     -->
     
     	<load-on-startup>
                 -2147483646
     	</load-on-startup>
         </servlet>
         <servlet-mapping>
             <servlet-name>
                 invoker
             </servlet-name>
             <url-pattern>
                 /servlet/*
             </url-pattern>
         </servlet-mapping>
         <servlet-mapping>
             <servlet-name>
                 jsp
             </servlet-name>
             <url-pattern>
                 *.jsp
             </url-pattern>
         </servlet-mapping>
         <session-config>
             <session-timeout>
                 30
             </session-timeout>
         </session-config>
     

<!-- Start Cocoon Section -->

         <servlet>
          <servlet-name>org.apache.cocoon.Cocoon</servlet-name>
          <servlet-class>org.apache.cocoon.Cocoon</servlet-class>
          <init-param>
           <param-name>properties</param-name>
           <param-value>
            cocoon.properties 
           </param-value>
          </init-param>
         </servlet>
         
         
         <servlet-mapping>
          <servlet-name>org.apache.cocoon.Cocoon</servlet-name>
          <url-pattern>*.xml</url-pattern>
         </servlet-mapping>

<!-- End Cocoon Section -->

     
         <mime-mapping>
             <extension>
                 txt
             </extension>
             <mime-type>
                 text/plain
             </mime-type>
         </mime-mapping>
     
     ..........
     
    

/usr/local/jakarta-tomcat/conf/tomcat-apache-cocoon.conf

      LoadModule jserv_module libexec/mod_jserv.so
      ApJServManual on
      ApJServDefaultProtocol ajpv12
      ApJServSecretKey DISABLED
      ApJServMountCopy on
      ApJServLogLevel notice
      
      ApJServDefaultPort 8007
      
      AddHandler jserv-servlet .xml
      
      AddType test/jsp .jsp
      AddHandler jserv-servlet .jsp
      Alias /examples /usr/local/jakarta-tomcat/webapps/examples
      <Directory "/usr/local/jakarta-tomcat/webapps/examples">
          Options Indexes FollowSymLinks
      </Directory>
      ApJServMount /examples/servlet /examples
      <Location /examples/WEB-INF/ >
          AllowOverride None
          deny from all
      </Location>
      
      Alias /test /usr/local/jakarta-tomcat/webapps/test
      <Directory "/usr/local/jakarta-tomcat/webapps/test">
          Options Indexes FollowSymLinks
      </Directory>
      ApJServMount /test/servlet /test
      <Location /test/WEB-INF/ >
          AllowOverride None
          deny from all
      </Location>
      
      Alias /admin /usr/local/jakarta-tomcat/webapps/admin
      <Directory "/usr/local/jakarta-tomcat/webapps/admin">
          Options Indexes FollowSymLinks
      </Directory>
      ApJServMount /admin/servlet /admin
      <Location /admin/WEB-INF/ >
          AllowOverride None
          deny from all
      </Location>
      
      Alias /samples /usr/local/jakarta-tomcat/webapps/samples
      <Directory "/usr/local/jakarta-tomcat/webapps/samples">
          Options Indexes FollowSymLinks
      </Directory>
      ApJServMount /samples/servlet /samples
      <Location /samples/WEB-INF/ >
          AllowOverride None
          deny from all
      </Location>
      
      Alias /gogo /usr/local/jakarta-tomcat/webapps/gogo
      <Directory "/usr/local/jakarta-tomcat/webapps/gogo">
          Options Indexes FollowSymLinks
      </Directory>
      ApJServMount /gogo/servlet /gogo
      <Location /gogo/WEB-INF/ >
          AllowOverride None
          deny from all
      </Location>
      
      ApJServMount /servlet /ROOT
 
    

/usr/local/jakarta-tomcat/conf/server.xml

      <?xml version="1.0" encoding="ISO-8859-1"?>
      
      <Server>
          <!-- Debug low-level events in XmlMapper startup -->
          <xmlmapper:debug level="0" />
      
          <!-- This is quite flexible; we can either have a log file per
               module in Tomcat (example: ContextManager) or we can have
               one for Servlets and one for Jasper, or we can just have
      	 one tomcat.log for both Servlet and Jasper.
      
      	 If you omit "path" there, then stderr should be used.
      
      	 verbosityLevel values can be: 
      	    FATAL
      	    ERROR
      	    WARNING 
                  INFORMATION
                  DEBUG
               -->
      
          <Logger name="tc_log" 
                  path="logs/tomcat.log"
                  customOutput="yes" />
      
          <Logger name="servlet_log" 
                  path="logs/servlet.log"
                  customOutput="yes" />
      
          <Logger name="JASPER_LOG" 
      	    path="logs/jasper.log"
                  verbosityLevel = "INFORMATION" />
      
          <!-- Add "home" attribute if you want tomcat to be based on a different directory
               "home" is used to create work and to read webapps, but not for libs or CLASSPATH.
               Note that TOMCAT_HOME is where tomcat is installed, while ContextManager home is the
               base directory for contexts, webapps/ and work/
            -->
          <ContextManager debug="0" workDir="work" >
              <!-- ContextInterceptor className="org.apache.tomcat.context.LogEvents" / -->
              <ContextInterceptor className="org.apache.tomcat.context.AutoSetup" />
              <ContextInterceptor className="org.apache.tomcat.context.DefaultCMSetter" />
              <ContextInterceptor className="org.apache.tomcat.context.WorkDirInterceptor" />
              <ContextInterceptor className="org.apache.tomcat.context.WebXmlReader" />
              <ContextInterceptor className="org.apache.tomcat.context.LoadOnStartupInterceptor" />
              <!-- Request processing -->
              <RequestInterceptor className="org.apache.tomcat.request.SimpleMapper" debug="0" />
              <RequestInterceptor className="org.apache.tomcat.request.SessionInterceptor" />
              <RequestInterceptor className="org.apache.tomcat.request.SecurityCheck" />
              <RequestInterceptor className="org.apache.tomcat.request.FixHeaders" />
      
              <Connector className="org.apache.tomcat.service.SimpleTcpConnector">
                  <Parameter name="handler" value="org.apache.tomcat.service.http.HttpConnectionHandler"/>
                  <Parameter name="port" value="8080"/>
              </Connector>
      
              <Connector className="org.apache.tomcat.service.SimpleTcpConnector">
                  <Parameter name="handler" value="org.apache.tomcat.service.connector.Ajp12ConnectionHandler"/>
                  <Parameter name="port" value="8007"/>
              </Connector>
      
          </ContextManager>
      </Server>

    

/usr/local/apache/conf/httpd.conf

     ...........
     #
     # VirtualHost example:
     # Almost any Apache directive may go into a VirtualHost container.
     #
     #<VirtualHost ip.address.of.host.some_domain.com>
     #    ServerAdmin webmaster@host.some_domain.com
     #    DocumentRoot /www/docs/host.some_domain.com
     #    ServerName host.some_domain.com
     #    ErrorLog logs/host.some_domain.com-error_log
     #    CustomLog logs/host.some_domain.com-access_log common
     #</VirtualHost>
     
     #<VirtualHost _default_:*>
     #</VirtualHost>
     
     include /usr/local/jakarta-tomcat/conf/tomcat-apache-cocoon.conf
     

Hints and Tips

Being bit of a XML/XSL/JAVA etc novice, here are some hints that I now know but it would have made life a lot easier if I knew them before I attempted Cocoon/Jakarta-Tomcat/Apache etc..

Regards - mark.evans@dsto.defence.gov.au

/usr/local/jakarta-tomcat/bin/tomcat.sh

      #!/bin/sh
      #
      # $Id: installation-case-solaris-8.xml,v 1.2 2000/09/19 23:01:44 greenrd Exp $
      
      # Shell script to start and stop the server
      
      # There are other, simpler commands to startup the runner. The two
      # commented commands good replacements. The first works well with
      # Java Platform 1.1 based runtimes. The second works well with
      # Java2 Platform based runtimes.
      
      TOMCAT_HOME=/usr/local/jakarta-tomcat
      
      JAVA_HOME=/usr/local/j2sdk1_3_0beta_refresh
      
      JAVACMD=/usr/local/j2sdk1_3_0beta_refresh/bin/java
      
      oldCP=$CLASSPATH
      
      CLASSPATH=$TOMCAT_HOME/classes
      
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/xerces_1_0_3.jar
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/xalan_1_0_1.jar
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/fop_0_12_1.jar
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/servlet_2_2.jar
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/cocoon.jar
      
      
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/webserver.jar
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/jasper.jar
      CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/xml.jar
      #CLASSPATH=$CLASSPATH:$TOMCAT_HOME/lib/servlet.jar
      CLASSPATH=$CLASSPATH:$JAVA_HOME/lib/tools.jar
      
      
      export CLASSPATH
      
      # We start the server up in the background for a couple of reasons:
      #   1) It frees up your command window
      #   2) You should use `stop` option instead of ^C to bring down the server
      if [ "$1" = "start" ] ; then
        shift
      #  echo Using classpath: ${CLASSPATH}
         
        echo __________________________
        echo Stopping Apache Web Server
        echo __________________________
        kill -TERM `cat /usr/local/apache/logs/httpd.pid` >/dev/null
      
        echo ______________________________________
        echo Starting Jakarta-Tomcat in a new shell
        echo ______________________________________
      
        $JAVACMD $TOMCAT_OPTS -Dtomcat.home=${TOMCAT_HOME}  org.apache.tomcat.startup.Tomcat "$@" &
      #   $JAVACMD org.apache.tomcat.shell.Startup "$@" &
      
        echo __________________________
        echo Starting Apache Web Server
        echo __________________________
        /usr/local/apache/bin/httpd -d /usr/local/apache 
      
      elif [ "$1" = "stop" ] ; then
        shift
      #  echo Using classpath: ${CLASSPATH}
      
        echo _______________________
        echo Stopping Jakarta-Tomcat
        echo _______________________
        $JAVACMD $TOMCAT_OPTS -Dtomcat.home=${TOMCAT_HOME} org.apache.tomcat.startup.Tomcat -stop "$@"
      #   $JAVACMD org.apache.tomcat.shell.Shutdown "$@"
      
      elif [ "$1" = "run" ] ; then
        shift
        echo Using classpath: ${CLASSPATH}
        $JAVACMD $TOMCAT_OPTS -Dtomcat.home=${TOMCAT_HOME} org.apache.tomcat.startup.Tomcat "$@"
      #  $JAVACMD org.apache.tomcat.shell.Startup "$@"
        # no &
      
      elif [ "$1" = "ant" ] ; then
        shift
      
        $JAVACMD $ANT_OPTS -Dant.home=${TOMCAT_HOME} -Dtomcat.home=${TOMCAT_HOME} org.apache.tools.ant.Main $@
      
      elif [ "$1" = "jspc" ] ; then
        shift
      
        $JAVACMD $JSPC_OPTS -Dtomcat.home=${TOMCAT_HOME} org.apache.jasper.JspC "$@"
      
      elif [ "$1" = "env" ] ; then
        ## Call it with source tomcat.sh to set the env for tomcat
        shift
        echo Setting classpath to: ${CLASSPATH}
        oldCP=$CLASSPATH
      
      else
        echo "Usage:"
        echo "tomcat (start|env|run|stop|ant)"
        echo "	start - start tomcat in the background"
        echo "	run   - start tomcat in the foreground"
        echo "	stop  - stop tomcat"
        echo "	env  -	set CLASSPATH and TOMCAT_HOME env. variables"
        echo "	ant  - run ant script in tomcat context ( classes, directories, etc)"
        echo "	jspc - run jsp pre compiler"
      
        exit 0
      fi


      if [ "$oldCP" != "" ]; then
          CLASSPATH=${oldCP}
          export CLASSPATH
      else
          unset CLASSPATH
      fi