FTP

Description

説明

The ftp task implements a basic FTP client that can send, receive, list, delete files, and create directories. See below for descriptions and examples of how to perform each task.

ftp タスクでは、 ファイル送信、取得、ファイル一覧、ファイル削除、ディレクトリ作成の可能な、 基本的な ftp クライアントを実装しています。 それぞれのタスクの実行方法は後述の説明と、例をご覧ください。

Note: This task depends on external libraries not included in the Ant distribution. See Library Dependencies for more information.

メモ: このタスクは Ant のディストリビューションに含まれていない外部ライブラリに依存しています。 詳しくは ライブラリ依存関係をご覧ください。

The ftp task makes no attempt to determine what file system syntax is required by the remote server, and defaults to Unix standards. remotedir must be specified in the exact syntax required by the ftp server. If the usual Unix conventions are not supported by the server, separator can be used to set the file separator that should be used instead.

ftp タスクは、 接続先サーバーから、どのようなファイルシステム記述を返すか判断はせず、デフォルトは Unix の標準となっています。 remotedir は ftp サーバーにおいｔ正確な記述をしなければなりません。 対象とするサーバーにおいて、通常のUnixの規約がサポートされていない場合には、 代わりに使われるファイル区分子を指定するためにseparator が使えます。

See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns.

ファイルを含めたり、除外したりするのは、どのような仕組みになっているか、 および、 パターンの記述法についてはディレクトリベースのタスクの節をご覧ください。

Warning: for the get and delete actions to work properly with a Windows 2000 ftp server, it needs to be configured to generate Unix style listings, and not the default MS-DOS listing. Or someone needs to write the code to parse MS-DOS listings -any takers?

注意: Windows 2000 ftp サーバーで get と delete を正しく動作させるには、 デフォルトのMS-DOS形式ではなく、 Unix 形式のファイル一覧を生成するよう設定しなければなりません。 あるいは、誰かがMS-DOS 形式のファイル一覧をパージングするコードを記述する必要がります。誰かやってくれる人いませんか。

Parameters

パラメータ

Sending Files

ファイルの送信

The easiest way to describe how to send files is with a couple of examples:

ファイル送信を記述する最も簡単な方法は、幾つかの例で示します:

  <ftp server="ftp.apache.org"
       userid="anonymous"
       password="me@myorg.com">
    <fileset dir="htdocs/manual"/>
  </ftp>

Logs in to ftp.apache.org as anonymous and uploads all files in the htdocs/manual directory to the default directory for that user.

ftp.apache.orgにanonymousでログインし、 htdocs/manualディレクトリにある全てのファイルを そのユーザのデフォルトディレクトリにアップロードします。

  <ftp server="ftp.apache.org"
       remotedir="incoming"
       userid="anonymous"
       password="me@myorg.com"
       depends="yes"
  >
    <fileset dir="htdocs/manual"/>
  </ftp>

Logs in to ftp.apache.org as anonymous and uploads all new or changed files in the htdocs/manual directory to the incoming directory relative to the default directory for anonymous.

ftp.apache.orgにanonymousでログインし、 htdocs/manualディレクトリにある新規の、あるいは更新のあった全てのファイルをそのユーザのデフォルトディレクトリに対する 相対ディレクトリincomingにアップロードします。

  <ftp server="ftp.apache.org"
       port="2121"
       remotedir="/pub/incoming"
       userid="coder"
       password="java1"
       depends="yes"
       binary="no"
  >
    <fileset dir="htdocs/manual">
      <include name="**/*.html"/>
    </fileset>
  </ftp>

Logs in to ftp.apache.org at port 2121 as coder with password java1 and uploads all new or changed HTML files in the htdocs/manual directory to the /pub/incoming directory. The files are transferred in text mode. Passive mode has been switched on to send files from behind a firewall.

ftp.apache.orgの2121番ポートに、 ユーザcoder、パスワードjava1でログインし、 htdocs/manualディレクトリにある新規の、あるいは更新のあった全ての HTML ファイルを /pub/incoming ディレクトリにアップロードします。 ファイルはテキストモードで転送されます。 ファイヤーウォール内からファイルを送るためにパッシブモードにします。

  <ftp server="ftp.nt.org"
       remotedir="c:\uploads"
       userid="coder"
       password="java1"
       separator="\"
       verbose="yes"

  >
    <fileset dir="htdocs/manual">
      <include name="**/*.html"/>
    </fileset>
  </ftp>

