deployer/trunk/src/main/java/jp/gr/java_conf/uguu/deployer/DeployerListener.java

   1 \r
   2 package jp.gr.java_conf.uguu.deployer;\r
   3 \r
   4 import java.io.File;\r
   5 \r
   6 /**\r
   7  * <p>\r
   8  * {@link Deployer}クラスによるファイル配置のイベントを受け取るリスナーです。\r
   9  * </p>\r
  10  * \r
  11  * @author uguu\r
  12  */\r
  13 public interface DeployerListener {\r
  14 \r
  15     /**\r
  16      * <p>\r
  17      * アーカイブ・ファイルの配置を開始するときに呼び出されます。\r
  18      * </p>\r
  19      * \r
  20      * @param deployer\r
  21      *            イベントの通知元の{@link Deployer}インスタンス。\r
  22      * @param file\r
  23      *            配置するアーカイブ・ファイル。\r
  24      */\r
  25     void deployStart(Deployer deployer, File file);\r
  26 \r
  27     /**\r
  28      * <p>\r
  29      * アーカイブ・ファイルから抽出したファイルを配置するときに呼び出されます。\r
  30      * </p>\r
  31      * \r
  32      * @param deployer\r
  33      *            イベントの通知元の{@link Deployer}インスタンス。\r
  34      * @param file\r
  35      *            配置するアーカイブ・ファイル。\r
  36      * @param destDirectory\r
  37      *            配置先のルート・ディレクトリ。\r
  38      * @param deployFile\r
  39      *            配置するファイル。\r
  40      */\r
  41     void deployFile(Deployer deployer, File file, File destDirectory, File deployFile);\r
  42 \r
  43     /**\r
  44      * <p>\r
  45      * アーカイブ・ファイルの配置が終了したときに呼び出されます。\r
  46      * </p>\r
  47      * \r
  48      * @param deployer\r
  49      *            イベントの通知元の{@link Deployer}インスタンス。\r
  50      * @param file\r
  51      *            配置したアーカイブ・ファイル。\r
  52      * @param destDirectory\r
  53      *            配置先のルート・ディレクトリ。\r
  54      */\r
  55     void deployEnd(Deployer deployer, File file, File destDirectory);\r
  56 \r
  57     /**\r
  58      * <p>\r
  59      * アーカイブ・ファイルの配置の解除を開始するときに呼び出されます。\r
  60      * </p>\r
  61      * \r
  62      * @param deployer\r
  63      *            イベントの通知元の{@link Deployer}インスタンス。\r
  64      * @param file\r
  65      *            配置解除するアーカイブ・ファイル。\r
  66      * @param destDirectory\r
  67      *            配置先のルート・ディレクトリ。\r
  68      */\r
  69     void undeployStart(Deployer deployer, File file, File destDirectory);\r
  70 \r
  71     /**\r
  72      * アーカイブ・ファイルの配置の解除が終了したときに呼び出されます。\r
  73      * \r
  74      * @param deployer\r
  75      *            イベントの通知元の{@link Deployer}インスタンス。\r
  76      * @param file\r
  77      *            配置解除したアーカイブ・ファイル。\r
  78      */\r
  79     void undeployEnd(Deployer deployer, File file);\r
  80 \r
  81 }\r