| 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.apache.tools.ant.taskdefs.optional.j2ee;
|
|---|
| 18 |
|
|---|
| 19 | import org.apache.tools.ant.BuildException;
|
|---|
| 20 |
|
|---|
| 21 | /**
|
|---|
| 22 | * An interface for vendor-specific "hot" deployment tools.
|
|---|
| 23 | *
|
|---|
| 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 | public static final String ACTION_DELETE = "delete";
|
|---|
| 31 |
|
|---|
| 32 | /** The deploy action String **/
|
|---|
| 33 | public static final String ACTION_DEPLOY = "deploy";
|
|---|
| 34 |
|
|---|
| 35 | /** The list action String **/
|
|---|
| 36 | public static final String ACTION_LIST = "list";
|
|---|
| 37 |
|
|---|
| 38 | /** The undeploy action String **/
|
|---|
| 39 | public static final String ACTION_UNDEPLOY = "undeploy";
|
|---|
| 40 |
|
|---|
| 41 | /** The update action String **/
|
|---|
| 42 | public static final String 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 | public 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 | public void deploy() throws BuildException;
|
|---|
| 55 |
|
|---|
| 56 | /**
|
|---|
| 57 | * Sets the parent task.
|
|---|
| 58 | * @param task A ServerDeploy object representing the parent task.
|
|---|
| 59 | */
|
|---|
| 60 | public void setTask(ServerDeploy task);
|
|---|
| 61 | }
|
|---|
