com.eduworks.ec.remote

Class EcRemote

java.lang.Object

com.eduworks.ec.remote.EcRemote

public class EcRemote
extends Object

Wrapper to handle all remote web service invocations.

Author:

fritz.ray@eduworks.com, devlin.junker@eduworks.com

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	async Turn this property off to cause all remote web service calls to be synchronous.
static int	timeout Timeout for AJAX requests

Constructor Summary

Constructors

Constructor and Description
EcRemote()

Method Summary

Modifier and Type	Method and Description
static void	_delete(String url, String signatureSheet, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) DELETEs something at a remote endpoint.
static void	getExpectingObject(String server, String service, org.stjs.javascript.functions.Callback1<Object> success, org.stjs.javascript.functions.Callback1<String> failure) GETs something from a remote endpoint.
static void	getExpectingString(String server, String service, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) GETs something from a remote endpoint.
protected static org.stjs.javascript.functions.Callback1<String>	getSuccessJSONCallback(org.stjs.javascript.functions.Callback1<Object> success, org.stjs.javascript.functions.Callback1<String> failure)
static void	postExpectingObject(String server, String service, FormData fd, org.stjs.javascript.functions.Callback1<Object> success, org.stjs.javascript.functions.Callback1<String> failure) POSTs a request to a remote endpoint.
static void	postExpectingString(String server, String service, FormData fd, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) POSTs a request to a remote endpoint.
static void	postWithHeadersExpectingString(String server, String service, FormData fd, org.stjs.javascript.Map<String,String> headers, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) POSTs a request to a remote endpoint.
protected static String	upgradeHttpToHttps(String url)
static String	urlAppend(String server, String service)

Methods inherited from class java.lang.Object

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

Field Detail

async

public static boolean async

Turn this property off to cause all remote web service calls to be synchronous. Can be useful for test scripts, blocking calls, etc.

timeout

public static int timeout

Timeout for AJAX requests

Constructor Detail

EcRemote

public EcRemote()

Method Detail

postExpectingObject

public static void postExpectingObject(String server,
                                       String service,
                                       FormData fd,
                                       org.stjs.javascript.functions.Callback1<Object> success,
                                       org.stjs.javascript.functions.Callback1<String> failure)

POSTs a request to a remote endpoint. Composed of a server endpoint (root URL) and a service (service path). Sends form data as a multi-part mime request.

Parameters:

{string} - server Protocol, hostname and path to the remote handler.

{string} - service Path to service to invoke.

{FormData} - fd Form data to send as multi-part mime.

{function(object)} - success Method that is invoked if the server responds with a success (per jQuery ajax)

{function(string)} - failure Method that is invoked if the server responds with an error (per jQuery ajax) or a non-200/300.

postExpectingString

public static void postExpectingString(String server,
                                       String service,
                                       FormData fd,
                                       org.stjs.javascript.functions.Callback1<String> success,
                                       org.stjs.javascript.functions.Callback1<String> failure)

POSTs a request to a remote endpoint. Composed of a server endpoint (root URL) and a service (service path). Sends form data as a multi-part mime request.

Parameters:

{string} - server Protocol, hostname and path to the remote handler.

{string} - service Path to service to invoke.

{FormData} - fd Form data to send as multi-part mime.

{function(string)} - success Method that is invoked if the server responds with a success (per jQuery ajax)

{function(string)} - failure Method that is invoked if the server responds with an error (per jQuery ajax) or a non-200/300.

postWithHeadersExpectingString

public static void postWithHeadersExpectingString(String server,
                                                  String service,
                                                  FormData fd,
                                                  org.stjs.javascript.Map<String,String> headers,
                                                  org.stjs.javascript.functions.Callback1<String> success,
                                                  org.stjs.javascript.functions.Callback1<String> failure)

POSTs a request to a remote endpoint. Composed of a server endpoint (root URL) and a service (service path). Sends form data as a multi-part mime request. Includes headers.

Parameters:

{string} - server Protocol, hostname and path to the remote handler.

{string} - service Path to service to invoke.

{FormData} - fd Form data to send as multi-part mime.

{Object} - headers Headers to attach to the HTTP post.

{function(string)} - success Method that is invoked if the server responds with a success (per jQuery ajax)

{function(string)} - failure Method that is invoked if the server responds with an error (per jQuery ajax) or a non-200/300.

getExpectingObject

public static void getExpectingObject(String server,
                                      String service,
                                      org.stjs.javascript.functions.Callback1<Object> success,
                                      org.stjs.javascript.functions.Callback1<String> failure)

GETs something from a remote endpoint. Composed of a server endpoint (root URL) and a service (service path).

Parameters:

{string} - server Protocol, hostname and path to the remote handler.

{string} - service Path to service to invoke.

{function(object)} - success Method that is invoked if the server responds with a success (per jQuery ajax)

{function(string)} - failure Method that is invoked if the server responds with an error (per jQuery ajax) or a non-200/300.

getExpectingString

public static void getExpectingString(String server,
                                      String service,
                                      org.stjs.javascript.functions.Callback1<String> success,
                                      org.stjs.javascript.functions.Callback1<String> failure)

GETs something from a remote endpoint. Composed of a server endpoint (root URL) and a service (service path).

Parameters:

{string} - server Protocol, hostname and path to the remote handler.

{string} - service Path to service to invoke.

{function(object)} - success Method that is invoked if the server responds with a success (per jQuery ajax)

{function(string)} - failure Method that is invoked if the server responds with an error (per jQuery ajax) or a non-200/300.

urlAppend

public static String urlAppend(String server,
                               String service)

_delete

public static void _delete(String url,
                           String signatureSheet,
                           org.stjs.javascript.functions.Callback1<String> success,
                           org.stjs.javascript.functions.Callback1<String> failure)

DELETEs something at a remote endpoint. Composed of a server endpoint (root URL) and a service (service path).

Parameters:

{string} - server Protocol, hostname and path to the remote handler.

{string} - service Path to service to invoke.

{function(object)} - success Method that is invoked if the server responds with a success (per jQuery ajax)

{function(string)} - failure Method that is invoked if the server responds with an error (per jQuery ajax) or a non-200/300.

upgradeHttpToHttps

protected static String upgradeHttpToHttps(String url)

getSuccessJSONCallback

protected static org.stjs.javascript.functions.Callback1<String> getSuccessJSONCallback(org.stjs.javascript.functions.Callback1<Object> success,
                                                                                        org.stjs.javascript.functions.Callback1<String> failure)