KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tools > ant > taskdefs > optional > j2ee > HotDeploymentTool


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