org.schedulesdirect.api.json

Class JsonRequest

java.lang.Object

org.schedulesdirect.api.json.JsonRequest

public final class JsonRequest
extends Object

Encapsulates a request being sent to the Schedules Direct JSON service.

Author:

Derek Battams <derek@battams.ca>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonRequest.Action Defines the supported action types for all requests to the service

Method Summary

Methods

Modifier and Type	Method and Description
JsonRequest.Action	getAction()
String	getBaseUrl()
String	getHash()
String	getResource()
String	getTargetUrl() Return's the target URL this request was sent to; is null until the request is actually submitted
String	getUserAgent()
InputStream	submitForInputStream(Object reqData) Submit this request; returns the raw input stream of the content; caller responsible for closing stream when done.
InputStream	submitForInputStream(Object reqData, boolean failOnStatusError) Submit this request; returns the raw input stream of the content; caller responsible for closing stream when done.
String	submitForJson(Object reqData) Submit this request; returns the JSON object response received; only call if the request is expected to return a JSON object in response
String	submitForJson(Object reqData, boolean ignoreContentType) Submit this request; returns the JSON object response received; only call if the request is expected to return a JSON object in response

Methods inherited from class java.lang.Object

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

Method Detail

getTargetUrl

public String getTargetUrl()

Return's the target URL this request was sent to; is null until the request is actually submitted

Returns:

The URL the request was sent to or null if the request has not been submitted yet

submitForJson

public String submitForJson(Object reqData,
                   boolean ignoreContentType)
                     throws IOException

Submit this request; returns the JSON object response received; only call if the request is expected to return a JSON object in response

Parameters:

reqData - The supporting data for the request; this is dependent on the action and obj target specified

ignoreContentType - When true, the content type of the response is ignored (handles buggy SD server response for some request types)

Returns:

The JSON encoded response received from the SD service

Throws:

IOException - Thrown on any IO error encountered

submitForJson

public String submitForJson(Object reqData)
                     throws IOException

Submit this request; returns the JSON object response received; only call if the request is expected to return a JSON object in response

Parameters:

reqData - The supporting data for the request; this is dependent on the action and obj target specified

Returns:

The JSON encoded response received from the SD service

Throws:

IOException - Thrown on any IO error encountered

submitForInputStream

public InputStream submitForInputStream(Object reqData)
                                 throws IOException

Submit this request; returns the raw input stream of the content; caller responsible for closing stream when done.

Parameters:

reqData - The supporting data for the request; this is dependent on the action and obj target specified

Returns:

The InputStream of data received in response to the request

Throws:

IOException - Thrown on any IO error encountered

IllegalStateException - Thrown if called on a partially constructed object (the 2 arg ctor)

submitForInputStream

public InputStream submitForInputStream(Object reqData,
                               boolean failOnStatusError)
                                 throws IOException

Submit this request; returns the raw input stream of the content; caller responsible for closing stream when done.

Parameters:

reqData - The supporting data for the request; this is dependent on the action and obj target specified

failOnStatusError - If true and the status code of the HTTP request > 399 then throw an exception; if false just return the entity stream regardless

Returns:

The InputStream of data received in response to the request

Throws:

IOException - Thrown on any IO error encountered

IllegalStateException - Thrown if called on a partially constructed object (the 2 arg ctor)

getBaseUrl

public String getBaseUrl()

Returns:

the baseUrl

getHash

public String getHash()

Returns:

the hash

getUserAgent

public String getUserAgent()

Returns:

the userAgent

getResource

public String getResource()

Returns:

the resource

getAction

public JsonRequest.Action getAction()

Returns:

the action