me.adaptive.arp.api

Interface IService

All Superinterfaces:

IAdaptiveRP, IBaseCommunication

All Known Implementing Classes:

ServiceBridge

public interface IService
extends IBaseCommunication

Interface for Managing the Services operations

Since:

v2.0

Method Summary

Modifier and Type	Method and Description
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).
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.

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

getAPIGroup, getAPIVersion

Method Detail

getServiceRequest

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.

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

getServiceTokenByUri

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.

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

getServiceToken

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.

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

getServicesRegistered

ServiceToken[] getServicesRegistered()

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

Returns:

Array of service tokens configured.

Since:

v2.0.6

invokeService

void invokeService(ServiceRequest serviceRequest,
                   IServiceResultCallback callback)

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

Parameters:

serviceRequest - ServiceRequest with the request body.

callback - IServiceResultCallback to handle the ServiceResponse.

Since:

v2.0.6

isServiceRegistered

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.

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