org.schedulesdirect.api.json

Class JsonRequestFactory

java.lang.Object

org.schedulesdirect.api.json.JsonRequestFactory

All Implemented Interfaces:

IJsonRequestFactory

public class JsonRequestFactory
extends Object
implements IJsonRequestFactory

Constructs requests that function against the given web serivce URL

Author:

Derek Battams <derek@battams.ca>

Constructor Summary

Constructors

Constructor and Description
JsonRequestFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static JsonRequestFactory	get()
JsonRequest	get(JsonRequest.Action action, String resource) Construct a partial JsonRequest that CANNOT be executed; used as skeleton for a clone construction
JsonRequest	get(JsonRequest.Action action, String resource, String hash, String userAgent, String baseUrl) Construct a complete JsonRequest suitable for execution.
JsonRequest	get(JsonRequest.Action action, URL url) Construct a JSON request from a complete URL; the request is partial and cannot be immediately executed

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonRequestFactory

public JsonRequestFactory()

Method Detail

get

public static JsonRequestFactory get()

get

public JsonRequest get(JsonRequest.Action action,
              String resource,
              String hash,
              String userAgent,
              String baseUrl)

Description copied from interface: IJsonRequestFactory

Construct a complete JsonRequest suitable for execution.

Specified by:

get in interface IJsonRequestFactory

Parameters:

action - The action to execute

resource - The resource to execute against

hash - The user auth hash or null if not available/not required

userAgent - The user agent to pass to the server

baseUrl - The service base URL

Returns:

The constructed JsonRequest, ready to be executed

get

public JsonRequest get(JsonRequest.Action action,
              String resource)

Description copied from interface: IJsonRequestFactory

Construct a partial JsonRequest that CANNOT be executed; used as skeleton for a clone construction

Specified by:

get in interface IJsonRequestFactory

Parameters:

action - The action to execute

resource - The resource to execute against

Returns:

The partial JsonRequest object; use this object as the basis for constructing a full one

get

public JsonRequest get(JsonRequest.Action action,
              URL url)

Description copied from interface: IJsonRequestFactory

Construct a JSON request from a complete URL; the request is partial and cannot be immediately executed

Specified by:

get in interface IJsonRequestFactory

Parameters:

action - The action to execute

url - The URL to build the request from

Returns:

The partial JsonRequest; suitable for constructing a full, executable request