Trace:
Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
jvx:common:util:rest [2019/03/05 08:54] admin |
jvx:common:util:rest [2020/06/29 13:42] cduncan [Storage Access (CRUD, Metadata)] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ~~Title: REST service~~ | + | ~~Title: REST Services~~ |
- | We define the business logic with [[jvx:server:lco:objects|life-cycle objects]] on the server side. The access authorization of an application is checked by a [[jvx:server:security:manager|security manager]]. The business logic is usually available via master- or subconnections from the client. | + | We define the business logic with [[jvx:server:lco:objects|life cycle objects]] on the server side. The access authorization of an application is checked by a [[jvx:server:security:manager|security manager]]. The business logic is usually available via master- or subconnections from the client. |
In order to complete the technology independence, the complete business logic of an application is also available via REST. | In order to complete the technology independence, the complete business logic of an application is also available via REST. | ||
Line 7: | Line 7: | ||
For the use of the REST services, the authentication with username and password is necessary. [[https://en.wikipedia.org/wiki/Basic_access_authentication|BASIC]] is used as the authentication mechanism. The credentials are checked by the security manager of the application as usual. You do not need to change a source code line to integrate the REST services. | For the use of the REST services, the authentication with username and password is necessary. [[https://en.wikipedia.org/wiki/Basic_access_authentication|BASIC]] is used as the authentication mechanism. The credentials are checked by the security manager of the application as usual. You do not need to change a source code line to integrate the REST services. | ||
- | =====How it works===== | + | =====How It Works===== |
The REST implementation in JVx has been implemented with [[http://www.restlet.org/|Restlet]]. To use the REST services, the deployment descriptor must be configured as follows: | The REST implementation in JVx has been implemented with [[http://www.restlet.org/|Restlet]]. To use the REST services, the deployment descriptor must be configured as follows: | ||
Line 30: | Line 30: | ||
With this configuration, the following services are available: | With this configuration, the following services are available: | ||
- | ===== Available services ===== | + | ===== Available Services ===== |
- | ====Storage access (CRUD, Meta Data)==== | + | ==== Administration ==== |
+ | |||
+ | Various services are available for the administration. These can only be used by POST requests in the standard case. However, if certain custom services have been registered, they can also be addressed via GET request. | ||
+ | |||
+ | The following services are available by default: | ||
+ | |||
+ | * [[#test_authentication|Test authentication]] | ||
+ | * [[#change_password|Change password]] | ||
+ | |||
+ | === Test Authentication === | ||
+ | |||
+ | Test URL:\\ | ||
+ | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/_admin/**<fc #BF0000>testAuthentication</fc>**'' \\ | ||
+ | or \\ | ||
+ | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/_admin/**<fc #BF0000>testAuthentication</fc>**/**<fc #BF0000>parameter</fc>**'' | ||
+ | |||
+ | The request requires a HashMap in JSON format. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <file json> | ||
+ | { "username" : "admin", | ||
+ | "password" : "adminpassword" | ||
+ | } | ||
+ | </file> | ||
+ | |||
+ | The username can also be omitted. In this case, the parameter from the URL will be used as the username. | ||
+ | |||
+ | == POST-Response == | ||
+ | |||
+ | If the login was successful, no response is generated and the status code is 204 (SUCCESS_NO_CONTENT). | ||
+ | |||
+ | === Change Password === | ||
+ | |||
+ | Test URL:\\ | ||
+ | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/_admin/**<fc #BF0000>changePassword</fc>**'' \\ | ||
+ | or \\ | ||
+ | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/_admin/**<fc #BF0000>changePassword</fc>**/**<fc #BF0000>parameter</fc>**'' | ||
+ | |||
+ | The request requires a HashMap in JSON format. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <file json> | ||
+ | { "username" : "admin", | ||
+ | "oldpassword" : "oldpassword", | ||
+ | "newpassword" : "newpassword" | ||
+ | } | ||
+ | </file> | ||
+ | |||
+ | The username can also be omitted. In this case, the parameter from the URL will be used as the username. | ||
+ | |||
+ | == POST-Response == | ||
+ | |||
+ | If the password has been changed, no response is generated and the status code is 204 (SUCCESS_NO_CONTENT). | ||
+ | |||
+ | === Custom Services === | ||
+ | |||
+ | If you want to register your own service at runtime, this can be done by | ||
+ | |||
+ | <code java> | ||
+ | AdminService.register(String pApplicationName, String pAction, IAdminServiceDelegate pDelegate); | ||
+ | AdminService.unregister(String pApplicationName, String pAction, Class<? extends IAdminServiceDelegate> pClass) | ||
+ | </code> | ||
+ | |||
+ | The service can be addressed either via GET or POST request, depending on whether ** // IAdminServiceGetDelegate // ** or ** // IAdminServicePostDelegate // ** is used. | ||
+ | |||
+ | Test URL: | ||
+ | |||
+ | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/_admin/**<fc #BF0000>ACTION</fc>**'' \\ | ||
+ | or \\ | ||
+ | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/_admin/**<fc #BF0000>ACTION</fc>**/**<fc #BF0000>parameter</fc>**'' | ||
+ | |||
+ | ====Storage Access (CRUD, Metadata)==== | ||
* [[#get-request_select|Select]] | * [[#get-request_select|Select]] | ||
Line 38: | Line 111: | ||
* [[#put-request_update|Update]] | * [[#put-request_update|Update]] | ||
* [[#delete-request_delete|Delete]] | * [[#delete-request_delete|Delete]] | ||
- | * [[#options-request_meta_data|Meta Data]] | + | * [[#options-request_meta_data|Metadata]] |
==GET-Request (Select)== | ==GET-Request (Select)== | ||
Line 117: | Line 190: | ||
== PUT-Request (Update) == | == PUT-Request (Update) == | ||
- | Update a requord with Primary Key: | + | Update a record with Primary Key: |
''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/data/**<fc #BF0000>STORAGE_NAME</fc>**/**<fc #BF0000>PRIMARY_KEY</fc>**'' | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/data/**<fc #BF0000>STORAGE_NAME</fc>**/**<fc #BF0000>PRIMARY_KEY</fc>**'' | ||
Line 169: | Line 242: | ||
</file> | </file> | ||
- | ==OPTIONS-Request (Meta Data)== | + | ==OPTIONS-Request (Metadata)== |
- | Request Meta Data: | + | Request Metadata: |
''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/data/**<fc #BF0000>STORAGE_NAME</fc>**'' | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/**<fc #BF0000>LIFECYCLE_CLASS</fc>**/data/**<fc #BF0000>STORAGE_NAME</fc>**'' | ||
==OPTIONS-Response== | ==OPTIONS-Response== | ||
- | The response returns the meta data in JSON format: | + | The response returns the metadata in JSON format: |
<file json> | <file json> | ||
Line 322: | Line 395: | ||
\\ | \\ | ||
- | ==== Call actions ==== | + | ==== Call Actions ==== |
The [[jvx:communication:calling_server_action|server-side actions]] can be called directly from the life-cycle object as well as from available business objects. It's also possible to use parameters. | The [[jvx:communication:calling_server_action|server-side actions]] can be called directly from the life-cycle object as well as from available business objects. It's also possible to use parameters. | ||
Line 374: | Line 447: | ||
===== Examples ===== | ===== Examples ===== | ||
+ | |||
+ | ==== Integration ==== | ||
Using php: | Using php: | ||
Line 389: | Line 464: | ||
curl_close($ch); | curl_close($ch); | ||
+ | </file> | ||
+ | |||
+ | Using Javascript: | ||
+ | |||
+ | <file html rest.html> | ||
+ | <html> | ||
+ | <head> | ||
+ | <script> | ||
+ | function doRest() { | ||
+ | const http = new XMLHttpRequest(); | ||
+ | const url='https://<server>/DB/services/rest/League/Standings/action/getResults'; | ||
+ | |||
+ | http.open("POST", url, true, 'user', 'password'); | ||
+ | http.withCredentials = true; | ||
+ | http.send("[88]"); | ||
+ | |||
+ | http.onreadystatechange=(e)=> | ||
+ | { | ||
+ | if (http.readyState == 4) | ||
+ | { | ||
+ | console.log(atob(eval(http.responseText))); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </script> | ||
+ | </head> | ||
+ | <body> | ||
+ | <button type="button" onclick="doRest()">REST call</button> | ||
+ | </body> | ||
+ | </html> | ||
</file> | </file> | ||
Line 396: | Line 501: | ||
[[https://blog.sibvisions.com/2016/02/29/using-oracle-jet-with-visionxjvx/|Oracle JET with VisionX/JVx]] \\ | [[https://blog.sibvisions.com/2016/02/29/using-oracle-jet-with-visionxjvx/|Oracle JET with VisionX/JVx]] \\ | ||
- | JUnit Tests: | + | ==== JUnit Tests ==== |
[[https://sourceforge.net/p/jvx/code/HEAD/tree/trunk/java/library/test/com/sibvisions/rad/server/http/rest/TestCallService.java|TestCallService]] for the Lifecycle objects: [[https://sourceforge.net/p/jvx/code/HEAD/tree/trunk/java/library/rad/apps/demo/src.server/demo/Session.java|Session]] and [[https://sourceforge.net/p/jvx/code/HEAD/tree/trunk/java/library/rad/apps/demo/src.server/demo/special/Address.java|Address]] | [[https://sourceforge.net/p/jvx/code/HEAD/tree/trunk/java/library/test/com/sibvisions/rad/server/http/rest/TestCallService.java|TestCallService]] for the Lifecycle objects: [[https://sourceforge.net/p/jvx/code/HEAD/tree/trunk/java/library/rad/apps/demo/src.server/demo/Session.java|Session]] and [[https://sourceforge.net/p/jvx/code/HEAD/tree/trunk/java/library/rad/apps/demo/src.server/demo/special/Address.java|Address]] |