Author: echatellier Date: 2010-09-13 14:01:45 +0200 (Mon, 13 Sep 2010) New Revision: 306 Url: http://nuiton.org/repositories/revision/wikitty/306 Log: Add missing wikitty service method on wikitty proxy Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyServiceImpl.java Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java 2010-09-13 09:10:22 UTC (rev 305) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyProxy.java 2010-09-13 12:01:45 UTC (rev 306) @@ -35,6 +35,8 @@ * Wikitty proxy is used to transform wikitty object used by {@link WikittyService} * into business objects used by applications. * + * It also manage {@link #securityToken} for {@link WikittyServiceSecurity}. + * * @author poussin * @version $Revision$ * @@ -43,9 +45,16 @@ */ public class WikittyProxy { + /** Delegated wikitty service. */ protected WikittyService wikittyService; - protected String securityToken = null; + /** + * Security token. + * + * @see WikittyServiceSecurity#login(String, String) + */ + protected String securityToken; + public String login(String login, String password) { String result = wikittyService.login(login, password); setSecurityToken(result); @@ -73,7 +82,7 @@ } /** - * Cast Business objet to another Business Object + * Cast Business object to another Business Object * If source don't have target extension, this extension is added * * @param source business entity source @@ -490,7 +499,7 @@ HashSet<String> extNames = null; try { Wikitty wikitty = wikittyService.restore(securityToken, wikittyId); - if(wikitty == null) { + if (wikitty == null) { return false; } extNames = new HashSet<String>(wikitty.getExtensionNames()); @@ -512,4 +521,89 @@ return true; } + /** + * Manage Update and creation. + * + * @param ext extension to be persisted + * @return update response + */ + public UpdateResponse storeExtension(WikittyExtension ext) { + UpdateResponse response = wikittyService.storeExtension(securityToken, ext); + return response; + } + + /** + * Manage Update and creation. + * + * @param exts list of wikitty extension to be persisted + * @return update response + */ + public UpdateResponse storeExtension(Collection<WikittyExtension> exts) { + UpdateResponse response = wikittyService.storeExtension(securityToken, exts); + return response; + } + + /** + * Load extension from id. Id is 'name[version]'. + * + * @param extensionId extension id to restore + * @return the corresponding object, exception if no such object found. + */ + public WikittyExtension restoreExtension(String extensionId) { + WikittyExtension extension = wikittyService.restoreExtensionLastVersion(securityToken, extensionId); + return extension; + } + + /** + * Search extension with name in last version. + * + * @param extensionName extension name + * @return the corresponding object, exception if no such object found. + */ + public WikittyExtension restoreExtensionLastVersion(String extensionName) { + WikittyExtension extension = wikittyService.restoreExtensionLastVersion(securityToken, extensionName); + return extension; + } + + /** + * Return all extension id (ex: "extName[version])"). + * + * @return extension id list + */ + public List<String> getAllExtensionIds() { + List<String> result = wikittyService.getAllExtensionIds(securityToken); + return result; + } + + /** + * Return all extension id (ex: "extName[version])") where + * {@code extensionName} is required. + * + * @param extensionName extension name + * @return extensions + */ + public List<String> getAllExtensionsRequires(String extensionName) { + List<String> result = wikittyService.getAllExtensionsRequires(securityToken, extensionName); + return result; + } + + /** + * Use with caution : It will delete ALL indexes from search engine ! + * This operation should be disabled in production environment. + */ + public void clear() { + wikittyService.clear(securityToken); + } + + /** + * Synchronize search engine with wikitty storage engine, i.e. clear and + * reindex all wikitties. + * + * @return update response + */ + public UpdateResponse syncEngin() { + UpdateResponse result = wikittyService.syncEngin(securityToken); + return result; + } + } Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java 2010-09-13 09:10:22 UTC (rev 305) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyService.java 2010-09-13 12:01:45 UTC (rev 306) @@ -112,6 +112,8 @@ /** * Use with caution : It will delete ALL indexes from search engine ! * This operation should be disabled in production environment. + * + * @param securityToken security token */ public void clear(String securityToken); @@ -134,8 +136,8 @@ * Si l'id de l'objet est invalide, la methode retourne true, car la * suppression d'un id invalide ne fait rien * - * @param securityToken - * @param wikittyId + * @param securityToken security token + * @param wikittyId wikitty id * @return vrai le la suppression ne posera pas de probleme. */ public boolean canDelete(String securityToken, String wikittyId); @@ -147,8 +149,8 @@ * - Admin * - Writer * - * @param securityToken - * @param id + * @param securityToken security token + * @param wikittyId wikitty id * @return vrai si l'utilisateur peut lire l'obbjet */ public boolean canRead(String securityToken, String wikittyId); @@ -156,23 +158,29 @@ /** * Manage Update and creation. * + * @param securityToken security token * @param wikitty contains an id all the time. + * @return update response containing version and id of stored wikitty */ public UpdateResponse store(String securityToken, Wikitty wikitty); /** * Manage Update and creation. * + * @param securityToken security token * @param wikitties list of wikitty to be persisted + * @return update response containing version and id of stored wikitty */ public UpdateResponse store(String securityToken, Collection<Wikitty> wikitties); /** * Manage Update and creation. * + * @param securityToken security token * @param wikitties list of wikitty to be persisted * @param disableAutoVersionIncrement boolean to disable version increment * on saved wikitty + * @return update response */ public UpdateResponse store(String securityToken, Collection<Wikitty> wikitties, boolean disableAutoVersionIncrement); @@ -180,74 +188,91 @@ /** * Manage Update and creation, action is done in transaction passed in - * argument + * argument. * + * @param securityToken security token * @param transaction transaction used to do the action (must not be null) * @param wikitties list of wikitty to be persisted * @param disableAutoVersionIncrement boolean to disable version increment * on saved wikitty + * @return update response */ public UpdateResponse store(String securityToken, WikittyTransaction transaction, Collection<Wikitty> wikitties, boolean disableAutoVersionIncrement); /** - * Return all extension id (ex: "extName[version])") - * @return + * Return all extension id (ex: "extName[version])"). + * + * @param securityToken security token + * @return extension ids list */ public List<String> getAllExtensionIds(String securityToken); /** * Return all extension id (ex: "extName[version])") where extensionName is * required. - * @return + * + * @param securityToken security token + * @param extensionName extension name + * @return extension id list */ public List<String> getAllExtensionsRequires(String securityToken, String extensionName); - /** + /** * Manage Update and creation. * - * @param wikitty extension to be persisted + * @param securityToken security token + * @param ext extension to be persisted + * @return update response */ public UpdateResponse storeExtension(String securityToken, WikittyExtension ext); - /** + /** * Manage Update and creation. * + * @param securityToken security token * @param exts list of wikitty extension to be persisted + * @return update response */ public UpdateResponse storeExtension(String securityToken, Collection<WikittyExtension> exts); - /** + /** * Manage Update and creation, action is done in transaction passed in * argument * + * @param securityToken security token * @param transaction transaction used to do the action (must not be null) * @param exts list of wikitty extension to be persisted + * @return update response */ public UpdateResponse storeExtension(String securityToken, WikittyTransaction transaction, Collection<WikittyExtension> exts); /** - * - * @param id + * Load extension from id. Id is 'name[version]'. + * + * @param securityToken security token + * @param extensionId extension id to restore * @return the corresponding object, exception if no such object found. */ - public WikittyExtension restoreExtension(String securityToken, String id); + public WikittyExtension restoreExtension(String securityToken, String extensionId); /** - * action is done in transaction passed in argument + * Action is done in transaction passed in argument. * + * @param securityToken security token * @param transaction transaction used to do the action (must not be null) - * @param id + * @param extensionId * @return the corresponding object, exception if no such object found. */ public WikittyExtension restoreExtension(String securityToken, - WikittyTransaction transaction, String id); + WikittyTransaction transaction, String extensionId); /** * Search extension with name in last version. * + * @param securityToken security token * @param name extension name * @return the corresponding object, exception if no such object found. */ @@ -257,6 +282,7 @@ /** * Search extension with name in last version. * + * @param securityToken security token * @param transaction transaction used to do the action (must not be null) * @param name extension name * @return the corresponding object, exception if no such object found. @@ -266,6 +292,7 @@ /** * + * @param securityToken security token * @param id object id to restore * @return the corresponding object, or null if object doesn't exist, is * deleted or you don't have authorisation (you can check authorisation @@ -275,6 +302,7 @@ /** * + * @param securityToken security token * @param id list of wikitty ids to restore * @return list of corresponding wikitty, if one id is not valid (no object * or deleted or no authorisation) this id is skip and result list have less @@ -295,19 +323,24 @@ public List<Wikitty> restore(String securityToken, WikittyTransaction transaction, List<String> id); /** - * delete object if id exists + * Delete object if id exists. + * + * @param securityToken security token * @param id object's id to remove */ public void delete(String securityToken, String id); /** - * delete all object if id exists + * Delete all object if id exists. + * + * @param securityToken security token * @param ids object's ids to remove */ public void delete(String securityToken, Collection<String> ids); /** * + * @param securityToken security token * @param criteria * @return */ @@ -316,6 +349,7 @@ /** * + * @param securityToken security token * @param transaction * @param criteria * @return @@ -328,6 +362,7 @@ * wikitty found or first retrived is not authorized for the user return * null * + * @param securityToken security token * @param criteria * @return wikitty object or null */ @@ -338,6 +373,7 @@ * wikitty found or first retrived is not authorized for the user return * null * + * @param securityToken security token * @param criteria * @param transaction * @return wikitty object or null @@ -349,7 +385,9 @@ */ /** - * add new lable to the wikitty object + * Add new lable to the wikitty object. + * + * @param securityToken security token * @param wikittyId id of wikitty object to add label * @param label label to add */ @@ -357,6 +395,7 @@ /** * + * @param securityToken security token * @param label * @return */ @@ -365,13 +404,16 @@ /** * + * @param securityToken security token * @param addLabel * @return */ public Wikitty findByLabel(String securityToken, String label); /** - * retrieve all labels applied on a wikitty object + * Retrieve all labels applied on a wikitty object. + * + * @param securityToken security token * @param wikittyId * @return */ @@ -388,6 +430,7 @@ * Retrieve all wikitties children (recursively) of an other one * Wikitty reference by wikittyId MUST include the 'Node' extension * + * @param securityToken security token * @param wikittyId * @return */ @@ -395,7 +438,9 @@ /** * Retrieve wikitty node with count. Wikitty reference by wikittyId MUST - * include the 'Node' extension + * include the 'Node' extension. + * + * @param securityToken security token * @param wikittyId * @return */ @@ -406,6 +451,7 @@ * Retrieve all wikitties children with count (no recursively) of an other one * Wikitty reference by wikittyId MUST include the 'Node' extension * + * @param securityToken security token * @param wikittyId * @return */ @@ -420,6 +466,8 @@ /** * Restore wikitty in specifique version. * Authorisation is checked on last version even for previous wikitty version + * + * @param securityToken security token */ public Wikitty restoreVersion(String securityToken, String wikittyId, String version); @@ -429,9 +477,11 @@ */ /** - * Synchronise search engine with wikitty strorage engine, i.e. clear and + * Synchronise search engine with wikitty storage engine, i.e. clear and * reindex all wikitties. - * @return + * + * @param securityToken security token + * @return update response */ public UpdateResponse syncEngin(String securityToken); Modified: trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyServiceImpl.java =================================================================== --- trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyServiceImpl.java 2010-09-13 09:10:22 UTC (rev 305) +++ trunk/wikitty-api/src/main/java/org/nuiton/wikitty/WikittyServiceImpl.java 2010-09-13 12:01:45 UTC (rev 306) @@ -326,10 +326,10 @@ @Override public WikittyExtension restoreExtension( - String securityToken, WikittyTransaction transaction, String id) { + String securityToken, WikittyTransaction transaction, String extensionId) { //split the id to ensure that version is normalized - String name = WikittyExtension.computeName(id); - String version = WikittyExtension.computeVersion(id); + String name = WikittyExtension.computeName(extensionId); + String version = WikittyExtension.computeVersion(extensionId); WikittyExtension result = getExtensionStorage().restore(transaction, name, version); return result; @@ -338,17 +338,17 @@ /** * Load extension from id. Id is 'name[version]'. * - * @param id extension id to restore + * @param extensionId extension id to restore * @return extension */ @Override - public WikittyExtension restoreExtension(String securityToken, String id) { + public WikittyExtension restoreExtension(String securityToken, String extensionId) { WikittyTransaction transaction = new WikittyTransaction(); try { transaction.begin(); WikittyExtension result = restoreExtension( - securityToken, transaction, id); + securityToken, transaction, extensionId); transaction.commit(); return result;