Author: tchemit Date: 2010-01-03 12:52:48 +0100 (Sun, 03 Jan 2010) New Revision: 67 Added: trunk/jredmine-client/src/site/apt/redmine_service.apt Modified: trunk/jredmine-client/src/site/apt/index.apt trunk/jredmine-client/src/site/site.xml Log: update documentation Modified: trunk/jredmine-client/src/site/apt/index.apt =================================================================== --- trunk/jredmine-client/src/site/apt/index.apt 2010-01-03 10:49:37 UTC (rev 66) +++ trunk/jredmine-client/src/site/apt/index.apt 2010-01-03 11:52:48 UTC (rev 67) @@ -109,17 +109,5 @@ Le client java qui interroge le plugin rails se base sur l'api du plugin rails et transforme les données retournées en xml en objets java. - La classe à utiliser est la suivante - --------------------------------------------------------------------------------- -org.nuiton.jredmine.DefaultRedmineService --------------------------------------------------------------------------------- - - qui réalise le contrat - --------------------------------------------------------------------------------- -org.nuiton.jredmine.RedmineService --------------------------------------------------------------------------------- - - - <Pour plus de détails, consulter la javadoc du module.> \ No newline at end of file + La {{{redmine_service.html}page suivante}} détaille les services disponibles + en java. Added: trunk/jredmine-client/src/site/apt/redmine_service.apt =================================================================== --- trunk/jredmine-client/src/site/apt/redmine_service.apt (rev 0) +++ trunk/jredmine-client/src/site/apt/redmine_service.apt 2010-01-03 11:52:48 UTC (rev 67) @@ -0,0 +1,47 @@ +---- +RedmineService +---- +---- +2009-09-15 +---- + +Les contrats de service + + L'api java sépare depuis la version 1.0.3 les services publiques et privés. + +* org.nuiton.jredmine.RedmineAnonymousService + + Ce contrat permet d'exécuter les services publiques (services anonymes). + +* org.nuiton.jredmine.RedmineLogguedService + + Ce contrat permet d'exécuter les services privés (services avec login). + +* org.nuiton.jredmine.RedmineService + + Ce contrat regroupe les deux précédents et constitue l'ensemble des services + connus par redmine. + + +Les implentations de service + + L'api offre deux implentations de service. + +* org.nuiton.jredmine.DefaultRedmineAnonymousService + + Ce service peut-être appelé pour tout opération publique, la session + sous-jacente au service (RedmineRestClient) n'établiera pas d'authentification + vers les serveur redmine. + +* org.nuiton.jredmine.DefaultRedmineService + + Ce service peut-être appelé pour toute opération vers le serveur redmine. + + Si la configuration requièrt un login (propriété anonymous à false), une + authentification sera effectuée. + + A noter que si on utilise ce service en anonyme et que l'on tente d'appeler + une méthode de service privé, une exception sera remontée indiquant qu'il faut + être authentifié pour effectuer cette opération. + + <Pour plus de détails, consulter la javadoc du module.> Modified: trunk/jredmine-client/src/site/site.xml =================================================================== --- trunk/jredmine-client/src/site/site.xml 2010-01-03 10:49:37 UTC (rev 66) +++ trunk/jredmine-client/src/site/site.xml 2010-01-03 11:52:48 UTC (rev 67) @@ -17,6 +17,7 @@ <menu name="Utilisateur"> <item name="Introduction" href="index.html"/> <item name="JRedmine rails API" href="rails_api.html"/> + <item name="JRedmine java service" href="redmine_service.html"/> </menu> <menu name="Développeur">