org.directwebremoting.jsonrpc.io.JsonRpcResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dwr Show documentation

DWR is easy Ajax for Java. It makes it simple to call Java code directly from Javascript. It gets rid of almost all the boiler plate code between the web browser and your Java code.

The newest version!

/*
 * Copyright 2005 Joe Walker
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.directwebremoting.jsonrpc.io;

import org.directwebremoting.io.StringWrapper;

/**
 * A Container for a JSON-RPC response
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public class JsonRpcResponse
{
    /**
     * Create an Error from a request and the data to fulfill the request
     */
    public JsonRpcResponse(String version, StringWrapper id, Object result)
    {
        this.version = version;
        this.id = id;
        this.result = result;
    }

    /**
     * @return A String specifying the version of the JSON-RPC protocol.
     */
    public String getJsonRpc()
    {
        return version;
    }

    /**
     * @see #getJsonRpc()
     */
    private final String version;

    /**
     * @return The data that results from running a JSON-RPC request
     */
    public Object getResult()
    {
        return result;
    }

    /**
     * @see #getResult()
     */
    private final Object result;

    /**
     * A Request identifier that SHOULD be a JSON scalar (String, Number, True,
     * False), but SHOULD normally not be Null [1].
     * If omitted, the Request is a Notification.
     */
    public StringWrapper getId()
    {
        return id;
    }

    /**
     * @see #getId()
     */
    private final StringWrapper id;
}