View Javadoc

1   /**
2    * The MIT License
3    * 
4    * Copyright 2006-2012 The Codehaus.
5    * 
6    * Permission is hereby granted, free of charge, to any person obtaining a copy of
7    * this software and associated documentation files (the "Software"), to deal in
8    * the Software without restriction, including without limitation the rights to
9    * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10   * of the Software, and to permit persons to whom the Software is furnished to do
11   * so, subject to the following conditions:
12   * 
13   * The above copyright notice and this permission notice shall be included in all
14   * copies or substantial portions of the Software.
15   * 
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22   * SOFTWARE.
23   */
24  package org.codehaus.mojo.appassembler.daemon.script;
25  
26  import org.codehaus.mojo.appassembler.daemon.DaemonGeneratorException;
27  import org.codehaus.mojo.appassembler.model.Daemon;
28  
29  import java.io.File;
30  
31  /**
32   * @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugst&oslash;l</a>
33   * @version $Id: ScriptGenerator.java 16492 2012-04-29 18:26:21Z khmarbaise $
34   */
35  public interface ScriptGenerator
36  {
37      /**
38       * Define the role.
39       */
40      String ROLE = ScriptGenerator.class.getName ( );
41  
42      /**
43       * Generate the binary script based on platform, daemon into the given outputDirectory
44       * and the binFolder.
45       * 
46       * @param platform
47       *            The platform.
48       * @param daemon
49       *            The Daemon.
50       * @param outputDirectory
51       *            The output folder where the script will be generated into.
52       * @param binFolder
53       *            The bin folder which will be appended to the outputDirectory.
54       * @throws DaemonGeneratorException in case of an error.
55       */
56      void createBinScript ( String platform, Daemon daemon, File outputDirectory, String binFolder )
57              throws DaemonGeneratorException;
58  }