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