ej.rest.web

Class JSONResource

java.lang.Object

ej.rest.web.Resty

ej.rest.web.AbstractResource

ej.rest.web.JSONResource

public class JSONResource
extends AbstractResource

A resource presentation in JSON format. You can ask Resty to parse the JSON into a JSONArray or a JSONObject. The JSONObject is similar to org.json.JSONObject and allows full access to the JSON. You can also access the JSON with a JSONPathQuery to extract only the parts you are interested in.

Author:

beders, RobertFischer

Nested Class Summary

Nested classes/interfaces inherited from class ej.rest.web.Resty

Resty.Option, Resty.Timeout

Field Summary

Fields inherited from class ej.rest.web.AbstractResource

inputStream, urlConnection

Fields inherited from class ej.rest.web.Resty

DEFAULT_USER_AGENT, MOZILLA, userAgent

Constructor Summary

Constructors

Constructor and Description
JSONResource(Resty.Option... options)

Method Summary

Modifier and Type	Method and Description
JSONArray	array() Parse and return JSON array.
Object	get(JSONPathQuery aQuery) Gets the partial JSON object or attribute as specified in the path expression.
Object	get(String path) Gets the partial JSON object or attribute as specified in the path expression.
String	getAcceptedTypes()
JSONResource	json(JSONPathQuery path) Execute the given path query on the json GET the returned URI expecting JSON
JSONResource	json(JSONPathQuery path, Content content) Execute the given path query on the json and POST to the returned URI expecting JSON
JSONObject	object() Parse and return JSON object.
TextResource	text(JSONPathQuery path) Execute the given path query on the json and use the returned string as an URI expecting text/*
JSONObject	toObject() Added for compatibility with Scala.
protected Object	unmarshal() Transforming the JSON

Methods inherited from class ej.rest.web.AbstractResource

getUrlConnection, http, location, printResponseHeaders, status, stream

Methods inherited from class ej.rest.web.Resty

addAdditionalHeaders, addStandardHeaders, bytes, bytes, bytes, bytes, chunked, chunked, content, content, content, content, createBinaryResource, createJSONResource, createTextResource, data, data, delete, doGET, dontSend, doPOSTOrPUT, fillResourceFromURL, form, form, getAdditionalHeaders, identifyAsMozilla, identifyAsResty, json, json, json, json, openConnection, path, put, setOptions, text, text, text, text, withHeader

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONResource

public JSONResource(Resty.Option... options)

Method Detail

array

public JSONArray array()
                throws IOException,
                       JSONException

Parse and return JSON array. Parsing is done only once after which the inputStream is at EOF.

Throws:

IOException

JSONException

get

public Object get(JSONPathQuery aQuery)
           throws Exception

Gets the partial JSON object or attribute as specified in the path expression.

Throws:

Exception

get

public Object get(String path)
           throws Exception

Gets the partial JSON object or attribute as specified in the path expression.

Throws:

Exception

getAcceptedTypes

public String getAcceptedTypes()

Specified by:

getAcceptedTypes in class AbstractResource

json

public JSONResource json(JSONPathQuery path)
                  throws Exception

Execute the given path query on the json GET the returned URI expecting JSON

Parameters:

path - path to the URI to follow

Returns:

a new resource, as a result of getting it from the server in JSON format

Throws:

Exception

JSONException

json

public JSONResource json(JSONPathQuery path,
                         Content content)
                  throws Exception

Execute the given path query on the json and POST to the returned URI expecting JSON

Parameters:

path - path to the URI to follow

Returns:

a new resource, as a result of getting it from the server in JSON format

Throws:

Exception

JSONException

object

public JSONObject object()
                  throws IOException,
                         JSONException

Parse and return JSON object. Parsing is done only once after which the inputStrem is at EOF.

Returns:

the JSON object

Throws:

IOException

JSONException

text

public TextResource text(JSONPathQuery path)
                  throws Exception

Execute the given path query on the json and use the returned string as an URI expecting text/*

Parameters:

path - path to the URI to follow

Returns:

a new resource, as a result of getting it from the server in text/plain format

Throws:

Exception

JSONException

toObject

public JSONObject toObject()
                    throws IOException,
                           JSONException

Added for compatibility with Scala. See Issue #2 at github.

Returns:

the JSONObject presentation

Throws:

IOException

JSONException - if data was no valid JSON

unmarshal

protected Object unmarshal()
                    throws IOException,
                           JSONException

Transforming the JSON

Throws:

IOException

JSONException