org.cyclos.services.access

Interface ServiceFacade

public interface ServiceFacade

A facade used to invoke service methods from web clients

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GLOBAL_ROOT_PATH The root path to identify the global "network"

Method Summary

Modifier and Type	Method and Description
ResponseInfo	handleInboundSms(RequestInfo request) Handles an inbound SMS request, returning the response which should be returned to the gateway
InvocationResult	invoke(InvocationData data) Invokes a service method according to the given InvocationData
RequestData	resolveRequestData(java.lang.String remoteAddress, java.lang.String rootUrl, java.lang.String uri) Returns the route data about a given request URI.
ResponseInfo	runCustomWebService(InvocationData invocationData, RequestInfo request) Runs as guest the custom web service (if any) mapped to request's uri.

Field Detail

GLOBAL_ROOT_PATH

static final java.lang.String GLOBAL_ROOT_PATH

The root path to identify the global "network"

See Also:

Constant Field Values

Method Detail

handleInboundSms

ResponseInfo handleInboundSms(RequestInfo request)

Handles an inbound SMS request, returning the response which should be returned to the gateway

invoke

InvocationResult invoke(InvocationData data)
                 throws FrameworkException,
                        BusinessException,
                        IllegalInvocationException

Invokes a service method according to the given InvocationData

Throws:

FrameworkException

BusinessException

IllegalInvocationException

resolveRequestData

RequestData resolveRequestData(java.lang.String remoteAddress,
                               java.lang.String rootUrl,
                               java.lang.String uri)
                        throws FrameworkException

Returns the route data about a given request URI. The return will contain the matched network id and internal name (if not on global mode), the resolved configuration id (if null, should be handled as a not found on client) and the final URI (after removing the network root path and guest configuration key)

Throws:

FrameworkException

runCustomWebService

ResponseInfo runCustomWebService(InvocationData invocationData,
                                 RequestInfo request)
                          throws FrameworkException,
                                 BusinessException

Runs as guest the custom web service (if any) mapped to request's uri.

Throws:

FrameworkException

BusinessException