ko-ws-tyrus/src/main/java/org/netbeans/html/wstyrus/TyrusContext.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.wstyrus;
    44 
    45 import java.io.IOException;
    46 import java.io.InputStream;
    47 import java.net.URI;
    48 import java.net.URISyntaxException;
    49 import java.util.Iterator;
    50 import javax.websocket.ClientEndpoint;
    51 import javax.websocket.ContainerProvider;
    52 import javax.websocket.OnClose;
    53 import javax.websocket.OnError;
    54 import javax.websocket.OnMessage;
    55 import javax.websocket.OnOpen;
    56 import javax.websocket.Session;
    57 import javax.websocket.WebSocketContainer;
    58 import net.java.html.json.OnReceive;
    59 import org.netbeans.html.context.spi.Contexts;
    60 import org.netbeans.html.json.spi.JSONCall;
    61 import org.netbeans.html.json.spi.Transfer;
    62 import org.netbeans.html.json.spi.WSTransfer;
    63 import org.netbeans.html.wstyrus.TyrusContext.Comm;
    64 import org.json.JSONArray;
    65 import org.json.JSONException;
    66 import org.json.JSONObject;
    67 import org.json.JSONTokener;
    68 import org.openide.util.lookup.ServiceProvider;
    69 
    70 /** This is an implementation module that provides support for
    71  * WebSocket protocol for {@link OnReceive} communication end point for
    72  * JDK7.
    73  * <p>
    74  * Don't deal with this module directly, rather use the 
    75  * {@link OnReceive @OnReceive(url="ws://...", ...)} API to establish your
    76  * WebSocket connection.
    77  * <p>
    78  * There is no need to include this module in your application if you are
    79  * running on JDK8. JDK8 WebView provides its own implementation of the
    80  * WebSocket API based on WebSocket object inside a browser. This is included
    81  * in the <code>org.netbeans.html:ko4j:1.0</code> module.
    82  *
    83  * @author Jaroslav Tulach
    84  */
    85 @Contexts.Id("tyrus")
    86 @ServiceProvider(service = Contexts.Provider.class)
    87 public final class TyrusContext 
    88 implements Contexts.Provider, WSTransfer<Comm>, Transfer {
    89     @Override
    90     public void fillContext(Contexts.Builder context, Class<?> requestor) {
    91         // default WebSocket transfer implementation is registered
    92         // in ko-fx module with 100, provide this one as a fallback only
    93         context.register(WSTransfer.class, this, 1000);
    94         context.register(Transfer.class, this, 1000);
    95     }
    96 
    97     @Override
    98     public Comm open(String url, JSONCall callback) {
    99         try {
   100             return new Comm(new URI(url), callback);
   101         } catch (URISyntaxException ex) {
   102             throw new IllegalStateException(ex);
   103         }
   104     }
   105 
   106     @Override
   107     public void send(Comm socket, JSONCall data) {
   108         socket.session.getAsyncRemote().sendText(data.getMessage());
   109     }
   110 
   111     @Override
   112     public void close(Comm socket) {
   113         try {
   114             final Session s = socket.session;
   115             if (s != null) {
   116                 s.close();
   117             }
   118         } catch (IOException ex) {
   119             socket.callback.notifyError(ex);
   120         }
   121     }
   122 
   123     @Override
   124     public void extract(Object obj, String[] props, Object[] values) {
   125         LoadJSON.extractJSON(obj, props, values);
   126     }
   127 
   128     @Override
   129     public Object toJSON(InputStream is) throws IOException {
   130         return LoadJSON.parse(is);
   131     }
   132 
   133     @Override
   134     public void loadJSON(JSONCall call) {
   135         LoadJSON.loadJSON(call);
   136     }
   137     
   138     /** Implementation class in an implementation. Represents a {@link ClientEndpoint} of the
   139      * WebSocket channel. You are unlikely to get on hold of it.
   140      */
   141     @ClientEndpoint
   142     public static final class Comm {
   143         private final JSONCall callback;
   144         private Session session;
   145 
   146         Comm(final URI url, JSONCall callback) {
   147             this.callback = callback;
   148             try {
   149                 final WebSocketContainer c = ContainerProvider.getWebSocketContainer();
   150                 c.connectToServer(Comm.this, url);
   151             } catch (Exception ex) {
   152                 wasAnError(ex);
   153             }
   154         }
   155 
   156         @OnOpen
   157         public synchronized void open(Session s) {
   158             this.session = s;
   159             callback.notifySuccess(null);
   160         }
   161 
   162         @OnClose
   163         public void close() {
   164             this.session = null;
   165             callback.notifyError(null);
   166         }
   167 
   168         @OnMessage
   169         public void message(final String orig, Session s) {
   170             Object json;
   171             String data = orig.trim();
   172             try {
   173                 JSONTokener tok = new JSONTokener(data);
   174                 Object obj = data.startsWith("[") ? new JSONArray(tok) : new JSONObject(tok);
   175                 json = convertToArray(obj);
   176             } catch (JSONException ex) {
   177                 json = data;
   178             }
   179             callback.notifySuccess(json);
   180         }
   181 
   182         @OnError
   183         public void wasAnError(Throwable t) {
   184             callback.notifyError(t);
   185         }
   186 
   187         static Object convertToArray(Object o) throws JSONException {
   188             if (o instanceof JSONArray) {
   189                 JSONArray ja = (JSONArray) o;
   190                 Object[] arr = new Object[ja.length()];
   191                 for (int i = 0; i < arr.length; i++) {
   192                     arr[i] = convertToArray(ja.get(i));
   193                 }
   194                 return arr;
   195             } else if (o instanceof JSONObject) {
   196                 JSONObject obj = (JSONObject) o;
   197                 Iterator it = obj.keys();
   198                 while (it.hasNext()) {
   199                     String key = (String) it.next();
   200                     obj.put(key, convertToArray(obj.get(key)));
   201                 }
   202                 return obj;
   203             } else {
   204                 return o;
   205             }
   206         }
   207         
   208     } // end of Comm
   209 }