json/src/main/java/org/apidesign/html/json/spi/JSONCall.java
author Jaroslav Tulach <jtulach@netbeans.org>
Sat, 02 Aug 2014 12:59:31 +0200
changeset 790 30f20d9c0986
parent 677 076a1e3e0dbb
permissions -rw-r--r--
Fixing Javadoc to succeed on JDK8
     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.apidesign.html.json.spi;
    44 
    45 import java.io.IOException;
    46 import java.io.OutputStream;
    47 import net.java.html.BrwsrCtx;
    48 import org.netbeans.html.json.impl.RcvrJSON;
    49 
    50 /** Description of a JSON call request that is supposed to be processed
    51  * by {@link Transfer#loadJSON(org.apidesign.html.json.spi.JSONCall)} implementors.
    52  *
    53  * @author Jaroslav Tulach
    54  */
    55 public final class JSONCall {
    56     private final RcvrJSON whenDone;
    57     private final String urlBefore;
    58     private final String urlAfter;
    59     private final String method;
    60     private final Object data;
    61     private final BrwsrCtx ctx;
    62 
    63     JSONCall(BrwsrCtx ctx, RcvrJSON whenDone, String urlBefore, String urlAfter, String method, Object data) {
    64         this.ctx = ctx;
    65         this.whenDone = whenDone;
    66         this.urlBefore = urlBefore;
    67         this.urlAfter = urlAfter;
    68         this.method = method;
    69         this.data = data;
    70     }
    71     
    72     /** Do we have some data to send? Can the {@link #writeData(java.io.OutputStream)} method be 
    73      * called?
    74      * 
    75      * @return true, if the call has some data to send
    76      */
    77     public boolean isDoOutput() {
    78         return this.data != null;
    79     }
    80     
    81     public void writeData(OutputStream os) throws IOException {
    82         if (this.data == null) {
    83             throw new IOException("No data!");
    84         }
    85         os.write(this.data.toString().getBytes("UTF-8"));
    86         os.flush();
    87     }
    88     
    89     public String getMethod() {
    90         return method;
    91     }
    92     
    93     public boolean isJSONP() {
    94         return urlAfter != null;
    95     }
    96     
    97     public String composeURL(String jsonpCallback) {
    98         if ((urlAfter == null) != (jsonpCallback == null)) {
    99             throw new IllegalStateException();
   100         }
   101         if (urlAfter != null) {
   102             return urlBefore + jsonpCallback + urlAfter;
   103         } else {
   104             return urlBefore;
   105         }
   106     }
   107 
   108     public void notifySuccess(Object result) {
   109         if (result == null) {
   110             dispatch(RcvrJSON.MsgEvnt.createOpen());
   111         } else {
   112             dispatch(RcvrJSON.MsgEvnt.createMessage(result));
   113         }
   114     }
   115     
   116     public void notifyError(Throwable error) {
   117         if (error == null) {
   118             dispatch(RcvrJSON.MsgEvnt.createClose());
   119         } else {
   120             dispatch(RcvrJSON.MsgEvnt.createError(error));
   121         }
   122     }
   123     
   124     private void dispatch(final RcvrJSON.MsgEvnt ev) {
   125         ctx.execute(new Runnable() {
   126             @Override
   127             public void run() {
   128                 ev.dispatch(whenDone);
   129             }
   130         });
   131     }
   132 
   133     public String getMessage() {
   134         return this.data.toString();
   135     }
   136 }