1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/json/src/main/java/org/netbeans/html/json/spi/WSTransfer.java	Tue Aug 26 18:13:30 2014 +0200
     1.3 @@ -0,0 +1,84 @@
     1.4 +/**
     1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     1.6 + *
     1.7 + * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
     1.8 + *
     1.9 + * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    1.10 + * Other names may be trademarks of their respective owners.
    1.11 + *
    1.12 + * The contents of this file are subject to the terms of either the GNU
    1.13 + * General Public License Version 2 only ("GPL") or the Common
    1.14 + * Development and Distribution License("CDDL") (collectively, the
    1.15 + * "License"). You may not use this file except in compliance with the
    1.16 + * License. You can obtain a copy of the License at
    1.17 + * http://www.netbeans.org/cddl-gplv2.html
    1.18 + * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
    1.19 + * specific language governing permissions and limitations under the
    1.20 + * License.  When distributing the software, include this License Header
    1.21 + * Notice in each file and include the License file at
    1.22 + * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
    1.23 + * particular file as subject to the "Classpath" exception as provided
    1.24 + * by Oracle in the GPL Version 2 section of the License file that
    1.25 + * accompanied this code. If applicable, add the following below the
    1.26 + * License Header, with the fields enclosed by brackets [] replaced by
    1.27 + * your own identifying information:
    1.28 + * "Portions Copyrighted [year] [name of copyright owner]"
    1.29 + *
    1.30 + * Contributor(s):
    1.31 + *
    1.32 + * The Original Software is NetBeans. The Initial Developer of the Original
    1.33 + * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
    1.34 + *
    1.35 + * If you wish your version of this file to be governed by only the CDDL
    1.36 + * or only the GPL Version 2, indicate your decision by adding
    1.37 + * "[Contributor] elects to include this software in this distribution
    1.38 + * under the [CDDL or GPL Version 2] license." If you do not indicate a
    1.39 + * single choice of license, a recipient has the option to distribute
    1.40 + * your version of this file under either the CDDL, the GPL Version 2 or
    1.41 + * to extend the choice of license to its licensees as provided above.
    1.42 + * However, if you add GPL Version 2 code and therefore, elected the GPL
    1.43 + * Version 2 license, then the option applies only if the new code is
    1.44 + * made subject to such option by the copyright holder.
    1.45 + */
    1.46 +package org.netbeans.html.json.spi;
    1.47 +
    1.48 +import net.java.html.BrwsrCtx;
    1.49 +import org.netbeans.html.context.spi.Contexts.Provider;
    1.50 +
    1.51 +/** Interface for providers of WebSocket protocol. Register into a 
    1.52 + * {@link BrwsrCtx context} in your own {@link Provider}
    1.53 + *
    1.54 + * @author Jaroslav Tulach
    1.55 + * @param <WebSocket> internal implementation type representing the socket
    1.56 + * @since 0.5
    1.57 + */
    1.58 +public interface WSTransfer<WebSocket> {
    1.59 +    /** Initializes a web socket. The <code>callback</code> object should 
    1.60 +     * have mostly empty values: {@link JSONCall#isDoOutput()} should be 
    1.61 +     * <code>false</code> and thus there should be no {@link JSONCall#getMessage()}.
    1.62 +     * The method of connection {@link JSONCall#getMethod()} is "WebSocket".
    1.63 +     * Once the connection is open call {@link JSONCall#notifySuccess(java.lang.Object) notifySuccess(null)}.
    1.64 +     * When the server sends some data then, pass them to 
    1.65 +     * {@link JSONCall#notifySuccess(java.lang.Object) notifySuccess} method
    1.66 +     * as well. If there is an error call {@link JSONCall#notifyError(java.lang.Throwable)}.
    1.67 +     * 
    1.68 +     * @param url the URL to connect to
    1.69 +     * @param callback a way to provide results back to the client
    1.70 +     * @return your object representing the established web socket
    1.71 +     */
    1.72 +    public WebSocket open(String url, JSONCall callback);
    1.73 +
    1.74 +    /** Sends data to the server. The most important value
    1.75 +     * of the <code>data</code> parameter is {@link JSONCall#getMessage()},
    1.76 +     * rest can be ignored.
    1.77 +     * 
    1.78 +     * @param socket internal representation of the socket
    1.79 +     * @param data the message to be sent
    1.80 +     */
    1.81 +    public void send(WebSocket socket, JSONCall data);
    1.82 +
    1.83 +    /** A request to close the socket.
    1.84 +     * @param socket internal representation of the socket
    1.85 +     */
    1.86 +    public void close(WebSocket socket);
    1.87 +}