KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tools > ant > taskdefs > optional > ejb > EJBDeploymentTool


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
19 package org.apache.tools.ant.taskdefs.optional.ejb;
20
21
22
23 import javax.xml.parsers.SAXParser JavaDoc;
24 import org.apache.tools.ant.BuildException;
25 import org.apache.tools.ant.Task;
26
27
28 /**
29  * The interface to implement for deployment tools.
30  */
31 public interface EJBDeploymentTool {
32     /**
33      * Process a deployment descriptor, generating the necessary vendor specific
34      * deployment files.
35      *
36      * @param descriptorFilename the name of the deployment descriptor
37      * @param saxParser a SAX parser which can be used to parse the deployment descriptor.
38      * @throws BuildException if there is an error.
39      */
40     void processDescriptor(String JavaDoc descriptorFilename, SAXParser JavaDoc saxParser)
41         throws BuildException;
42
43     /**
44      * Called to validate that the tool parameters have been configured.
45      * @throws BuildException if there is an error.
46      */
47     void validateConfigured() throws BuildException;
48
49     /**
50      * Set the task which owns this tool
51      * @param task the task.
52      */
53     void setTask(Task task);
54
55     /**
56      * Configure this tool for use in the ejbjar task.
57      * @param config contains configuration state.
58      */
59     void configure(EjbJar.Config config);
60 }
61
Popular Tags