KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jonas > ant > HotDeploymentTool


1 /**
2  * Copyright 2002-2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 package org.objectweb.jonas.ant;
18
19 import org.apache.tools.ant.BuildException;
20
21 /**
22  * An interface for vendor-specific "hot" deployment tools.
23  * @see org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
24  * @see org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
25  */
26 public interface HotDeploymentTool {
27
28     /**
29      * The delete action String
30      */
31     String JavaDoc ACTION_DELETE = "delete";
32
33     /**
34      * The deploy action String
35      */
36     String JavaDoc ACTION_DEPLOY = "deploy";
37
38     /**
39      * The list action String
40      */
41     String JavaDoc ACTION_LIST = "list";
42
43     /**
44      * The undeploy action String
45      */
46     String JavaDoc ACTION_UNDEPLOY = "undeploy";
47
48     /**
49      * The update action String
50      */
51     String JavaDoc ACTION_UPDATE = "update";
52
53     /**
54      * Validates the passed in attributes.
55      * @exception org.apache.tools.ant.BuildException if the attributes are
56      * invalid or incomplete.
57      */
58     void validateAttributes() throws BuildException;
59
60     /**
61      * Perform the actual deployment.
62      * @exception org.apache.tools.ant.BuildException if the attributes are
63      * invalid or incomplete.
64      */
65     void deploy() throws BuildException;
66
67     /**
68      * Sets the parent task.
69      * @param task A ServerDeploy object representing the parent task.
70      */
71     void setTask(ServerDeploy task);
72 }
Popular Tags