me.adaptive.arp.api

Class ServiceBridge

java.lang.Object

me.adaptive.arp.api.BaseCommunicationBridge

me.adaptive.arp.api.ServiceBridge

All Implemented Interfaces:

APIBridge, IAdaptiveRP, IBaseCommunication, IService

public class ServiceBridge
extends BaseCommunicationBridge
implements IService, APIBridge

Interface for Managing the Services operations Auto-generated implementation of IService specification.

Field Summary

Fields inherited from class me.adaptive.arp.api.BaseCommunicationBridge

apiGroup

Constructor Summary

Constructors

Constructor and Description
ServiceBridge(IService delegate) Constructor with delegate.

Method Summary

Modifier and Type	Method and Description
IService	getDelegate() Get the delegate implementation.
ServiceRequest	getServiceRequest(ServiceToken serviceToken) Create a service request for the given ServiceToken.
ServiceToken[]	getServicesRegistered() Returns all the possible service tokens configured in the platform's XML service definition file.
ServiceToken	getServiceToken(java.lang.String serviceName, java.lang.String endpointName, java.lang.String functionName, IServiceMethod method) Obtains a ServiceToken for the given parameters to be used for the creation of requests.
ServiceToken	getServiceTokenByUri(java.lang.String uri) Obtains a Service token by a concrete uri (http://domain.com/path).
APIResponse	invoke(APIRequest request) Invokes the given method specified in the API request object.
void	invokeService(ServiceRequest serviceRequest, IServiceResultCallback callback) Executes the given ServiceRequest and provides responses to the given callback handler.
boolean	isServiceRegistered(java.lang.String serviceName, java.lang.String endpointName, java.lang.String functionName, IServiceMethod method) Checks whether a specific service, endpoint, function and method type is configured in the platform's XML service definition file.
void	setDelegate(IService delegate) Set the delegate implementation.

Methods inherited from class me.adaptive.arp.api.BaseCommunicationBridge

getAPIGroup, getAPIVersion, getJSONParser

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.adaptive.arp.api.IAdaptiveRP

getAPIGroup, getAPIVersion

Constructor Detail

ServiceBridge

public ServiceBridge(IService delegate)

Constructor with delegate.

Parameters:

delegate - The delegate implementing platform specific functions.

Method Detail

getDelegate

public final IService getDelegate()

Get the delegate implementation.

Returns:

IService delegate that manages platform specific functions..

setDelegate

public final void setDelegate(IService delegate)

Set the delegate implementation.

Parameters:

delegate - The delegate implementing platform specific functions.

getServiceRequest

public ServiceRequest getServiceRequest(ServiceToken serviceToken)

Create a service request for the given ServiceToken. This method creates the request, populating existing headers and cookies for the same service. The request is populated with all the defaults for the service being invoked and requires only the request body to be set. Headers and cookies may be manipulated as needed by the application before submitting the ServiceRequest via invokeService.

Specified by:

getServiceRequest in interface IService

Parameters:

serviceToken - ServiceToken to be used for the creation of the request.

Returns:

ServiceRequest with pre-populated headers, cookies and defaults for the service.

Since:

v2.0.6

getServiceToken

public ServiceToken getServiceToken(java.lang.String serviceName,
                                    java.lang.String endpointName,
                                    java.lang.String functionName,
                                    IServiceMethod method)

Obtains a ServiceToken for the given parameters to be used for the creation of requests.

Specified by:

getServiceToken in interface IService

Parameters:

serviceName - Service name.

endpointName - Endpoint name.

functionName - Function name.

method - Method type.

Returns:

ServiceToken to create a service request or null if the given parameter combination is not configured in the platform's XML service definition file.

Since:

v2.0.6

getServiceTokenByUri

public ServiceToken getServiceTokenByUri(java.lang.String uri)

Obtains a Service token by a concrete uri (http://domain.com/path). This method would be useful when a service response is a redirect (3XX) and it is necessary to make a request to another host and we don't know by advance the name of the service.

Specified by:

getServiceTokenByUri in interface IService

Parameters:

uri - Unique Resource Identifier for a Service-Endpoint-Path-Method

Returns:

ServiceToken to create a service request or null if the given parameter is not configured in the platform's XML service definition file.

Since:

v2.1.4

getServicesRegistered

public ServiceToken[] getServicesRegistered()

Returns all the possible service tokens configured in the platform's XML service definition file.

Specified by:

getServicesRegistered in interface IService

Returns:

Array of service tokens configured.

Since:

v2.0.6

invokeService

public void invokeService(ServiceRequest serviceRequest,
                          IServiceResultCallback callback)

Executes the given ServiceRequest and provides responses to the given callback handler.

Specified by:

invokeService in interface IService

Parameters:

serviceRequest - ServiceRequest with the request body.

callback - IServiceResultCallback to handle the ServiceResponse.

Since:

v2.0.6

isServiceRegistered

public boolean isServiceRegistered(java.lang.String serviceName,
                                   java.lang.String endpointName,
                                   java.lang.String functionName,
                                   IServiceMethod method)

Checks whether a specific service, endpoint, function and method type is configured in the platform's XML service definition file.

Specified by:

isServiceRegistered in interface IService

Parameters:

serviceName - Service name.

endpointName - Endpoint name.

functionName - Function name.

method - Method type.

Returns:

Returns true if the service is configured, false otherwise.

Since:

v2.0.6

invoke

public APIResponse invoke(APIRequest request)

Invokes the given method specified in the API request object.

Specified by:

invoke in interface APIBridge

Overrides:

invoke in class BaseCommunicationBridge

Parameters:

request - APIRequest object containing method name and parameters.

Returns:

APIResponse with status code, message and JSON response or a JSON null string for void functions. Status code 200 is OK, all others are HTTP standard error conditions.