ナビゲーション・ヘッダーをスキップ
Oracle Help for the Web開発者ガイド Table of Contents
目次
Previous topic
前へ
Next topic
次へ

デプロイ・バンドルを使用したTomcatでのOHWのデプロイ

TomcatはApache Software Foundation(http://jakarta.apache.org/)のJakartaプロジェクトで開発されたJavaサーブレット・エンジンです。 Tomcatの最新バージョン、Tomcat 4.0では、サーブレットAPIのバージョン2.3をサポートします。この項では、Tomcatサーブレット・エンジンでOracle Help for the Web(OHW)ヘルプセットをデプロイする方法を説明します。

このページでは、次の項目について説明します。

Apache Tomcatのインストールおよび実行

TomcatにはOHWのダウンロード・ファイルが含まれていないので、取得してインストールする必要があります。Tomcatのインストールおよび構成方法の完全な説明は、Tomcatのドキュメントを参照してください。しかし、Tomcatのインストールは、通常きわめて簡単です。

  1. Tomcatをダウンロードします。TomcatのバイナリはApache JakartaのWebサイト(http://jakarta.apache.org/tomcat/index.html)から入手できます。ファイル名はjakarta-tomcat-nnn.zip(本稿執筆時)で、nnnはリリース番号です。

  2. jakarta-tomcat-nnn.zipファイルを、ホスト・コンピュータのTomcatをインストールする場所に解凍します。デフォルトでは、jakarta-tomcat-nnnの下にディレクトリ構造が作成されます。

    注意: 以降このページでは、このディレクトリ名をjakarta-tomcatとします。

  3. JAVA_HOME環境変数をJDK 1.2以上がインストールされているホストのディレクトリに設定していることを確認してください。(Tomcat 4.0にはJDK 1.2以上が必須です。)

  4. サーバーを起動するために、Tomcat起動バッチ・ファイルを実行するか、またはjakarta-tomcat/binディレクトリから次のスクリプトを実行します。

  5. ブラウザにhttp://<hostname>:8080/と入力します。ここで<hostname>はTomcatがインストールされているマシンの名前です。

    Tomcatの初期画面ページがブラウザに表示されます。ネットワークに接続した場合、これと同じURLに移動することで、リモート・コンピュータでもブラウザに同じコンテンツが表示されます。

    TomcatがインストールされているコンピュータでTomcatを表示する場合、ブラウザの構成によってはhttp://localhost:8080/というURLも使用できます。しかし、リモート・コンピュータでこれを表示する場合、コンテンツを表示するにはホスト名を使用する必要があります。

サーバーを停止するために、Tomcatのシャットダウン・バッチ・ファイルを実行するか、またはjakarta-tomcat/binディレクトリから次のスクリプトを実行します。

OHWのインストールおよびTomcatの構成

次の手順に従う前に、「Apache Tomcatのインストールおよび実行」で前述したとおり、Apache Tomcatをインストールする必要があります。

  1. OHWデプロイ・バンドルをOracle Technology Network(http://otn.oracle.com/tech/java/help/content.html)からダウンロードします。デプロイ・バンドルのファイル名はohw-deploy-nnn.zipで、nnnはOHWのリリース番号です。このファイルには、多数のJava ARchive(JAR)依存性ファイル、web.xmlファイルおよびohwconfig.xmlファイル、2つのZIPファイルすなわちohw-install.zipおよびuix2-install.zipが含まれています。

  2. ohw-deploy-nnn.zipを一時的な場所に解凍します。

  3. Tomcatインストールのjakarta-tomcat/webapps/ディレクトリの下に、次の新規サブディレクトリを作成します。

    注意: WEB-INFは必ずすべて大文字です。ohwはすべて小文字です。

  4. OHWサーブレットをインストールするために、ohw-deploy-nnn.zipを解凍して取得したすべてのJARファイルをjakarta-tomcat/libディレクトリに配置します。ファイルは次のとおりです。


  5. ohw-install.zipjakarta-tomcat/webapps/ohwディレクトリに解凍します。これによりjsLibsというサブディレクトリが作成され、OHWのJavaScriptファイルが、たとえば次のようなディレクトリに格納されます。

    
     jakarta-tomcat/webapps/ohw/jsLibs/<files>
    
  6. uix2-install.zipをjakarta-tomcat/webapps/ohwディレクトリに解凍します。これによりcaboディレクトリ構造が作成され、画像、スクリプトおよびスタイルシートなどの、インストール可能なUIXリソース・ファイルが次のサブディレクトリに格納されます。

    
     jakarta-tomcat/webapps/ohw/cabo/images/<files>
     jakarta-tomcat/webapps/ohw/cabo/jsLibs/<files>
     jakarta-tomcat/webapps/ohw/cabo/jsps/<files>
     jakarta-tomcat/webapps/ohw/cabo/styles/<files>
    

    注意: インストール可能なUIXリソース・ファイルを複数のWebモジュールで共有するための設定方法は、「共有するインストール可能なUIXリソース・ファイルの設定」を参照してください。

  7. OHWヘルプ・システムを構成するファイルをjakarta-tomcat/webapps/ohw/helpsetsに配置するか、またはohw/helpsetsの下にサブディレクトリを作成してその中に配置します。たとえば、myProductおよびotherProductという2つの製品がある場合、次が作成できます。

    ヘルプセット・ファイル、トピック(HTML)ファイルおよびその他の制御ファイル(索引、目次など)を含むすべてのヘルプ・ファイルを、このディレクトリに配置します。これらのファイルの詳細は、「ファイルについて」を参照してください。ヘルプセットにJARファイルを使用している場合は、JARファイルもここに配置します。(JAR形式および非JAR形式のヘルプセットを、同じデプロイで使用できます。)

  8. ohwconfig.xmlファイルを作成し、OHWを構成します。このファイルをjakarta-tomcat/webapps/ohw/helpsets/ディレクトリに配置します。ohw-deploy-nnn.zipファイルにはサンプル・ファイルが含まれています。

    特にこのファイルは、OHWで使用するヘルプセットおよびヘルプ・トピックHTMLファイルが格納されている場所を定義します。<books>要素には、任意の数のヘルプセットまたはHelpBook、または両方の組合せを含めることができます。ヘルプセットは実行時にマージされるので、複数の作成者が複数のヘルプセットを作成した場合でも、それらをシームレスにマージできます。マージの動作はcombineBooks属性およびuseLabelInfo属性によって指定されます。<helpSet>要素には、0個以上の<contentLocation>要素を含めることができます。<contentLocation>要素は、Oracle Helpで使用する一連のヘルプ・トピックHTMLファイルのルート位置を指定するために使用されます。ohwconfig.xmlファイルの詳細は、「OHW構成ファイル」を参照してください。

    編集の例:

     <books combineBooks="false" useLabelInfo="true">
        <helpSet location="myProduct/myProduct.hs" />
        <helpSet jar="otherProduct/otherProduct.jar" location="otherProduct.hs" />
     </books>
    
  9. web.xmlファイルをjakarta-tomcat/webapps/ohw/WEB-INFディレクトリに作成します。ohw-deploy-nnn.zipファイルにはサンプルweb.xmlファイルが含まれています。Tomcatとともに使用する前に、このファイルを編集する必要があります。web.xmlをテキスト・エディタで開き、次の3行を削除します。

     <login-config>
        <auth-method>BASIC</auth-method>
     </login-config>
    

    最終的なweb.xmlは次のサンプルXMLファイルに近似しているはずです。このweb.xmlはohwconfig.xmlファイルがjakarta-tomcat/webapps/ohw/helpsets/ディレクトリにあるかぎり使用できます。

    web.xmlファイルの例:

     <?xml version="1.0"?>
     <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
     "http://java.sun.com/j2ee/dtds/web-app_2_3.dtd">
    
     <web-app>
    
        <servlet>
    
           <servlet-name>OHW</servlet-name>
           <servlet-class>oracle.help.OHW</servlet-class>
    
           <init-param>
              <param-name>configFileName</param-name>
              <param-value>/helpsets/ohwconfig.xml</param-value>
           </init-param>
    
        </servlet>
    
        <servlet-mapping>
           <servlet-name>OHW</servlet-name>
           <url-pattern>/help/*</url-pattern>
        </servlet-mapping>
    
     </web-app>

    <servlet-mapping>パラメータの<url-pattern>は、OHWへのアクセスに使用されるURLを指定します。たとえば、<url-pattern>をデフォルトの/help/*から/onlinereference/*に変更した場合、OHWへのアクセスに使用されるURLはhttp://<hostname>:8080/ohw/onlinereference/になります。

    次のパラメータは、OHW構成ファイル(ohwconfig.xml)の場所を指定します。

    
     <init-param>
       <param-name>configFileName</param-name>
       <param-value>/helpsets/ohwconfig.xml</param-value>
     </init-param>
    

    構成ファイルのパスはサーブレットのコンテキスト・パスの相対位置に指定されます。ほとんどのユーザーは、このパラメータを変更しないことをお薦めします。

インストールのテスト

次の手順に従って、ヘルプをOHWで表示します。

  1. 前述の「Apache Tomcatのインストールおよび実行」のステップ4で説明されているように、startup.batまたはstartup.shを実行してTomcatを起動します。

  2. ブラウザにhttp://<hostname>:8080/ohw/help/と入力します。

    注意: 最後のスラッシュ(/)は必須です。

    TomcatがインストールされているコンピュータでTomcatを表示する場合、ブラウザの構成によってはhttp://localhost:8080/ohw/help/というURLも使用できます。

    ページが予定したように表示されない場合、Tomcatによるエラー・メッセージのログがないかどうか、コンソール・ウィンドウをチェックしてください。 Tomcatは、jakarta-tomcat/logsの下のログ・ファイルにもエラー・メッセージを記録します。

共有するインストール可能なUIXリソース・ファイルの設定

複数のアプリケーションでインストール可能なUIXリソース・ファイルの1つのセットを共有するには、UIXリソース・ファイルをTomcatインストールのwebapps/ROOTディレクトリにインストールします。

  1. uix2-install.zipをjakarta-tomcat/webapps/ROOTディレクトリに解凍します。これによりcaboサブディレクトリが作成され、画像、スクリプトおよびスタイルシートなどの、インストール可能なUIXリソース・ファイルがサブディレクトリに格納されます。

  2. jakarta-tomcat/webapps/ROOT/cabo/WEB-INFディレクトリを作成し、次のコンテンツをweb.xmlファイルにコピーします。

    UIXリソース・ファイルに使用されるweb.xmlファイルの例:

     <?xml version="1.0"?>
     <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
     "http://java.sun.com/j2ee/dtds/web-app_2_3.dtd">
    
     <web-app>
     </web-app>

    web.xmlファイルは基本的に空ですが、UIXのWebモジュールをデプロイするために必要です。

  3. Tomcat Catalinaバッチ・ファイルを変更するか、システム・プロパティのoracle.cabo.ui.sharedContextPathを介してインストール可能なUIXリソース・ファイルの場所が指定されるように、jakarta-tomcat/binディレクトリのスクリプトを変更します。

    編集の例:

    %_EXECJAVA% %JAVA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -
    Doracle.cabo.ui.sharedContextPath=\jakarta-tomcat\webapps\ROOT -
    Djava.endorsed.dirs="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -
    Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -
    Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION%
  4. Webアプリケーション(たとえばjakarta-tomcat/webapps/ohw/cabo)にある、インストール可能なUIXリソース・ファイルのプライベート・コピーをすべて削除します。

OHWおよびUIXのアップグレード

OHW/Tomcatインストールをアップグレードする前に、最新のダウンロードとインストール方法を、OHWのダウンロード・ページでチェックしてください。

注意: アップグレードの前にTomcat/OHWインスタンスを停止してください。OHWおよびUIXをアップグレードした後Tomcat/OHWを再起動してください。

OHWをアップグレードするには、OHWおよびUIXのJARファイル、およびOHWのJavaScriptファイル(ohw-install.zipとして配布)を置き換える必要があります。次の手順に従って、OHWを新しいリリースにアップグレードしてください。

  1. 前述の「OHWのインストールおよびTomcatの構成」のステップ4を繰り返します。これによりOHWおよびUIXのJARファイルが更新されます。

  2. 前述の「OHWのインストールおよびTomcatの構成」のステップ5を繰り返します。これによりohw-install.zipが解凍され、jakarta-tomcat/webapps/ohw/jsLibsディレクトリにあるOHWのJavaScriptファイルが更新されます。

UIXをアップグレードするには、インストール可能なUIXリソース・ファイル(uix2-install.zipとして配布)を置き換える必要があります。インストール可能なUIXリソース・ファイルを新しいリリースにアップグレードするには、次の1つを行います。