View Javadoc
1   /*
2    * Copyright (c) 2002-2020, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.broadcastproxy.business;
35  
36  import java.util.List;
37  import java.util.Map;
38  
39  public interface IBroadcastProvider
40  {
41  
42      /**
43       * get provider name
44       * 
45       * @return
46       */
47      String getName( );
48  
49      /**
50       * subscribe
51       * 
52       * @param userId
53       * @param subscriptionId
54       * @param typeSubscription
55       * @return true if success
56       * @throws java.lang.Exception
57       */
58      boolean subscribe( String userId, String subscriptionId, String typeSubscription ) throws Exception;
59  
60      /**
61       * unsubscribe
62       * 
63       * @param userId
64       * @param subscriptionId
65       * @param typeSubscription
66       * @return true if success
67       * @throws java.lang.Exception
68       */
69      boolean unsubscribe( String userId, String subscriptionId, String typeSubscription ) throws Exception;
70  
71      /**
72       * returns the user subscriptions list as list of Subscriptions by groups (themes) in HashMap with Group name as key
73       * 
74       * @param userId
75       * @param typeSubscription
76       * @return the list
77       * @throws java.lang.Exception
78       */
79      Map<String, Map<String, List<Subscription>>> getUserSubscriptionsAsList( String userId ) throws Exception;
80  
81      /**
82       * returns the user subscriptions list as a JSON string like :
83       * 
84       * {"subscriptions":[{"name":"EXAMPLE_ONE","active":"0"},{"name":"EXAMPLE_TWO","active":"1","data":["data1","date2","data3"]}]}
85       * 
86       * @param userId
87       * @param typeSubscription
88       * @return a JSON string
89       * @throws java.lang.Exception
90       */
91      String getUserSubscriptionsAsJson( String userId ) throws Exception;
92  
93      /**
94       * update user subscriptions to the specified subscription list
95       * 
96       * @param subscriptionsList
97       * @return true if success
98       * @throws java.lang.Exception
99       */
100     boolean updateSubscribtions( String userId, String jsonSubscriptions ) throws Exception;
101 
102     /**
103      * update user subscriptions to the specified subscription list
104      * 
105      * @param subscriptionsList
106      * @return true if success
107      * @throws java.lang.Exception
108      */
109     boolean updateSubscribtions( String userId, List<Subscription> subscriptionsList ) throws Exception;
110 
111     /**
112      * update user subscription
113      * 
114      * @param subscription
115      * @return true if success
116      * @throws java.lang.Exception
117      */
118     boolean update( Subscription subscription ) throws Exception;
119 
120     /**
121      * get feed list
122      * 
123      * @return the list
124      */
125     List<Feed> getFeeds( );
126 
127     /**
128      * get the subscription view order
129      * 
130      * @return the list
131      */
132     public List<String> getSubscriptionViewOrder( );
133 
134 }