org.cyclos.services.access

Interface ServiceFacade

public interface ServiceFacade

A facade used to invoke service methods from web clients

Author:

luis

Method Summary

Modifier and Type	Method and Description
void	closeSubscription(java.lang.String id) Permanently closes the push notification subscription with the given id
java.lang.String	getResourceCacheKey() Returns a string which can be used to control cache of resources regarding this Cyclos version / compilation
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(boolean proxy, java.lang.String protocol, 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.
java.lang.String	subscribe(InvocationData invocation, java.lang.String clientId, java.lang.String lastEventId, PushNotificationEventFilter filter, java.util.function.Consumer<PushNotificationEvent<?>> listener) Subscribes a PushNotificationListener returning the subscription id.
void	timeoutSubscription(java.lang.String id) Marks the given push notification subscription as timed-out.

Method Detail

closeSubscription

void closeSubscription(java.lang.String id)

Permanently closes the push notification subscription with the given id

getResourceCacheKey

java.lang.String getResourceCacheKey()

Returns a string which can be used to control cache of resources regarding this Cyclos version / compilation

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(boolean proxy,
                               java.lang.String protocol,
                               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 always starting with '/' (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

subscribe

java.lang.String subscribe(InvocationData invocation,
                           java.lang.String clientId,
                           java.lang.String lastEventId,
                           PushNotificationEventFilter filter,
                           java.util.function.Consumer<PushNotificationEvent<?>> listener)

Subscribes a PushNotificationListener returning the subscription id.

timeoutSubscription

void timeoutSubscription(java.lang.String id)

Marks the given push notification subscription as timed-out. It means it will enqueue missed events, so if a new reconnection with the same client id shows up, it will send all missed events.