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.participatorybudget.service.campaign.event;
35  
36  import java.util.ArrayList;
37  import java.util.List;
38  
39  import org.apache.commons.lang.StringUtils;
40  
41  import fr.paris.lutece.portal.service.spring.SpringContextService;
42  import fr.paris.lutece.portal.service.util.AppLogService;
43  
44  /**
45   *
46   */
47  public class CampaignEventListernersManager
48  {
49      private static final String BEAN_EVENT_LISTENER_MANAGER = "participatorybudget.campaignEventListernersManager";
50  
51      private static List<CampaignEventListener> _listEventListeners = new ArrayList<>( );
52  
53      // ***********************************************************************************
54      // * SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON *
55      // * SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON SINGLETON *
56      // ***********************************************************************************
57  
58      private static CampaignEventListernersManager _singleton;
59  
60      public static CampaignEventListernersManager getInstance( )
61      {
62          if ( _singleton == null )
63          {
64              _singleton = SpringContextService.getBean( BEAN_EVENT_LISTENER_MANAGER );
65              _singleton.setListeners( SpringContextService.getBeansOfType( CampaignEventListener.class ) );
66          }
67          return _singleton;
68      }
69  
70      // ***********************************************************************************
71      // * EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EV *
72      // * EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EVENTS EV *
73      // ***********************************************************************************
74  
75      /**
76       * Add the a listener
77       * 
78       * @param listener
79       *            The Listener to add
80       */
81      public void addListener( CampaignEventListener listener )
82      {
83          _listEventListeners.add( listener );
84  
85          AppLogService.info( "New Campaign Event Listener registered : " + listener.getClass( ).getName( ) );
86      }
87  
88      /**
89       * Sets the listeners list
90       * 
91       * @param listEventListeners
92       *            The Listeners list
93       */
94      public void setListeners( List<CampaignEventListener> listEventListeners )
95      {
96          _listEventListeners = listEventListeners;
97  
98          for ( CampaignEventListener listener : _listEventListeners )
99          {
100             AppLogService.info( "New Campaign Event Listener registered : " + listener.getClass( ).getName( ) );
101         }
102     }
103 
104     /**
105      * Notify an event to all listeners
106      *
107      * @param event
108      *            A campaign Event
109      * @return Results of listeners, or empty List if no result.
110      */
111     public List<String> notifyListeners( CampaignEvent event )
112     {
113         List<String> results = new ArrayList<>( );
114 
115         for ( CampaignEventListener listener : _listEventListeners )
116         {
117             String result = listener.processCampaignEvent( event );
118             if ( StringUtils.isNotBlank( result ) )
119             {
120                 results.add( result );
121             }
122         }
123 
124         return results;
125     }
126 }