public final class ModelDataServiceCall extends java.lang.Object implements java.util.concurrent.Callable<ModelDataServiceCall>
Example of an simple synchronous service call:
Example of an asynchronous service call:ModelDataServiceCall resp = new ModelDataServiceCall() .put("temp", 100, "C") // add input data .withDefaultLogger() // use the default logger .url("http://localhost:8080/csip-example/m/simpleservice/2.0") // url .call(); // perform the call if (resp.serviceFinished()) { System.out.println(resp.get("temp")); }
ModelDataServiceCall resp = new ModelDataServiceCall() .put("temp", 100, "C") // add input data .asAsync() // call async .withAsyncCallback(mds -@lt; { // optional callback (e.g. to print progess) System.out.println(mds.getProgress()); }) .url("http://localhost:8080/csip-example/m/simpleservice/2.0") .call(); if (resp.serviceFinished()) { System.out.println(resp.get("temp")); }
Modifier and Type | Class and Description |
---|---|
static class |
ModelDataServiceCall.ConfAccess |
Constructor and Description |
---|
ModelDataServiceCall()
Create a new Call.
|
Modifier and Type | Method and Description |
---|---|
ModelDataServiceCall |
asAsync()
Call the service asynchronously.
|
ModelDataServiceCall |
asSync(boolean sync)
Call the service asynchronously or synchronously.
|
ModelDataServiceCall |
attach(java.io.File... files)
Attach files to the request.
|
ModelDataServiceCall |
call()
Call the service.
|
boolean |
callFailed() |
java.lang.String |
download(java.lang.String name) |
void |
download(java.lang.String name,
java.io.File file) |
static ModelDataServiceCall |
fromJSON(java.io.File jsonRequest) |
static ModelDataServiceCall |
fromJSON(java.lang.String jsonRequest) |
static ModelDataServiceCall |
fromJSON(java.net.URL jsonRequest) |
java.lang.Object |
get(java.lang.String name) |
java.lang.Object |
get(java.lang.String name,
java.lang.Object def) |
boolean |
getBoolean(java.lang.String name) |
boolean |
getBoolean(java.lang.String name,
boolean def) |
int |
getCount() |
double |
getDouble(java.lang.String name) |
double |
getDouble(java.lang.String name,
double def) |
java.lang.String |
getError()
Get the metainfo 'error' value.
|
int |
getFirstPoll()
Get the frist poll value.
|
int |
getInt(java.lang.String name) |
int |
getInt(java.lang.String name,
int def) |
org.codehaus.jettison.json.JSONArray |
getJSONArray(java.lang.String name) |
org.codehaus.jettison.json.JSONArray |
getJSONArray(java.lang.String name,
org.codehaus.jettison.json.JSONArray def) |
org.codehaus.jettison.json.JSONObject |
getJSONObject(java.lang.String name) |
org.codehaus.jettison.json.JSONObject |
getJSONObject(java.lang.String name,
org.codehaus.jettison.json.JSONObject def) |
long |
getLong(java.lang.String name) |
long |
getLong(java.lang.String name,
long def) |
java.lang.Object |
getMeta(java.lang.String name) |
java.lang.String |
getMetaString(java.lang.String key) |
java.util.List<java.lang.String> |
getNames() |
int |
getNextPoll()
Get the next poll value.
|
ModelDataServiceCall |
getParent() |
java.lang.String |
getProgress()
Get the progress string (for async calls.)
|
java.lang.String |
getString(java.lang.String name) |
java.lang.String |
getString(java.lang.String name,
java.lang.String def) |
java.lang.String |
getSUID()
Get the SUID.
|
boolean |
has(java.lang.String name) |
boolean |
hasMeta(java.lang.String name) |
ModelDataServiceCall |
put(java.lang.String name,
boolean value) |
ModelDataServiceCall |
put(java.lang.String name,
boolean[] value) |
ModelDataServiceCall |
put(java.lang.String name,
java.util.Collection value) |
ModelDataServiceCall |
put(java.lang.String name,
double value) |
ModelDataServiceCall |
put(java.lang.String name,
double[] value) |
ModelDataServiceCall |
put(java.lang.String name,
double[] value,
java.lang.String unit) |
ModelDataServiceCall |
put(java.lang.String name,
double value,
java.lang.String unit) |
ModelDataServiceCall |
put(java.lang.String name,
int value) |
ModelDataServiceCall |
put(java.lang.String name,
int[] value) |
ModelDataServiceCall |
put(java.lang.String name,
org.codehaus.jettison.json.JSONArray value) |
ModelDataServiceCall |
put(java.lang.String name,
org.codehaus.jettison.json.JSONObject value) |
ModelDataServiceCall |
put(java.lang.String name,
java.lang.String value) |
ModelDataServiceCall |
put(java.lang.String name,
java.lang.String[] value) |
ModelDataServiceCall |
put(java.lang.String name,
java.lang.String geomType,
org.codehaus.jettison.json.JSONArray geomCoordinates) |
ModelDataServiceCall |
putGeom(java.lang.String name,
org.codehaus.jettison.json.JSONObject value) |
ModelDataServiceCall |
putMeta(java.lang.String key,
java.lang.String value)
Add a meta data entry.
|
ModelDataServiceCall |
putMeta(java.lang.String key,
java.lang.String[] value)
Add a meta data entry from a String array.
|
org.codehaus.jettison.json.JSONObject |
request()
get the request as JSON
|
boolean |
serviceCancelled() |
boolean |
serviceFailed() |
boolean |
serviceFinished() |
boolean |
serviceReturned() |
boolean |
serviceRunning() |
boolean |
serviceSubmitted() |
boolean |
serviceTimeout() |
static void |
setCacheSize(int size) |
org.codehaus.jettison.json.JSONObject |
toJSON()
Get the JSON request/response
|
java.lang.String |
toString() |
ModelDataServiceCall |
url(java.lang.String url)
The url to call.
|
ModelDataServiceCall |
withAsyncCallback(java.util.function.Consumer<ModelDataServiceCall> callback)
Set a callback consumer.
|
ModelDataServiceCall |
withCache(boolean cache)
Deprecated.
|
ModelDataServiceCall |
withCache(csip.utils.PayloadCache cache)
Cache the service calls using the PayloadCache.
|
ModelDataServiceCall |
withDefaultLogger()
Use the default system logger.
|
ModelDataServiceCall |
withHeader(java.lang.String key,
java.lang.String value)
Add a custom header.
|
ModelDataServiceCall |
withLogger(java.util.logging.Logger l)
Use a custom logger.
|
ModelDataServiceCall |
withPolling(int first,
int next)
Use custom polling, overwrite the values provided by the service.
|
ModelDataServiceCall |
withRetries(int retries)
Number of retries for a call, (default is 3)
|
ModelDataServiceCall |
withRetryPause(long sleep)
Pause in ms between retries.
|
ModelDataServiceCall |
withTimeout(int timeout)
Set the timeout.
|
public static void setCacheSize(int size)
public static ModelDataServiceCall fromJSON(java.io.File jsonRequest) throws java.lang.Exception
java.lang.Exception
public static ModelDataServiceCall fromJSON(java.net.URL jsonRequest) throws java.lang.Exception
java.lang.Exception
public static ModelDataServiceCall fromJSON(java.lang.String jsonRequest) throws java.lang.Exception
java.lang.Exception
public ModelDataServiceCall put(java.lang.String name, java.util.Collection value)
public ModelDataServiceCall put(java.lang.String name, java.lang.String geomType, org.codehaus.jettison.json.JSONArray geomCoordinates)
public ModelDataServiceCall put(java.lang.String name, org.codehaus.jettison.json.JSONObject value)
public ModelDataServiceCall putGeom(java.lang.String name, org.codehaus.jettison.json.JSONObject value)
public ModelDataServiceCall put(java.lang.String name, org.codehaus.jettison.json.JSONArray value)
public ModelDataServiceCall put(java.lang.String name, java.lang.String value)
public ModelDataServiceCall put(java.lang.String name, java.lang.String[] value)
public ModelDataServiceCall put(java.lang.String name, boolean value)
public ModelDataServiceCall put(java.lang.String name, boolean[] value)
public ModelDataServiceCall put(java.lang.String name, int value)
public ModelDataServiceCall put(java.lang.String name, int[] value)
public ModelDataServiceCall put(java.lang.String name, double value)
public ModelDataServiceCall put(java.lang.String name, double value, java.lang.String unit)
public ModelDataServiceCall put(java.lang.String name, double[] value)
public ModelDataServiceCall put(java.lang.String name, double[] value, java.lang.String unit)
public ModelDataServiceCall attach(java.io.File... files)
files
- the list of files for attach.public ModelDataServiceCall putMeta(java.lang.String key, java.lang.String value)
key
- the keyvalue
- the valuepublic ModelDataServiceCall putMeta(java.lang.String key, java.lang.String[] value)
key
- the keyvalue
- the String arraypublic ModelDataServiceCall url(java.lang.String url)
url
- the urlpublic ModelDataServiceCall withDefaultLogger()
public ModelDataServiceCall withPolling(int first, int next)
first
- the first poll in msnext
- any subsequent poll in mspublic ModelDataServiceCall withLogger(java.util.logging.Logger l)
l
- the logger@Deprecated public ModelDataServiceCall withCache(boolean cache)
cache
- true if calls should be cached.public ModelDataServiceCall withCache(csip.utils.PayloadCache cache)
cache
- the payload cachepublic ModelDataServiceCall asAsync()
public ModelDataServiceCall asSync(boolean sync)
sync
- true if synchronously, false otherwisepublic ModelDataServiceCall withAsyncCallback(java.util.function.Consumer<ModelDataServiceCall> callback)
callback
- the consumerpublic ModelDataServiceCall withTimeout(int timeout)
timeout
- the timeout.public ModelDataServiceCall withHeader(java.lang.String key, java.lang.String value)
key
- the header keyvalue
- header valuepublic ModelDataServiceCall withRetries(int retries)
retries
- number of retriespublic ModelDataServiceCall withRetryPause(long sleep)
sleep
- the pause in ms.public org.codehaus.jettison.json.JSONObject request()
public org.codehaus.jettison.json.JSONObject toJSON()
public ModelDataServiceCall call() throws java.lang.Exception
call
in interface java.util.concurrent.Callable<ModelDataServiceCall>
java.lang.Exception
- if something goes wrongpublic java.util.List<java.lang.String> getNames()
public int getCount()
public void download(java.lang.String name, java.io.File file) throws java.lang.Exception
java.lang.Exception
public java.lang.String download(java.lang.String name) throws java.lang.Exception
java.lang.Exception
public java.lang.Object get(java.lang.String name)
public java.lang.Object get(java.lang.String name, java.lang.Object def)
public double getDouble(java.lang.String name)
public double getDouble(java.lang.String name, double def) throws ServiceException
ServiceException
public int getInt(java.lang.String name)
public int getInt(java.lang.String name, int def)
public long getLong(java.lang.String name)
public long getLong(java.lang.String name, long def)
public boolean getBoolean(java.lang.String name)
public boolean getBoolean(java.lang.String name, boolean def)
public java.lang.String getString(java.lang.String name)
public java.lang.String getString(java.lang.String name, java.lang.String def)
public org.codehaus.jettison.json.JSONObject getJSONObject(java.lang.String name)
public org.codehaus.jettison.json.JSONObject getJSONObject(java.lang.String name, org.codehaus.jettison.json.JSONObject def)
public org.codehaus.jettison.json.JSONArray getJSONArray(java.lang.String name)
public org.codehaus.jettison.json.JSONArray getJSONArray(java.lang.String name, org.codehaus.jettison.json.JSONArray def)
public boolean has(java.lang.String name)
public boolean hasMeta(java.lang.String name)
public java.lang.Object getMeta(java.lang.String name)
public java.lang.String getMetaString(java.lang.String key)
public java.lang.String getError()
public java.lang.String getSUID()
public int getFirstPoll()
public int getNextPoll()
public java.lang.String getProgress()
public boolean callFailed()
public boolean serviceFinished()
public boolean serviceSubmitted()
public boolean serviceRunning()
public boolean serviceFailed()
public boolean serviceCancelled()
public boolean serviceTimeout()
public boolean serviceReturned()
public ModelDataServiceCall getParent()
public java.lang.String toString()
toString
in class java.lang.Object
(c) 2012-2022, OMSLab, Colorado State University.