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

Methods

Modifier and Type	Method and Description
java.lang.String	externalRedirectCallback(java.lang.Long externalOperationId, RequestInfo request) Handles a request callback for a custom operation of type external redirect
ResponseInfo	handleInboundSms(RequestInfo request) Handles an inbound SMS request, returning the response which should be returned to the gateway
void	invalidateSession(java.lang.String remoteAddress, java.lang.String token) Invalidates the given session, under the given remote address, if it exists
InvocationResult	invoke(InvocationData data) Invokes a service method according to the given InvocationData
boolean	isLoggedIn(java.lang.String remoteAddress, java.lang.String sessionToken) Returns whether there is a logged user with the given remote address and session token
Pair<UserAuthVO,java.lang.String>	login(RequestData requestData, java.lang.String channel, UserLocatorVO locator, java.lang.String password) Attempts to login the user, returning the authenticated user and the generated session identifier if succeeded, or throwing a LoginException
java.lang.String	resolveNewNetworkUrl(java.lang.String remoteAddress, java.lang.String sessionToken, java.lang.Long networkId) Returns the url a global admin can use to switch to the given network, validating that there is a global admin logged in
RequestData	resolveRequestData(java.lang.String remoteAddress, java.lang.String rootUrl, java.lang.String uri) Returns the route data about a given request 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

externalRedirectCallback

java.lang.String externalRedirectCallback(java.lang.Long externalOperationId,
                                        RequestInfo request)
                                          throws FrameworkException

Handles a request callback for a custom operation of type external redirect

Throws:

FrameworkException

handleInboundSms

ResponseInfo handleInboundSms(RequestInfo request)

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

invalidateSession

void invalidateSession(java.lang.String remoteAddress,
                     java.lang.String token)
                       throws FrameworkException

Invalidates the given session, under the given remote address, if it exists

Throws:

FrameworkException

invoke

InvocationResult invoke(InvocationData data)
                        throws FrameworkException,
                               IllegalInvocationException

Invokes a service method according to the given InvocationData

Throws:

FrameworkException

IllegalInvocationException

isLoggedIn

boolean isLoggedIn(java.lang.String remoteAddress,
                 java.lang.String sessionToken)
                   throws FrameworkException

Returns whether there is a logged user with the given remote address and session token

Throws:

FrameworkException

login

Pair<UserAuthVO,java.lang.String> login(RequestData requestData,
                                      java.lang.String channel,
                                      UserLocatorVO locator,
                                      java.lang.String password)
                                        throws FrameworkException,
                                               LoginException,
                                               RemoteAddressBlockedException

Attempts to login the user, returning the authenticated user and the generated session identifier if succeeded, or throwing a LoginException

Throws:

LoginException - When the given user locator / password combination is invalid

RemoteAddressBlockedException - When the remote address has been temporarily blocked to login by exceeding the number of invalid tries attempts

FrameworkException

resolveNewNetworkUrl

java.lang.String resolveNewNetworkUrl(java.lang.String remoteAddress,
                                    java.lang.String sessionToken,
                                    java.lang.Long networkId)
                                      throws FrameworkException

Returns the url a global admin can use to switch to the given network, validating that there is a global admin logged in

Throws:

FrameworkException

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