me.adaptive.arp.impl

Class ServiceDelegate

java.lang.Object

me.adaptive.arp.impl.BaseCommunicationDelegate

me.adaptive.arp.impl.ServiceDelegate

All Implemented Interfaces:

me.adaptive.arp.api.IAdaptiveRP, me.adaptive.arp.api.IBaseCommunication, me.adaptive.arp.api.IService

public class ServiceDelegate
extends BaseCommunicationDelegate
implements me.adaptive.arp.api.IService

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

Constructor Summary

Constructors

Constructor and Description
ServiceDelegate() Default Constructor.

Method Summary

Modifier and Type	Method and Description
me.adaptive.arp.api.ServiceRequest	getServiceRequest(me.adaptive.arp.api.ServiceToken serviceToken) Create a service request for the given ServiceToken.
me.adaptive.arp.api.ServiceToken[]	getServicesRegistered() Returns all the possible service tokens configured in the platform's XML service definition file.
me.adaptive.arp.api.ServiceToken	getServiceToken(java.lang.String serviceName, java.lang.String endpointName, java.lang.String functionName, me.adaptive.arp.api.IServiceMethod method) Obtains a ServiceToken for the given parameters to be used for the creation of requests.
me.adaptive.arp.api.ServiceToken	getServiceTokenByUri(java.lang.String uri) Obtains a Service token by a concrete uri (http://domain.com/path).
void	invokeService(me.adaptive.arp.api.ServiceRequest serviceRequest, me.adaptive.arp.api.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, me.adaptive.arp.api.IServiceMethod method) Checks whether a specific service, endpoint, function and method type is configured in the platform's XML service definition file.

Methods inherited from class me.adaptive.arp.impl.BaseCommunicationDelegate

getAPIGroup, getAPIVersion

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

ServiceDelegate

public ServiceDelegate()

Default Constructor.

Method Detail

getServiceRequest

public me.adaptive.arp.api.ServiceRequest getServiceRequest(me.adaptive.arp.api.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 me.adaptive.arp.api.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 me.adaptive.arp.api.ServiceToken getServiceToken(java.lang.String serviceName,
                                                        java.lang.String endpointName,
                                                        java.lang.String functionName,
                                                        me.adaptive.arp.api.IServiceMethod method)

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

Specified by:

getServiceToken in interface me.adaptive.arp.api.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 me.adaptive.arp.api.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 me.adaptive.arp.api.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 me.adaptive.arp.api.ServiceToken[] getServicesRegistered()

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

Specified by:

getServicesRegistered in interface me.adaptive.arp.api.IService

Returns:

Array of service tokens configured.

Since:

v2.0.6

invokeService

public void invokeService(me.adaptive.arp.api.ServiceRequest serviceRequest,
                          me.adaptive.arp.api.IServiceResultCallback callback)

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

Specified by:

invokeService in interface me.adaptive.arp.api.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,
                                   me.adaptive.arp.api.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 me.adaptive.arp.api.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