jadex.extension.rs.invoke

Class RestInvocationHelper

java.lang.Object

jadex.extension.rs.invoke.RestInvocationHelper

public class RestInvocationHelper
extends java.lang.Object

Simple API for calling JSON-based REST services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestInvocationHelper.RequestFailedException Exception

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	USE_THREADS Use daemon threads for REST call.

Constructor Summary

Constructors

Constructor and Description
RestInvocationHelper() Creates the helper.

Method Summary

Modifier and Type	Method and Description
jadex.commons.future.IFuture<java.lang.String>	invokeJson(jadex.bridge.IInternalAccess component, java.lang.String uri, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> headers, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.Class<?> resttype, boolean inurlparams) Invokes the REST service for a JSON response.
jadex.commons.future.IFuture<java.lang.String>	invokeJson(jadex.bridge.IInternalAccess component, java.lang.String uri, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> headers, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String postplainjson, java.lang.Class<?> resttype, boolean inurlparams) Invokes the REST service for a JSON response.
static void	performRequest(jadex.bridge.IExternalAccess exta, java.lang.String uri, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> headers, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String postplainjson, java.lang.Class<?> resttype, boolean inurlparams, jadex.commons.future.Future<java.lang.String> ret) Perform the REST call.

Methods inherited from class java.lang.Object

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

Field Detail

USE_THREADS

public static boolean USE_THREADS

Use daemon threads for REST call.

Constructor Detail

RestInvocationHelper

public RestInvocationHelper()

Creates the helper.

Parameters:

component - The component using this helper.

Method Detail

invokeJson

public jadex.commons.future.IFuture<java.lang.String> invokeJson(jadex.bridge.IInternalAccess component,
                                                                 java.lang.String uri,
                                                                 java.lang.String path,
                                                                 java.util.Map<java.lang.String,java.lang.Object> headers,
                                                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                                                 java.lang.Class<?> resttype,
                                                                 boolean inurlparams)

Invokes the REST service for a JSON response.

Parameters:

uri - URI to invoke.

path - Path to invoke.

headers - Header fields.

params - Parameters.

Returns:

Reply string

invokeJson

public jadex.commons.future.IFuture<java.lang.String> invokeJson(jadex.bridge.IInternalAccess component,
                                                                 java.lang.String uri,
                                                                 java.lang.String path,
                                                                 java.util.Map<java.lang.String,java.lang.Object> headers,
                                                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                                                 java.lang.String postplainjson,
                                                                 java.lang.Class<?> resttype,
                                                                 boolean inurlparams)

Invokes the REST service for a JSON response.

Parameters:

uri - URI to invoke.

path - Path to invoke.

headers - Header fields.

params - Parameters.

Returns:

Reply string

performRequest

public static final void performRequest(jadex.bridge.IExternalAccess exta,
                                        java.lang.String uri,
                                        java.lang.String path,
                                        java.util.Map<java.lang.String,java.lang.Object> headers,
                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                        java.lang.String postplainjson,
                                        java.lang.Class<?> resttype,
                                        boolean inurlparams,
                                        jadex.commons.future.Future<java.lang.String> ret)

Perform the REST call.