Logs in to the Windows-based ftp.nt.org as coder with password java1 and uploads all HTML files in the htdocs/manual directory to the c:\uploads directory. Progress messages are displayed as each file is uploaded.

Windowsベースのftp.nt.orgに、 ユーザcoder、パスワードjava1でログインし、 htdocs/manualディレクトリにある新規の、 あるいは更新のあった全ての HTML ファイルを c:\uploads ディレクトリにアップロードします。 個々のファイルがアップロードされる際に進捗メッセージが表示されます。

Getting Files

ファイルの取得

Getting files from an FTP server works pretty much the same way as sending them does. The only difference is that the nested filesets use the remotedir attribute as the base directory for the files on the FTP server, and the dir attribute as the local directory to put the files into. The file structure from the FTP site is preserved on the local machine.

FTPサーバーからファイルを取得するのは、 ファイルの送信とほとんど同じ方法で動作します。 唯一の違いは、 ネストするファイルセットが、 FTP サーバー上のファイルのためのベースディレクトリとして、 remotedir 属性を使い、 FTPサイトからのファイル構造はローカルマシンに保持されます。

  <ftp action="get"
       server="ftp.apache.org"
       userid="anonymous"
       password="me@myorg.com">
    <fileset dir="htdocs/manual" >
      <include name="**/*.html"/>
    </fileset>
  </ftp>

Logs in to ftp.apache.org as anonymous and recursively downloads all .html files from default directory for that user into the htdocs/manual directory on the local machine.

ftp.apache.orgにログインし、 そのユーザのデフォルトディレクトリから、 再帰的に全ての .html ファイルを ローカルマシンの htdocs/manualディレクトリにダウンロードします。

Deleting Files

ファイルの削除

As you've probably guessed by now, you use nested fileset elements to select the files to delete from the remote FTP server. Again, the filesets are relative to the remote directory, not a local directory. In fact, the dir attribute of the fileset is ignored completely.

今、あなたが想像している通り、 リモートのFTPサーバーから削除するファイルを選択するのに、 ネストした fileset 要素が使えます。 繰り返しになりますが、 fileset はリモートディレクトリからの相対パス、ローカルディレクトリからではありません。 実際にファイルセットのdir 属性は完全に無視されます。

  <ftp action="del"
       server="ftp.apache.org"
       userid="anonymous"
       password="me@myorg.com" >
    <fileset>
      <include name="**/*.tmp"/>
    </fileset>
  </ftp>

Logs in to ftp.apache.org as anonymous and tries to delete all *.tmp files from the default directory for that user. If you don't have permission to delete a file, a BuildException is thrown.

anonymousアカウントで ftp.apache.orgにログインし、 そのユーザのデフォルトディレクトリの全ての *.tmp ファイルを削除しようと試みます。 あるファイルの削除の権限が無い場合、 BuildException がスローされます。

Listing Files

ファイルのリスト取得

  <ftp action="list"
       server="ftp.apache.org"
       userid="anonymous"
       password="me@myorg.com" 
       listing="data/ftp.listing" >
    <fileset>
      <include name="**"/>
    </fileset>
  </ftp>

This provides a file listing in data/ftp.listing of all the files on the FTP server relative to the default directory of the anonymous user. The listing is in whatever format the FTP server normally lists files.

これは、 FTP サーバーの anonymousユーザのデフォルトディレクトリの ファイル一覧を data/ftp.listingに出力します。 このリスト形式は FTP サーバーが通常ファイルのリストを生成する形式です。

Creating Directories

ディレクトリの生成

Note that with the mkdir action, the directory to create is specified using the remotedir attribute.

mkdir アクションにおいて、 生成するディレクトリはremotedir 属性を用いて指定されることに注意してください。

  <ftp action="mkdir"
       server="ftp.apache.org"
       userid="anonymous"
       password="me@myorg.com" 
       remotedir="some/remote/dir" />

This creates the directory some/remote/dir beneath the default root directory. As with all other actions, the directory separator character must be correct according to the desires of the FTP server.

これは、 デフォルトルートディレクトリの下に、 some/remote/dirディレクトリを作成します。 他の全てのアクションと同様に、 ディレクトリの区分文字は FTP サーバーが要求するものに従って正しくなければなりません。

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