Author: tchemit Date: 2010-03-22 11:43:24 +0100 (Mon, 22 Mar 2010) New Revision: 1850 Log: reformat contract + fix javadoc Modified: trunk/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java Modified: trunk/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java =================================================================== --- trunk/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java 2010-03-20 17:28:21 UTC (rev 1849) +++ trunk/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java 2010-03-22 10:43:24 UTC (rev 1850) @@ -30,54 +30,55 @@ */ package org.nuiton.topia.replication; -import org.nuiton.topia.replication.model.ReplicationModel; import org.nuiton.topia.TopiaContext; import org.nuiton.topia.TopiaException; import org.nuiton.topia.framework.TopiaService; import org.nuiton.topia.persistence.TopiaEntityEnum; +import org.nuiton.topia.replication.model.ReplicationModel; /** * User visible interface for replication engin - * + * <p/> * To use replicator you must have properties defined in config file: - * <li>topia.replication.engin=[class used to indexation] - * <li>possible specific property for index engin used - * + * <li>topia.replication.engin=[class used to indexation] <li>possible specific + * property for index engin used + * <p/> * The replication is always done in two phases : + * <p/> + * <li> - prepare the replication model - ({@link #prepare(TopiaEntityEnum[], + * String...)} - ({@link #prepareForAll(TopiaEntityEnum[])} + * <p/> + * <li> - lanch replication {@link #doReplicate(ReplicationModel, + * TopiaContext)} * - * <li> - prepare the replication model - * - ({@link #prepare(TopiaEntityEnum[], String[])} - * - ({@link #prepareForAll(TopiaEntityEnum[])} - * - * <li> - lanch replication {@link #doReplicate(ReplicationModel, TopiaContext)} - * * @author chemit * @since 2.2.0 */ public interface TopiaReplicationService extends TopiaService { - public static final String SERVICE_NAME = "replication"; + String SERVICE_NAME = "replication"; /** * Prepare le modele de replication pour les entites dans les topiaIds sont * donnes. * * @param contracts les contrats a repliquer - * @param topiaIds la liste des ids d'entites a repliquer + * @param topiaIds la liste des ids d'entites a repliquer * @return le model de replication initialise - * * @throws TopiaException pour toute erreur recontree */ - ReplicationModel prepare(TopiaEntityEnum[] contracts, String... topiaIds) throws TopiaException; + ReplicationModel prepare(TopiaEntityEnum[] contracts, + String... topiaIds) throws TopiaException; /** - * Prepare le modele de replication pour toutes les entites des types donnes. - * + * Prepare le modele de replication pour toutes les entites des types + * donnes. + * <p/> * La méthode calcule l'ordre de replication des données. - * + * <p/> * Actuellement, on n'est pas capable de calculer l'ordre si le graphe des * entités contient des cycles. - * + * <p/> * TODO : faire en sorte de pouvoir gérer les cycles. * * @param contracts les contrats des types a repliquer @@ -87,47 +88,53 @@ ReplicationModel prepareForAll(TopiaEntityEnum[] contracts) throws TopiaException; /** - * Prepare le modele de replication pour les entites données en ne faisant + * Prepare le modele de replication pour les entites données en ne faisant * pas de calcul sur l'ordre des entités à répliquer. - * + * <p/> * L'ordre des types donnees sera celui utilisé. * * @param contracts les contrats a repliquer (dans l'ordre donnée) - * @param topiaIds les ids des entites a repliquer + * @param topiaIds les ids des entites a repliquer * @return le model de replication initialise - * * @throws TopiaException pour toute erreur recontree */ - ReplicationModel prepareWithComputedOrder(TopiaEntityEnum[] contracts, String... topiaIds) throws TopiaException; + ReplicationModel prepareWithComputedOrder(TopiaEntityEnum[] contracts, + String... topiaIds) throws TopiaException; /** * Ajouter une nouvelle operation pre-replication, sur un type de donnee. * - * @param model le modele de replication - * @param type le type du noeud de replication + * @param model le modele de replication + * @param type le type du noeud de replication * @param operationClass l'implantation de l'operation - * @param parameters les parametres supplementaires pour l'operation + * @param parameters les parametres supplementaires pour l'operation */ - void addBeforeOperation(ReplicationModel model, TopiaEntityEnum type, Class<? extends TopiaReplicationOperation> operationClass, Object... parameters); + void addBeforeOperation(ReplicationModel model, + TopiaEntityEnum type, + Class<? extends TopiaReplicationOperation> operationClass, + Object... parameters); /** * Ajouter une nouvelle operation post-replication, sur un type de donnee. * - * @param model le modele de replication - * @param type le type du noeud de replication + * @param model le modele de replication + * @param type le type du noeud de replication * @param operationClass l'implantation de l'operation - * @param parameters les parametres supplementaires pour l'operation + * @param parameters les parametres supplementaires pour l'operation */ - void addAfterOperation(ReplicationModel model, TopiaEntityEnum type, Class<? extends TopiaReplicationOperation> operationClass, Object... parameters); + void addAfterOperation(ReplicationModel model, + TopiaEntityEnum type, + Class<? extends TopiaReplicationOperation> operationClass, + Object... parameters); /** * Lance l'operation de replication a partir du context source vers le * context de destination sur les entites donnees et en utilisant le model - * de replication precedemment construit via la methode - * {@link #prepare(TopiaEntityEnum[], String[])} ou - * {@link #prepareForAll(TopiaEntityEnum[])}. + * de replication precedemment construit via la methode {@link + * #prepare(TopiaEntityEnum[], String...)} ou {@link + * #prepareForAll(TopiaEntityEnum[])}. * - * @param model le modele de replication + * @param model le modele de replication * @param dstCtxt le context sur la source de donnees ou repliquer * @throws Exception pour toute erreur pendant la replication */