1 /**
2 * This file Copyright (c) 2003-2018 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 java.util.List;
41
42 import javax.jcr.RepositoryException;
43
44
45 /**
46 * Basic activation contract. Provides methods to activate or de-activate content (either current or versioned).
47 */
48 public interface Syndicator {
49
50 /**
51 * Sets up the syndicator.
52 *
53 * @param user the user to use for the connection 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 * @deprecated since 4.5 use ioc instead
58 */
59 @Deprecated
60 public void init(User user, String repositoryName, String workspaceName, Rule rule);
61
62 /**
63 * This will activate the specified node to all configured subscribers.
64 *
65 * @param parent parent under which this page will be activated
66 * @param content to be activated
67 */
68 public void activate(String parent, Content content) throws ExchangeException, RepositoryException;
69
70 /**
71 * This will activate the specified node to all configured subscribers.
72 *
73 * @param parent parent under which this page will be activated
74 * @param content to be activated
75 * @param orderBefore List of UUID to be used by the implementation to order this node after activation
76 */
77 public void activate(String parent, Content content, List<String> orderBefore) throws ExchangeException, RepositoryException;
78
79 /**
80 * This will activate the specified node to the specified subscriber.
81 *
82 * @param parent parent under which this page will be activated
83 * @param content to be activated
84 */
85 public void activate(Subscriber subscriber, String parent, Content content) throws ExchangeException, RepositoryException;
86
87 /**
88 * This will activate the specified node to the specified subscriber.
89 *
90 * @param parent parent under which this page will be activated
91 * @param content to be activated
92 * @param orderBefore List of UUID to be used by the subscriber to order this node after activation
93 */
94 public void activate(Subscriber subscriber, String parent, Content content, List<String> orderBefore) throws ExchangeException, RepositoryException;
95
96 /**
97 * @param node to de-activate
98 */
99 public void deactivate(Content node) throws ExchangeException, RepositoryException;
100
101 /**
102 * @param node to de-activate
103 */
104 public void deactivate(Subscriber subscriber, Content node) throws ExchangeException, RepositoryException;
105
106 }