1 /*
2 * Copyright (c) 2002-2022, 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.portal.service.dashboard;
35
36 import fr.paris.lutece.portal.business.dashboard.DashboardListener;
37 import fr.paris.lutece.portal.business.user.AdminUser;
38
39 import java.util.ArrayList;
40 import java.util.List;
41
42 import javax.servlet.http.HttpServletRequest;
43
44 /**
45 *
46 * DashboardListenerService
47 *
48 */
49 public class DashboardListenerService
50 {
51 private List<DashboardListener> _listRegisteredListeners = new ArrayList<>( );
52
53 /**
54 * Register a new dashboard listener
55 *
56 * @param listener
57 * The listener to register
58 */
59 public void registerListener( DashboardListener listener )
60 {
61 _listRegisteredListeners.add( listener );
62 }
63
64 /**
65 * get the list of dashboards
66 *
67 * @param listDashboards
68 * the list of dashboards
69 * @param request
70 * HttpServletRequest
71 * @param user
72 * AdminUser
73 */
74 public void getDashboardComponents( List<IDashboardComponent> listDashboards, AdminUser user, HttpServletRequest request )
75 {
76 for ( DashboardListener listener : _listRegisteredListeners )
77 {
78 listDashboards.addAll( listener.getDashboardComponents( user, request ) );
79 }
80 }
81 }