View Javadoc
1   /*
2    * Copyright (c) 2002-2021, 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.extend.modules.favorite.service;
35  
36  import java.util.ArrayList;
37  import java.util.HashMap;
38  import java.util.List;
39  import java.util.Map;
40  
41  import javax.servlet.http.HttpServletRequest;
42  
43  import fr.paris.lutece.plugins.extend.modules.favorite.service.IFavoriteListener;
44  import fr.paris.lutece.portal.service.security.LuteceUser;
45  
46  public class FavoriteListenerService
47  {
48  
49      private static Map<String, List<IFavoriteListener>> _mapListeners = new HashMap<String, List<IFavoriteListener>>( );
50      private static boolean _bHasListeners;
51  
52      /**
53       * Register a comment listener.
54       * 
55       * @param strExtendableResourceType
56       *            The extendable resource type associated with the listener. Use {@link #CONSTANT_EVERY_EXTENDABLE_RESOURCE_TYPE} to associated the listener
57       *            with every resource type.
58       * @param listener
59       *            The listener to register
60       */
61      public static synchronized void registerListener( String strExtendableResourceType, IFavoriteListener listener )
62      {
63          List<IFavoriteListener> listListeners = _mapListeners.get( strExtendableResourceType );
64          if ( listListeners == null )
65          {
66              listListeners = new ArrayList<IFavoriteListener>( );
67              _mapListeners.put( strExtendableResourceType, listListeners );
68          }
69          listListeners.add( listener );
70          _bHasListeners = true;
71      }
72  
73      /**
74       * Check if there is listeners to notify
75       * 
76       * @return True if there is at last one listener, false otherwise
77       */
78      public static boolean hasListener( )
79      {
80          return _bHasListeners;
81      }
82  
83      /**
84       * Notify to listeners new favorite. Only listeners associated with the extendable resource type of the comment are notified.
85       * 
86       * @param strExtendableResourceType
87       *            The extendable resource type
88       * @param strIdExtendableResource
89       *            The extendable resource id of the comment
90       * @param request
91       *            the HTTP request
92       */
93      public static void favorite( String strExtendableResourceType, String strIdExtendableResource, HttpServletRequest request )
94      {
95          List<IFavoriteListener> listListeners = _mapListeners.get( strExtendableResourceType );
96          if ( listListeners != null )
97          {
98              for ( IFavoriteListener listener : listListeners )
99              {
100                 listener.favorite( strExtendableResourceType, strIdExtendableResource, request );
101             }
102         }
103 
104     }
105 
106     /**
107      * Notify to listeners canceled favorite. Only listeners associated with the extendable resource type of the comment are notified.
108      * 
109      * @param strExtendableResourceType
110      *            The extendable resource type
111      * @param strIdExtendableResource
112      *            The extendable resource id of the comment
113      * @param request
114      *            the HTTP request
115      */
116     public static void cancelFavorite( String strExtendableResourceType, String strIdExtendableResource, HttpServletRequest request )
117     {
118         List<IFavoriteListener> listListeners = _mapListeners.get( strExtendableResourceType );
119         if ( listListeners != null )
120         {
121             for ( IFavoriteListener listener : listListeners )
122             {
123                 listener.cancelFavorite( strExtendableResourceType, strIdExtendableResource, request );
124             }
125         }
126 
127     }
128 
129     public static boolean canFavorite( String strExtendableResourceType, String strIdExtendableResource, LuteceUser user )
130     {
131         List<IFavoriteListener> listListeners = _mapListeners.get( strExtendableResourceType );
132         boolean res = false;
133         if ( listListeners != null )
134         {
135             for ( IFavoriteListener listener : listListeners )
136             {
137                 return listener.canFavorite( strExtendableResourceType, strIdExtendableResource, user );
138             }
139         }
140         return res;
141     }
142 
143 }