Trace:
Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
jvx:common:util:rest [2020/07/22 13:16] cduncan Edited for English grammar (capitalization, punctuation, correct verb conjugation) |
jvx:common:util:rest [2022/11/17 11:13] admin |
||
---|---|---|---|
Line 40: | Line 40: | ||
* [[#test_authentication|Test authentication]] | * [[#test_authentication|Test authentication]] | ||
* [[#change_password|Change password]] | * [[#change_password|Change password]] | ||
+ | * [[#check_database|Check database]] | ||
=== Test Authentication === | === Test Authentication === | ||
Test URL:\\ | 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>**'' \\ | + | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/_admin/**<fc #BF0000>testAuthentication</fc>**'' \\ |
or \\ | 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>**'' | + | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/_admin/**<fc #BF0000>testAuthentication</fc>**/**<fc #BF0000>parameter</fc>**'' |
The request requires a HashMap in JSON format. | The request requires a HashMap in JSON format. | ||
Line 67: | Line 68: | ||
Test URL:\\ | 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>**'' \\ | + | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/_admin/**<fc #BF0000>changePassword</fc>**'' \\ |
or \\ | 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>**'' | + | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/_admin/**<fc #BF0000>changePassword</fc>**/**<fc #BF0000>parameter</fc>**'' |
The request requires a HashMap in JSON format. | The request requires a HashMap in JSON format. | ||
Line 87: | Line 88: | ||
If the password has been changed, no response is generated and the status code is 204 (SUCCESS_NO_CONTENT). | If the password has been changed, no response is generated and the status code is 204 (SUCCESS_NO_CONTENT). | ||
+ | |||
+ | === Check database === | ||
+ | |||
+ | Test URL:\\ | ||
+ | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/_admin/**<fc #BF0000>checkDB</fc>**'' | ||
+ | |||
+ | == GET-Response == | ||
+ | |||
+ | If the check was successful, no response is generated and the status code is 204 (SUCCESS_NO_CONTENT). If database is not available, status code 500 (SERVER_ERROR_INTERNAL) will be returned. It's also possible that the configuration can't be found. In this case, status code 503 (SERVER_ERROR_SERVICE_UNAVAILABLE) will be returned. | ||
=== Custom Services === | === Custom Services === | ||
Line 93: | Line 103: | ||
<code java> | <code java> | ||
- | AdminService.register(String pApplicationName, String pAction, IAdminServiceDelegate pDelegate); | + | UserService.register(String pApplicationName, String pAction, ICustomServiceDelegate pDelegate); |
- | AdminService.unregister(String pApplicationName, String pAction, Class<? extends IAdminServiceDelegate> pClass) | + | UserService.unregister(String pApplicationName, String pAction) |
</code> | </code> | ||
- | The service can be addressed either via GET or POST request, depending on whether ** // IAdminServiceGetDelegate // ** or ** // IAdminServicePostDelegate // ** is used. | + | The service can be addressed either via GET or POST request, depending on whether ** // ICustomServiceGetDelegate // ** or ** // ICustomServicePostDelegate // ** is used. |
Test URL: | 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>**'' \\ | + | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/_admin/**<fc #BF0000>ACTION</fc>**'' \\ |
or \\ | 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>**'' | + | ''<nowiki>http://server:port/webapp/services/rest/</nowiki>**<fc #BF0000>APPLICATION_NAME</fc>**/_admin/**<fc #BF0000>ACTION</fc>**/**<fc #BF0000>parameter</fc>**'' |
====Storage Access (CRUD, Metadata)==== | ====Storage Access (CRUD, Metadata)==== |