War

Description

説明

An extension of the Jar task with special treatment for files that should end up in the WEB-INF/lib, WEB-INF/classes or WEB-INF directories of the Web Application Archive.

最終的に、 ウェブアプリケーションアーカイブの WEB-INF/libWEB-INF/classes、または、 WEB-INF ディレクトリに置かれるファイルのための特別な処理を行う Jarタスクの拡張です。

(The War task is a shortcut for specifying the particular layout of a WAR file. The same thing can be accomplished by using the prefix and fullpath attributes of zipfilesets in a Zip or Jar task.)

(war タスクは WAR ファイルの特別な配置を指定するためのショートカットです。 zip や jar タスクで、 同じことは prefix および fullpath属性を使ってもできます。)

The extended zipfileset element from the zip task (with attributes prefix, fullpath, and src) is available in the War task.

war タスクでは、 zip タスクから拡張されたの zipfileset 要素が (prefixfullpathsrc属性をつけて) 利用可能です。

Parameters

パラメータ

Attribute Description Required
destfile the WAR file to create. Yes
warfile Deprecated name of the file to create -use destfile instead. No
webxml The deployment descriptor to use (WEB-INF/web.xml). Yes, unless update is set to true
basedir the directory from which to jar the files. No
compress Not only store data but also compress them, defaults to true No
encoding The character encoding to use for filenames inside the archive. Defaults to UTF8. It is not recommended to change this value as the created archive will most likely be unreadable for Java otherwise. No
filesonly Store only file entries, defaults to false No
includes comma- or space-separated list of patterns of files that must be included. All files are included when omitted. No
includesfile the name of a file. Each line of this file is taken to be an include pattern No
excludes comma- or space-separated list of patterns of files that must be excluded. No files (except default excludes) are excluded when omitted. No
excludesfile the name of a file. Each line of this file is taken to be an exclude pattern No
defaultexcludes indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted. No
manifest the manifest file to use. No
update indicates whether to update or overwrite the destination file if it already exists. No
属性 説明 必須
destfile 作成する war ファイル Yes
warfile 非推奨 作成するファイルの名前 - 代わりにdestfileを使ってください No
webxml (WEB-INF/web.xml)で利用するための配備記述子 update が true に設定されていない限り Yes
basedir jar ファイルの作成対象のトップディレクトリ No
compress データを格納するだけでなく圧縮するか。 デフォルトは true No
encoding アーカイブ中のファイル名に使われる文字エンコーディング。 デフォルトは UTF8。 生成されたアーカイブがJava 以外で読めなくなる可能性があるので、 この値を変更することは推奨されません。 No
filesonly ファイルエントリのみ格納します。 デフォルトは false No
includes カンマあるいは空白で区切られた含められるファイルのパターンのリスト。 省略された場合全てのファイルが含められる。 No
includesfile ファイルの名前; このファイルの各行が includes パターンとして扱われる No
excludes カンマあるいは空白で区切られた除外するファイルのパターンのリスト。 省略された場合、(デフォルト除外ファイルを除き)何も除外しない。 No
excludesfile ファイルの名前; このファイルの各行が excludes パターンとして扱われる No
defaultexcludes デフォルト除外パターンを使うかどうか指定します。 (yes | no); 省略された場合デフォルト除外パターンは使われます。 No
manifest 使用されるマニフェストファイル No
update 既に出力先ファイルが存在する場合、 出力先ファイルを 更新するか上書きするかを示す。 No

Nested elements

ネストされる要素

lib

The nested lib element specifies a FileSet. All files included in this fileset will end up in the WEB-INF/lib directory of the war file.

ネストされるlib要素は、 ファイルセットを指定します。 このファイルセットに含まれる全てのファイルは、 war ファイルの WEB-INF/lib ディレクトリに入ることになります。

classes

The nested classes element specifies a FileSet. All files included in this fileset will end up in the WEB-INF/classes directory of the war file.

ネストされる classes 要素は、 ファイルセットを指定します。 このファイルセットに含まれる全てのファイルは、 war ファイルの WEB-INF/classes ディレクトリに入ることになります。

webinf

The nested webinf element specifies a FileSet. All files included in this fileset will end up in the WEB-INF directory of the war file. If this fileset includes a file named web.xml, the file is ignored and you will get a warning.

ネストされるwebinf要素は、 ファイルセットを指定します。 このファイルセットに含まれる全てのファイルは、 war ファイルのWEB-INFディレクトリに入ることになります。 このファイルセットに web.xml という名前のファイルが含まれていた場合、そのファイルは無視され、警告が表示されます。

metainf

The nested metainf element specifies a FileSet. All files included in this fileset will end up in the META-INF directory of the war file. If this fileset includes a file named MANIFEST.MF, the file is ignored and you will get a warning.

ネストされた metainf 要素は、 ファイルセットを指定します。 このファイルセットに含まれる全てのファイルは、 war ファイルのMETA-INFディレクトリに入ることになります。 このファイルセットにMANIFEST.MFという名前のファイルが含まれていた場合、そのファイルは無視され、警告が表示されます。

Examples

Assume the following structure in the project's base directory:

プロジェクトのベースディレクトリに次のファイル構造があると仮定します。

thirdparty/libs/jdbc1.jar
thirdparty/libs/jdbc2.jar
build/main/com/myco/myapp/Servlet.class
src/metadata/myapp.xml
src/html/myapp/index.html
src/jsp/myapp/front.jsp
src/graphics/images/gifs/small/logo.gif
src/graphics/images/gifs/large/logo.gif

then the war file myapp.war created with

この時、myapp.war war ファイルは次により生成されます。

<war destfile="myapp.war" webxml="src/metadata/myapp.xml">
  <fileset dir="src/html/myapp"/>
  <fileset dir="src/jsp/myapp"/>
  <lib dir="thirdparty/libs">
    <exclude name="jdbc1.jar"/>
  </lib>
  <classes dir="build/main"/>
  <zipfileset dir="src/graphics/images/gifs" 
              prefix="images"/>
</war>

will consist of

アーカイブには次のファイルが含まれています

WEB-INF/web.xml
WEB-INF/lib/jdbc2.jar
WEB-INF/classes/com/myco/myapp/Servlet.class
META-INF/MANIFEST.MF
index.html
front.jsp
images/small/logo.gif
images/large/logo.gif

using Ant's default manifest file. The content of WEB-INF/web.xml is identical to src/metadata/myapp.xml.

ここでは、Ant のデフォルトマニフェストファイルを使っています。 WEB-INF/web.xmlの内容は、 src/metadata/myapp.xmlと全く同じです。


Copyright © 2000-2002 Apache Software Foundation. All rights Reserved.

[訳注:これは漆島賢二が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]