1 /** 2 * This file Copyright (c) 2003-2010 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.cms.exchange; 35 36 import info.magnolia.cms.core.Content; 37 import info.magnolia.cms.security.User; 38 import info.magnolia.cms.util.Rule; 39 40 import javax.jcr.RepositoryException; 41 import java.util.List; 42 43 44 /** 45 * @author Sameer Charles 46 * $Id: Syndicator.java 6443 2006-09-21 10:14:34Z scharles $ 47 */ 48 public interface Syndicator { 49 50 /** 51 * Sets up the syndicator. 52 * 53 * @param user the user to use for the conection to the subscriber 54 * @param repositoryName the repository to transmit 55 * @param workspaceName the workspace to transmit 56 * @param rule the rules defining which nodes to transmit (node types) 57 */ 58 public void init(User user, String repositoryName, String workspaceName, Rule rule); 59 60 /** 61 * This will activate the specified node to all configured subscribers. 62 * 63 * @param parent parent under which this page will be activated 64 * @param content to be activated 65 * @throws RepositoryException 66 * @throws ExchangeException 67 */ 68 public void activate(String parent, Content content) 69 throws ExchangeException, RepositoryException; 70 71 /** 72 * This will activate the specified node to all configured subscribers. 73 * 74 * @param parent parent under which this page will be activated 75 * @param content to be activated 76 * @param orderBefore List of UUID to be used by the implementation to order this node after activation 77 * @throws RepositoryException 78 * @throws ExchangeException 79 */ 80 public void activate(String parent, Content content, List orderBefore) 81 throws ExchangeException, RepositoryException; 82 83 /** 84 * This will activate the specified node to the specified subscriber. 85 * 86 * @param subscriber 87 * @param parent parent under which this page will be activated 88 * @param content to be activated 89 * @throws RepositoryException 90 * @throws ExchangeException 91 */ 92 public void activate(Subscriber subscriber, String parent, Content content) 93 throws ExchangeException, RepositoryException; 94 95 /** 96 * This will activate the specified node to the specified subscriber. 97 * 98 * @param subscriber 99 * @param parent parent under which this page will be activated 100 * @param content to be activated 101 * @param orderBefore List of UUID to be used by the subscriber to order this node after activation 102 * @throws RepositoryException 103 * @throws ExchangeException 104 */ 105 public void activate(Subscriber subscriber, String parent, Content content, List orderBefore) 106 throws ExchangeException, RepositoryException; 107 108 /** 109 * @param node to deactivate 110 * @throws RepositoryException 111 * @throws ExchangeException 112 */ 113 public void deactivate(Content node) 114 throws ExchangeException, RepositoryException; 115 116 /** 117 * @param node to deactivate 118 * @param subscriber 119 * @throws RepositoryException 120 * @throws ExchangeException 121 */ 122 public void deactivate(Subscriber subscriber, Content node) 123 throws ExchangeException, RepositoryException; 124 125 126 }