1 /**
2 * This file Copyright (c) 2003-2014 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 * @author Sameer Charles
49 * $Id: Syndicator.java 6443 2006-09-21 10:14:34Z scharles $
50 */
51 public interface Syndicator {
52
53 /**
54 * Sets up the syndicator.
55 *
56 * @param user
57 * the user to use for the connection to the subscriber
58 * @param repositoryName
59 * the repository to transmit
60 * @param workspaceName
61 * the workspace to transmit
62 * @param rule
63 * the rules defining which nodes to transmit (node types)
64 * @deprecated since 4.5 use ioc instead
65 */
66 @Deprecated
67 public void init(User user, String repositoryName, String workspaceName, Rule rule);
68
69 /**
70 * This will activate the specified node to all configured subscribers.
71 *
72 * @param parent
73 * parent under which this page will be activated
74 * @param content
75 * to be activated
76 * @throws RepositoryException
77 * @throws ExchangeException
78 */
79 public void activate(String parent, Content content) throws ExchangeException, RepositoryException;
80
81 /**
82 * This will activate the specified node to all configured subscribers.
83 *
84 * @param parent parent under which this page will be activated
85 * @param content to be activated
86 * @param orderBefore List of UUID to be used by the implementation to order this node after activation
87 * @throws RepositoryException
88 * @throws ExchangeException
89 */
90 public void activate(String parent, Content content, List<String> orderBefore) throws ExchangeException, RepositoryException;
91
92 /**
93 * This will activate the specified node to the specified subscriber.
94 *
95 * @param subscriber
96 * @param parent parent under which this page will be activated
97 * @param content to be activated
98 * @throws RepositoryException
99 * @throws ExchangeException
100 */
101 public void activate(Subscriber subscriber, String parent, Content content) throws ExchangeException, RepositoryException;
102
103 /**
104 * This will activate the specified node to the specified subscriber.
105 *
106 * @param subscriber
107 * @param parent parent under which this page will be activated
108 * @param content to be activated
109 * @param orderBefore List of UUID to be used by the subscriber to order this node after activation
110 * @throws RepositoryException
111 * @throws ExchangeException
112 */
113 public void activate(Subscriber subscriber, String parent, Content content, List<String> orderBefore) throws ExchangeException, RepositoryException;
114
115 /**
116 * @param node to de-activate
117 * @throws RepositoryException
118 * @throws ExchangeException
119 */
120 public void deactivate(Content node) throws ExchangeException, RepositoryException;
121
122 /**
123 * @param node to de-activate
124 * @param subscriber
125 * @throws RepositoryException
126 * @throws ExchangeException
127 */
128 public void deactivate(Subscriber subscriber, Content node) throws ExchangeException, RepositoryException;
129
130 }