ko4j/src/main/java/org/netbeans/html/ko4j/KO4J.java
author Jaroslav Tulach <jtulach@netbeans.org>
Thu, 04 Dec 2014 09:21:55 +0100
changeset 886 88d62267a0b5
parent 838 bdc3d696dd4a
permissions -rw-r--r--
#248918: Introducing technology identifiers
     1 /**
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
     5  *
     6  * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
     7  * Other names may be trademarks of their respective owners.
     8  *
     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]"
    26  *
    27  * Contributor(s):
    28  *
    29  * The Original Software is NetBeans. The Initial Developer of the Original
    30  * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
    31  *
    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.
    42  */
    43 package org.netbeans.html.ko4j;
    44 
    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;
    55 
    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:
    60  * <ul>
    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.
    63  * </li>
    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.
    68  * </li>
    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>
    72  *   subprotocol.
    73  * </li>
    74  * </ul>
    75  *
    76  * @author Jaroslav Tulach
    77  * @since 0.7
    78  */
    79 @ServiceProvider(service = Provider.class)
    80 public final class KO4J implements Provider {
    81     static final Logger LOG = Logger.getLogger(KOSockets.class.getName());
    82     private KOTech ko4j;
    83     private KOTransfer trans;
    84     private KOSockets socks;
    85     
    86     public KO4J() {
    87         this(null);
    88     }
    89 
    90     @Deprecated
    91     public KO4J(Fn.Presenter presenter) {
    92     }
    93     
    94     /** Return instance of the knockout.js for Java technology.
    95      * @return non-null instance
    96      */
    97     public Technology knockout() {
    98         if (ko4j == null) {
    99             ko4j = new KOTech();
   100         }
   101         return ko4j;
   102     }
   103     
   104     /** Browser based implementation of transfer interface. Uses
   105      * browser method to convert string to JSON.
   106      * 
   107      * @return non-null instance
   108      */
   109     public Transfer transfer() {
   110         if (trans == null) {
   111             trans = new KOTransfer();
   112         }
   113         return trans;
   114     }
   115     
   116     /** Returns browser based implementation of websocket transfer.
   117      * If available (for example JavaFX WebView on JDK7 does not have
   118      * this implementation).
   119      * 
   120      * @return an instance or <code>null</code>, if there is no
   121      *   <code>WebSocket</code> object in the browser
   122      */
   123     public WSTransfer<?> websockets() {
   124         if (!KOSockets.areWebSocketsSupported()) {
   125             return null;
   126         }
   127         if (socks == null) {
   128             socks = new KOSockets();
   129         }
   130         return socks;
   131     }
   132 
   133     /** Registers technologies at position 100:
   134      * <ul>
   135      *   <li>{@link #knockout()}</li>
   136      *   <li>{@link #transfer()}</li>
   137      *   <li>{@link #websockets()()} - if browser supports web sockets</li>
   138      * </ul>
   139      * @param context the context to register to
   140      * @param requestor the class requesting the registration
   141      */
   142     @Override
   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);
   147     }
   148     
   149 }