Package org.cyclos.impl.system

Interface CustomWebServiceServiceLocal

All Superinterfaces:

CRUDService<CustomWebServiceDTO,CustomWebServiceData,Void>, CRUDServiceLocal<CustomWebService,CustomWebServiceDTO,CustomWebServiceData,Void>, CustomWebServiceService, Service

All Known Implementing Classes:

CustomWebServiceServiceImpl

public interface CustomWebServiceServiceLocal
extends CRUDServiceLocal<CustomWebService,CustomWebServiceDTO,CustomWebServiceData,Void>, CustomWebServiceService

Local interface for CustomWebServiceService

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CUSTOM_WEB_SERVICE	Script binding attribute: The CustomWebService being executed
static String	ATTR_PATH	Script binding attribute: Path resolved for the custom web service call
static String	ATTR_PATH_VARIABLES	Script binding attribute: A ParameterStorage with the resolved path variables
static String	ATTR_REQUEST	Script binding attribute: The RequestInfo of the current call

Method Summary

Modifier and Type	Method	Description
List<CustomWebService>	listUser()	Returns a list with custom web services which require an authenticated user
void	prepareContext(CustomWebServiceContext context, SessionData runAs, RequestInfo request)	Collects in the given context all information needed to run a custom web service.
ResponseInfo	run(CustomWebServiceContext context)	Runs the custom web service associated to the request's uri.

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.system.CustomWebServiceService

list

Field Detail

ATTR_CUSTOM_WEB_SERVICE

static final String ATTR_CUSTOM_WEB_SERVICE

Script binding attribute: The CustomWebService being executed

See Also:

Constant Field Values

ATTR_REQUEST

static final String ATTR_REQUEST

Script binding attribute: The RequestInfo of the current call

See Also:

Constant Field Values

ATTR_PATH

static final String ATTR_PATH

Script binding attribute: Path resolved for the custom web service call

See Also:

Constant Field Values

ATTR_PATH_VARIABLES

static final String ATTR_PATH_VARIABLES

Script binding attribute: A ParameterStorage with the resolved path variables

See Also:

Constant Field Values

Method Detail

listUser

List<CustomWebService> listUser()

Returns a list with custom web services which require an authenticated user

prepareContext

void prepareContext(CustomWebServiceContext context,
                    SessionData runAs,
                    RequestInfo request)

Collects in the given context all information needed to run a custom web service.

Parameters:

runAs - The session data resolved from client. May or may not be used, according to the resolved CustomWebService's RunAs field.

run

ResponseInfo run(CustomWebServiceContext context)

Runs the custom web service associated to the request's uri.

Throws:

ResponseException - When there is an error, indicates how the response is generated