[16.0.0.3 and later]

アプリケーション・エンドポイントの構成

Web アプリケーション・バンドル (WAB) を構成するために、WAB 構成ファイルが使用されます。WAB を構成するには、 OSGi サービスとして WABConfiguration が登録される必要があります。WABConfiguration は、メソッドのないマーカー・インターフェースです。WAB の構成は、サービス・プロパティー contextName および contextPath を使用して、WABConfiguration OSGi サービス登録によって指定されます。

このタスクについて

WAB は、OSGi バンドル・マニフェスト・ヘッダー Web-ContextPath を使用してコンテキスト・パスを指定します。WAB のコンテキスト・パスが構成可能であることを指定するには、Web-ContextPath ヘッダー値の先頭が @ 文字である必要があり、 先頭の @ 文字以外の内容が contextName として使用されます。次の例は、WAB の構成可能なコンテキスト・パスを示します。
Web-ContextPath: @myWABContextPath

手順

  1. コンテキスト・パスを構成するために contextName の値として myWABContextPath を使用して、WABConfiguration サービスを登録します。 宣言サービス・コンポーネントを使用できます。
    @Component(
     configurationPid = "my.wab.configuration",
     configurationPolicy = ConfigurationPolicy.REQUIRE)
     public class MyWABConfiguration implements WABConfiguration {
     	 // Only used to set "contextPath" and "contextName" service
    	 // properties from configuration admin using the pid
    	 // my.wab.configuration
     }
  2. metatype.xml ファイル内部に含まれる以下の XML は、サービス・コンポーネントの構成オプションを定義します。
    <metatype:MetaData xmlns:metatype="http://www.osgi.org/xmlns/metatype/v1.1.0" 
                       xmlns:ibm="http://www.ibm.com/xmlns/appservers/osgi/metatype/v1.0.0"
                       localization="OSGI-INF/l10n/metatype">
     
        <OCD description="My WAB Configuration" name="My WAB Configuration" 
             id="my.wab.configuration" ibm:alias="myWAB">
     
            <AD name="Context Path" description="The Context Path"
                id="contextPath" required="true" type="String" default="/default/path" />
            <AD name="internal" description="internal"
                id="contextName" ibm:final="true" type="String" default="myWABContextPath" />
        </OCD>
        
        <Designate pid="my.wab.configuration">
            <Object ocdref="my.wab.configuration"/>
        </Designate>
     </metatype:MetaData>
    このメタタイプは、contextNamecontextPath の両方のプロパティーのデフォルト値を指定します。追加の構成を何も指定しない場合、これらのデフォルト値が WAB コンテキスト・パスを構成するために使用されます。
    注: ID が contextName<AD> エレメントは、internal という名前であり、ibm:final を含んでいます。これは、サービス・コンポーネントにデフォルトが指定されることを許可しますが、 server.xml 構成内のデフォルトをオーバーライドすることは許可されません。次に、 以下の server.xml 構成エレメントを使用して、WAB コンテキスト・パスを構成できます。
    <usr_myWAB contextPath="/myWab/path"/>

    WABCconfiguration コンポーネントを含むバンドルが usr フィーチャーとしてインストールされる場合、usr_ 接頭部が必要です。バンドルが製品拡張と共にインストールされる場合、接頭部は製品名であり、その後に _ 文字が続きます。製品拡張について詳しくは、製品拡張を参照してください。


トピックのタイプを示すアイコン タスク・トピック

ファイル名: twlp_config_app_endpoint.html