View Javadoc
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 java.util.Collection;
37  
38  /**
39   * Contract for activation targets (subscribers). Provides full access and management of subscribers.
40   * TODO: rename to SubscriberManager.
41   */
42  public interface ActivationManager {
43  
44      public Collection<Subscriber> getSubscribers();
45  
46      /**
47       * @deprecated since 5.3.3 means of setting the subscribers are implementation detail and should not be exposed
48       */
49      @Deprecated
50      public void setSubscribers(Collection<Subscriber> subscribers);
51  
52      /**
53       * @deprecated since 5.3.3 means of setting the subscribers are implementation detail and should not be exposed
54       */
55      @Deprecated
56      public void addSubscribers(Subscriber subscriber);
57  
58      /**
59       * Path to stored configuration for the subscribers.
60       *
61       * @deprecated since 5.3.3 there's no real need to expose this as such a location is an implementation detail.
62       */
63      @Deprecated
64      public String getConfigPath();
65  
66      public boolean hasAnyActiveSubscriber();
67  
68      /**
69       * Returns public key used by target instance to authenticate incoming activations.
70       */
71      public String getPublicKey();
72  
73  }