Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 10
Next »
Unknown macro: {sub-section} Using the RESTful Web Service plugin business logic can be exposed as a RESTful Web Service.
The RESTful Web Service plugin does not contain any client side functions or properties, it is a 100% server side operating plugin.
To create a RESTful Web Service, create a form in a solution and add the following methods to the form:
- ws_read() to retrieve data
By performing an HTTP GET on the url <serverUrl>/servoy-service/rest_ws/solutionName/formName, the ws_read() method will be invoked. Arguments can be specified in the url, like <serverUrl>/servoy-service/rest_ws/solutionName/formName/value1/value2. The arguments will be applied to the invokation of ws_read().
- ws_create() to add data
By performing an HTTP POST on the url <serverUrl>/servoy-service/rest_ws/solutionName/formName, the ws_create() method will be invoked. Data can be supplied in the body of the HTTP request.
- ws_delete() to remove data
By performing an HTTP DELETE on the url <serverUrl>/servoy-service/rest_ws/solutionName/formName, the ws_delete() method will be invoked. Arguments can be specified in the url, like <serverUrl>/servoy-service/rest_ws/solutionName/formName/value1/value2. The arguments will be applied to the invokation of ws_delete().
- ws_update() to update data
By performing an HTTP PUT on the url <serverUrl>/servoy-service/rest_ws/solutionName/formName, the ws_delete() method will be invoked.Data can be supplied in the body of the HTTP request.
On a specific form, not all operations have to be supported. In case a request is done to the API for a non existing operation, the API will return a HTTP 503 result code
A sample solution is included in the Servoy distribution (servoy_sample_rest_ws.servoy), detailing how to retrieve data from the http request and to return a response.
RESTful Web Services are to be stateless. As subsequent requests to the RESTful Web Service API might be handled by different headless clients in the pool of clients configured for the plugin, do not use any state in between calls to the API. This means at least the following:
- Do not use global or form variables
- Do not use the solution model API
- Do not alter the state of the a form's UI
- Do save or rollback any unsaved changes
For more information on RESTful Web Services, see:
http://en.wikipedia.org/wiki/Representational_State_Transfer
http://www.infoq.com/articles/rest-introduction
http://www.ibm.com/developerworks/webservices/library/ws-restful/
http://home.ccil.org/~cowan/restws.pdf
Unknown macro: {table}
{column:width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Server Property Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {table}
{column:width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Server Property Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} rest_ws_plugin_client_pool_exhausted_action
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Action when no more clients are availiable (block/fail/grow), default = block
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} rest_ws_plugin_client_pool_size
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Max number of clients used (this defines the number of concurrent requests and licences used), default = 5
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td}