AntDeploymentProvider


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  
21  package org.netbeans.modules.j2ee.deployment.plugins.api;
22  
23  import java.io.File  ;
24  import java.io.IOException  ;
25  import java.io.OutputStream  ;
26  
27  /**
28   * This interface represents a "provider" for the Ant deployment.
29   * <p>
30   * The j2eeserver uses {@link OptionalDeploymentManagerFactory} to optains an 
31   * instance of the AntDeploymentProvider from the server integration plugin.
32   *
33   * @author sherold
34   *
35   * @since 1.18
36   */
37  public interface AntDeploymentProvider {
38      
39      /**
40       * Generates the Ant deployment build script for the given module type to 
41       * the specified output stream.
42       * <p>
43       * See {@link org.netbeans.modules.j2ee.deployment.devmodules.api.AntDeploymentHelper#writeDeploymentScript(File,Object,String)}
44       * for what targets and properties is the Ant deployment build script required 
45       * to define and what predefined properties it might use.
46       *
47       * @param os the output stream the deployment build script should be generated 
48       *           to.
49       * @param moduleType the module type the build script should handle. Use the
50       *                   constants defined in the {@link J2eeModule}.
51       * @throws IOException if a problem during generating the build script occurs.
52       */
53      void writeDeploymentScript(OutputStream   os, Object   moduleType) throws IOException  ;
54      
55      /**
56       * Return the server instance specific deployment properties file used by 
57       * the deployment build script generated by the {@link #writeDeploymentScript(OutputStream,Object)}.
58       *
59       * @return the deployment properties file.
60       */
61      File   getDeploymentPropertiesFile();
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags