2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
9 * The contents of this file are subject to the terms of either the GNU
10 * General Public License Version 2 only ("GPL") or the Common
11 * Development and Distribution License("CDDL") (collectively, the
12 * "License"). You may not use this file except in compliance with the
13 * License. You can obtain a copy of the License at
14 * http://www.netbeans.org/cddl-gplv2.html
15 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16 * specific language governing permissions and limitations under the
17 * License. When distributing the software, include this License Header
18 * Notice in each file and include the License file at
19 * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20 * particular file as subject to the "Classpath" exception as provided
21 * by Oracle in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the
23 * License Header, with the fields enclosed by brackets [] replaced by
24 * your own identifying information:
25 * "Portions Copyrighted [year] [name of copyright owner]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
32 * If you wish your version of this file to be governed by only the CDDL
33 * or only the GPL Version 2, indicate your decision by adding
34 * "[Contributor] elects to include this software in this distribution
35 * under the [CDDL or GPL Version 2] license." If you do not indicate a
36 * single choice of license, a recipient has the option to distribute
37 * your version of this file under either the CDDL, the GPL Version 2 or
38 * to extend the choice of license to its licensees as provided above.
39 * However, if you add GPL Version 2 code and therefore, elected the GPL
40 * Version 2 license, then the option applies only if the new code is
41 * made subject to such option by the copyright holder.
43 package net.java.html.boot;
46 import java.io.FileNotFoundException;
47 import java.io.IOException;
48 import java.io.InputStream;
49 import java.lang.reflect.Method;
50 import java.net.JarURLConnection;
51 import java.net.MalformedURLException;
53 import java.net.URLConnection;
54 import java.security.ProtectionDomain;
55 import java.util.Arrays;
56 import java.util.Collection;
57 import java.util.Enumeration;
58 import java.util.ServiceLoader;
59 import java.util.concurrent.Executor;
60 import java.util.logging.Level;
61 import java.util.logging.Logger;
62 import net.java.html.BrwsrCtx;
63 import net.java.html.js.JavaScriptBody;
64 import org.apidesign.html.boot.spi.Fn;
65 import org.apidesign.html.context.spi.Contexts;
66 import org.netbeans.html.boot.impl.FindResources;
67 import org.netbeans.html.boot.impl.FnContext;
68 import org.netbeans.html.boot.impl.FnUtils;
70 /** Use this builder to launch your Java/HTML based application. Typical
71 * usage in a main method of your application looks like this:
74 * <b>public static void</b> <em>main</em>(String... args) {
75 * BrowserBuilder.{@link #newBrowser newBrowser()}.
76 * {@link #loadClass(java.lang.Class) loadClass(YourMain.class)}.
77 * {@link #loadPage(java.lang.String) loadPage("index.html")}.
78 * {@link #invoke(java.lang.String, java.lang.String[]) invoke("initialized", args)}.
79 * {@link #showAndWait()};
83 * The above will load <code>YourMain</code> class via
84 * a special classloader, it will locate an <code>index.html</code> (relative
85 * to <code>YourMain</code> class) and show it in a browser window. When the
86 * initialization is over, a <b>public static</b> method <em>initialized</em>
87 * in <code>YourMain</code> will be called with provided string parameters.
89 * This module provides only API for building browsers. To use it properly one
90 * also needs an implementation on the classpath of one's application. For example
93 * <groupId>org.netbeans.html</groupId>
94 * <artifactId>net.java.html.boot.fx</artifactId>
95 * <scope>runtime</scope>
99 * @author Jaroslav Tulach
101 public final class BrowserBuilder {
102 private static final Logger LOG = Logger.getLogger(BrowserBuilder.class.getName());
104 private String resource;
105 private Class<?> clazz;
106 private Class[] browserClass;
107 private Runnable onLoad;
108 private String methodName;
109 private String[] methodArgs;
110 private final Object[] context;
111 private ClassLoader loader;
113 private BrowserBuilder(Object[] context) {
114 this.context = context;
117 /** Entry method to obtain a new browser builder. Follow by calling
118 * its instance methods like {@link #loadClass(java.lang.Class)} and
119 * {@link #loadPage(java.lang.String)}.
121 * @param context any instances that should be available to the builder -
122 * implementation dependant
123 * @return new browser builder
125 public static BrowserBuilder newBrowser(Object... context) {
126 return new BrowserBuilder(context);
129 /** The class to load when the browser is initialized. This class
130 * is loaded by a special classloader (that supports {@link JavaScriptBody}
133 * @param mainClass the class to load and resolve when the browser is ready
134 * @return this builder
136 public BrowserBuilder loadClass(Class<?> mainClass) {
137 this.clazz = mainClass;
141 /** Allows one to specify a runnable that should be invoked when a load
142 * of a page is finished. This method may be used in addition or instead
143 * of {@link #loadClass(java.lang.Class)} and
144 * {@link #invoke(java.lang.String, java.lang.String...)} methods.
146 * @param r the code to run when the page is loaded
147 * @return this builder
150 public BrowserBuilder loadFinished(Runnable r) {
155 /** Page to load into the browser. If the <code>page</code> represents
156 * a {@link URL} known to the Java system, the URL is passed to the browser.
157 * If system property <code>browser.rootdir</code> is specified, then a
158 * file <code>page</code> relative to this directory is used as the URL.
159 * If no such file exists, the system seeks for the
160 * resource via {@link Class#getResource(java.lang.String)}
161 * method (relative to the {@link #loadClass(java.lang.Class) specified class}).
162 * If such resource is not found, a file relative to the location JAR
163 * that contains the {@link #loadClass(java.lang.Class) main class} is
166 * @param page the location (relative, absolute, or URL) of a page to load
167 * @return this browser
169 public BrowserBuilder loadPage(String page) {
170 this.resource = page;
174 /** Specifies callback method to notify the application that the browser is ready.
175 * There should be a <b>public static</b> method in the class specified
176 * by {@link #loadClass(java.lang.Class)} which takes an array of {@link String}
177 * argument. The method is called on the browser dispatch thread one
178 * the browser finishes loading of the {@link #loadPage(java.lang.String) HTML page}.
180 * @param methodName name of a method to seek for
181 * @param args parameters to pass to the method
182 * @return this builder
184 public BrowserBuilder invoke(String methodName, String... args) {
185 this.methodName = methodName;
186 this.methodArgs = args;
190 /** Loader to use when searching for classes to initialize.
191 * If specified, this loader is going to be used to load {@link Fn.Presenter}
192 * and {@link Contexts#fillInByProviders(java.lang.Class, org.apidesign.html.context.spi.Contexts.Builder) fill} {@link BrwsrCtx} in.
193 * Specifying special classloader may be useful in modular systems,
194 * like OSGi, where one needs to load classes from many otherwise independent
197 * @param l the loader to use (or <code>null</code>)
198 * @return this builder
201 public BrowserBuilder classloader(ClassLoader l) {
206 /** Shows the browser, loads specified page in and executes the
207 * {@link #invoke(java.lang.String, java.lang.String[]) initialization method}.
208 * The method returns when the browser is closed.
210 * @throws NullPointerException if some of essential parameters (like {@link #loadPage(java.lang.String) page} or
211 * {@link #loadClass(java.lang.Class) class} have not been specified
213 public void showAndWait() {
214 if (resource == null) {
215 throw new NullPointerException("Need to specify resource via loadPage method");
219 IOException mal = null;
221 String baseURL = System.getProperty("browser.rootdir");
222 if (baseURL != null) {
223 url = new File(baseURL, resource).toURI().toURL();
225 url = new URL(resource);
227 } catch (MalformedURLException ex) {
230 final Class<?> myCls;
233 } else if (onLoad != null) {
234 myCls = onLoad.getClass();
236 throw new NullPointerException("loadClass, neither loadFinished was called!");
240 url = myCls.getResource(resource);
243 final ProtectionDomain pd = myCls.getProtectionDomain();
244 if (pd != null && pd.getCodeSource() != null) {
245 URL jar = pd.getCodeSource().getLocation();
247 url = new URL(jar, resource);
248 } catch (MalformedURLException ex) {
255 URL res = BrowserBuilder.class.getResource("html4j.txt");
256 LOG.log(Level.FINE, "Found html4j {0}", res);
257 if (res != null) try {
258 URLConnection c = res.openConnection();
259 LOG.log(Level.FINE, "testing : {0}", c);
260 if (c instanceof JarURLConnection) {
261 JarURLConnection jc = (JarURLConnection)c;
262 URL base = jc.getJarFileURL();
263 for (int i = 0; i < 50; i++) {
264 URL u = new URL(base, resource);
266 InputStream is = u.openStream();
269 LOG.log(Level.FINE, "found real url: {0}", url);
271 } catch (FileNotFoundException ignore) {
272 LOG.log(Level.FINE, "Cannot open " + u, ignore);
274 base = new URL(base, "..");
277 } catch (IOException ex) {
282 IllegalStateException ise = new IllegalStateException("Can't find resouce: " + resource + " relative to " + myCls);
289 Fn.Presenter dfnr = null;
290 for (Object o : context) {
291 if (o instanceof Fn.Presenter) {
292 dfnr = (Fn.Presenter)o;
297 if (dfnr == null && loader != null) for (Fn.Presenter o : ServiceLoader.load(Fn.Presenter.class, loader)) {
302 if (dfnr == null) for (Fn.Presenter o : ServiceLoader.load(Fn.Presenter.class)) {
308 throw new IllegalStateException("Can't find any Fn.Presenter");
311 final ClassLoader activeLoader;
312 if (loader != null) {
313 if (!FnUtils.isJavaScriptCapable(loader)) {
314 throw new IllegalStateException("Loader cannot resolve @JavaScriptBody: " + loader);
316 activeLoader = loader;
317 } else if (FnUtils.isJavaScriptCapable(myCls.getClassLoader())) {
318 activeLoader = myCls.getClassLoader();
320 FImpl impl = new FImpl(myCls.getClassLoader());
321 activeLoader = FnUtils.newLoader(impl, dfnr, myCls.getClassLoader().getParent());
324 final Fn.Presenter dP = dfnr;
326 class OnPageLoad implements Runnable {
330 final Fn.Presenter aP = Fn.activePresenter();
331 final Fn.Presenter currentP = aP != null ? aP : dP;
333 Thread.currentThread().setContextClassLoader(activeLoader);
334 final Class<?> newClazz = Class.forName(myCls.getName(), true, activeLoader);
335 if (browserClass != null) {
336 browserClass[0] = newClazz;
338 Contexts.Builder cb = Contexts.newBuilder();
339 if (!Contexts.fillInByProviders(newClazz, cb)) {
340 LOG.log(Level.WARNING, "Using empty technology for {0}", newClazz);
342 if (currentP instanceof Executor) {
343 cb.register(Executor.class, (Executor)currentP, 1000);
345 cb.register(Fn.Presenter.class, currentP, 1000);
346 BrwsrCtx c = cb.build();
348 class CallInitMethod implements Runnable {
351 Throwable firstError = null;
352 if (onLoad != null) {
354 FnContext.currentPresenter(currentP);
356 } catch (Throwable ex) {
359 FnContext.currentPresenter(null);
362 INIT: if (methodName != null) {
363 if (methodArgs.length == 0) {
365 Method m = newClazz.getMethod(methodName);
366 FnContext.currentPresenter(currentP);
370 } catch (Throwable ex) {
373 FnContext.currentPresenter(null);
377 Method m = newClazz.getMethod(methodName, String[].class);
378 FnContext.currentPresenter(currentP);
379 m.invoke(m, (Object) methodArgs);
381 } catch (Throwable ex) {
382 LOG.log(Level.SEVERE, "Can't call " + methodName + " with args " + Arrays.toString(methodArgs), ex);
384 FnContext.currentPresenter(null);
387 if (firstError != null) {
388 LOG.log(Level.SEVERE, "Can't initialize the view", firstError);
393 c.execute(new CallInitMethod());
394 } catch (ClassNotFoundException ex) {
395 LOG.log(Level.SEVERE, "Can't load " + myCls.getName(), ex);
399 dfnr.displayPage(url, new OnPageLoad());
402 private static final class FImpl implements FindResources {
405 public FImpl(ClassLoader l) {
410 public void findResources(String path, Collection<? super URL> results, boolean oneIsEnough) {
412 URL u = l.getResource(path);
418 Enumeration<URL> en = l.getResources(path);
419 while (en.hasMoreElements()) {
420 results.add(en.nextElement());
422 } catch (IOException ex) {