2 * Back 2 Browser Bytecode Translator
3 * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, version 2 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. Look for COPYING file in the top folder.
16 * If not, see http://opensource.org/licenses/GPL-2.0.
18 package org.apidesign.bck2brwsr.launcher;
20 import java.io.Closeable;
22 import java.io.IOException;
23 import java.lang.reflect.Constructor;
25 /** An abstraction for executing tests in a Bck2Brwsr virtual machine.
26 * Either in {@link Launcher#createJavaScript JavaScript engine},
27 * or in {@link Launcher#createBrowser external browser}.
29 * There also are methods to {@link #showDir(java.io.File, java.lang.String) display pages}
30 * in an external browser served by internal HTTP server.
32 * @author Jaroslav Tulach <jtulach@netbeans.org>
34 public abstract class Launcher {
39 /** Initializes the launcher. This may mean starting a web browser or
40 * initializing execution engine.
41 * @throws IOException if something goes wrong
43 public abstract void initialize() throws IOException;
45 /** Shuts down the launcher.
46 * @throws IOException if something goes wrong
48 public abstract void shutdown() throws IOException;
51 /** Builds an invocation context. The context can later be customized
52 * and {@link InvocationContext#invoke() invoked}.
54 * @param clazz the class to execute method from
55 * @param method the method to execute
56 * @return the context pointing to the selected method
58 public InvocationContext createInvocation(Class<?> clazz, String method) {
59 return new InvocationContext(this, clazz, method);
63 /** Creates launcher that uses internal JavaScript engine (Rhino).
64 * @return the launcher
66 public static Launcher createJavaScript() {
68 Class<?> c = loadClass("org.apidesign.bck2brwsr.launcher.JSLauncher");
69 return (Launcher) c.newInstance();
70 } catch (Exception ex) {
71 throw new IllegalStateException("Please include org.apidesign.bck2brwsr:launcher.html dependency!", ex);
75 /** Creates launcher that is using external browser.
77 * @param cmd <code>null</code> to use <code>java.awt.Desktop</code> to show the launcher
78 * or a string to execute in an external process (with a parameter to the URL)
79 * @return launcher executing in external browser.
81 public static Launcher createBrowser(String cmd) {
82 String msg = "Trying to create browser '" + cmd + "'";
85 if ("fx".equals(cmd)) { // NOI18N
86 msg = "Please include org.apidesign.bck2brwsr:launcher.fx dependency!";
87 c = loadClass("org.apidesign.bck2brwsr.launcher.FXBrwsrLauncher"); // NOI18N
89 msg = "Please include org.apidesign.bck2brwsr:launcher.html dependency!";
90 c = loadClass("org.apidesign.bck2brwsr.launcher.Bck2BrwsrLauncher"); // NOI18N
92 Constructor<?> cnstr = c.getConstructor(String.class);
93 return (Launcher) cnstr.newInstance(cmd);
94 } catch (Exception ex) {
95 throw new IllegalStateException(msg, ex);
99 /** Starts an HTTP server which provides access to classes and resources
100 * available in the <code>classes</code> URL and shows a start page
101 * available as {@link ClassLoader#getResource(java.lang.String)} from the
102 * provide classloader. Opens a browser with URL showing the start page.
104 * @param classes classloader offering access to classes and resources
105 * @param startpage page to show in the browser
106 * @return interface that allows one to stop the server
107 * @throws IOException if something goes wrong
109 public static Closeable showURL(ClassLoader classes, String startpage) throws IOException {
110 Launcher l = createBrowser(null);
111 l.addClassLoader(classes);
112 l.showURL(startpage);
113 return (Closeable) l;
115 /** Starts an HTTP server which provides access to certain directory.
116 * The <code>startpage</code> should be relative location inside the root
117 * directory. Opens a browser with URL showing the start page.
119 * @param directory the root directory on disk
120 * @param startpage relative path from the root to the page
121 * @exception IOException if something goes wrong.
123 public static Closeable showDir(File directory, String startpage) throws IOException {
124 Launcher l = createBrowser(null);
125 l.showDirectory(directory, startpage);
126 return (Closeable) l;
129 abstract InvocationContext runMethod(InvocationContext c) throws IOException;
132 private static Class<?> loadClass(String cn) throws ClassNotFoundException {
133 return Launcher.class.getClassLoader().loadClass(cn);
136 void showDirectory(File directory, String startpage) throws IOException {
137 throw new UnsupportedOperationException();
140 void showURL(String startpage) throws IOException {
141 throw new UnsupportedOperationException();
144 void addClassLoader(ClassLoader classes) {
145 throw new UnsupportedOperationException();