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 org.netbeans.html.ko4j;
45 import java.util.logging.Logger;
46 import net.java.html.json.Model;
47 import net.java.html.json.OnReceive;
48 import org.netbeans.html.boot.spi.Fn;
49 import org.netbeans.html.context.spi.Contexts;
50 import org.netbeans.html.context.spi.Contexts.Provider;
51 import org.netbeans.html.json.spi.Technology;
52 import org.netbeans.html.json.spi.Transfer;
53 import org.netbeans.html.json.spi.WSTransfer;
54 import org.openide.util.lookup.ServiceProvider;
56 /** Support for <a href="http://knockoutjs.com">knockout.js</a>
57 * and its Java binding via {@link Model model classes}.
58 * Registers {@link Provider}, so {@link java.util.ServiceLoader} can find it.
59 * The provider registers following technologies:
61 * <li><b>ko4j</b> - bindings for <a href="http://knockoutjs.com">knockout.js</a>
62 * and the classes generated by the {@link Model} annotation.
64 * <li><b>xhr</b> - <a href="http://www.w3.org/TR/XMLHttpRequest/">XMLHttpRequest</a>
65 * based implementation for <em>REST</em> calls
66 * (<b>GET</b>, <b>PUT</b>, <b>POST</b>, <b>DELETE</b> methods)
67 * for {@link OnReceive} annotation.
69 * <li><b>websocket</b> -
70 * native browser <a href="http://www.w3.org/TR/websockets/">websockets</a>
71 * based implementation for {@link OnReceive} annotation and its <b>WebSocket</b>
76 * @author Jaroslav Tulach
79 @ServiceProvider(service = Provider.class)
80 public final class KO4J implements Provider {
81 static final Logger LOG = Logger.getLogger(KOSockets.class.getName());
83 private KOTransfer trans;
84 private KOSockets socks;
91 public KO4J(Fn.Presenter presenter) {
94 /** Return instance of the knockout.js for Java technology.
95 * @return non-null instance
97 public Technology knockout() {
104 /** Browser based implementation of transfer interface. Uses
105 * browser method to convert string to JSON.
107 * @return non-null instance
109 public Transfer transfer() {
111 trans = new KOTransfer();
116 /** Returns browser based implementation of websocket transfer.
117 * If available (for example JavaFX WebView on JDK7 does not have
118 * this implementation).
120 * @return an instance or <code>null</code>, if there is no
121 * <code>WebSocket</code> object in the browser
123 public WSTransfer<?> websockets() {
124 if (!KOSockets.areWebSocketsSupported()) {
128 socks = new KOSockets();
133 /** Registers technologies at position 100:
135 * <li>{@link #knockout()}</li>
136 * <li>{@link #transfer()}</li>
137 * <li>{@link #websockets()()} - if browser supports web sockets</li>
139 * @param context the context to register to
140 * @param requestor the class requesting the registration
143 public void fillContext(Contexts.Builder context, Class<?> requestor) {
144 context.register(Technology.class, knockout(), 100);
145 context.register(Transfer.class, transfer(), 100);
146 context.register(WSTransfer.class, websockets(), 100);