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.plugins.appointment.service.listeners;
35
36 import java.util.ArrayList;
37 import java.util.List;
38 import java.util.Locale;
39
40 import org.apache.commons.lang3.StringUtils;
41
42 import fr.paris.lutece.plugins.appointment.service.AppointmentExecutorService;
43 import fr.paris.lutece.portal.service.spring.SpringContextService;
44
45 /**
46 * Manager for appointment listeners
47 *
48 * Listeners are started by another thread asynchronously. Currently we have a problem with the propagation of the BDDS transaction when launching a workflow
49 * task that triggers the listener
50 */
51 public final class AppointmentListenerManager
52 {
53 /**
54 * Private default constructor
55 */
56 private AppointmentListenerManager( )
57 {
58 // Nothing to do
59 }
60
61 /**
62 * Notify listeners that an appointment is about to be removed
63 *
64 * @param nIdAppointment
65 * The id of the appointment that will be removed
66 */
67 public static void notifyListenersAppointmentRemoval( int nIdAppointment )
68 {
69 AppointmentExecutorService.INSTANCE.execute( ( ) -> {
70 for ( IAppointmentListener appointmentRemovalListener : SpringContextService.getBeansOfType( IAppointmentListener.class ) )
71 {
72 appointmentRemovalListener.notifyAppointmentRemoval( nIdAppointment );
73 }
74 } );
75 }
76
77 /**
78 * Notify listeners that an appointment is about to be created
79 *
80 * @param nIdAppointment
81 * The id of the appointment that will be update
82 */
83 public static void notifyListenersAppointmentCreated( int nIdAppointment )
84 {
85 AppointmentExecutorService.INSTANCE.execute( ( ) -> {
86
87 for ( IAppointmentListener appointmentListener : SpringContextService.getBeansOfType( IAppointmentListener.class ) )
88 {
89 appointmentListener.notifyAppointmentCreated( nIdAppointment );
90 }
91
92 } );
93
94 }
95
96 /**
97 * Notify listeners that an appointment is about to be updated
98 *
99 * @param nIdAppointment
100 * The id of the appointment that will be update
101 */
102 public static void notifyListenersAppointmentUpdated( int nIdAppointment )
103 {
104 AppointmentExecutorService.INSTANCE.execute( ( ) -> {
105 for ( IAppointmentListener appointmentListener : SpringContextService.getBeansOfType( IAppointmentListener.class ) )
106 {
107 appointmentListener.notifyAppointmentUpdated( nIdAppointment );
108 }
109 } );
110 }
111
112 /**
113 * Notify listeners that the date of an appointment has been modified
114 *
115 * @param nIdAppointment
116 * The id of the appointment that will be removed
117 * @param nIdSlot
118 * The id of the slot
119 * @param locale
120 * The locale
121 * @return The list of messages to display
122 */
123 public static List<String> notifyListenersAppointmentDateChanged( int nIdAppointment, List<Integer> listIdSlot, Locale locale )
124 {
125 List<String> listMessages = new ArrayList<>( );
126
127 for ( IAppointmentListener appointmentRemovalListener : SpringContextService.getBeansOfType( IAppointmentListener.class ) )
128 {
129 String strMessage = appointmentRemovalListener.appointmentDateChanged( nIdAppointment, listIdSlot, locale );
130
131 if ( StringUtils.isNotEmpty( strMessage ) )
132 {
133 listMessages.add( strMessage );
134 }
135 }
136
137 return listMessages;
138 }
139
140 /**
141 * Notify users that an appointment form has been removed
142 *
143 * @param nIdAppointmentForm
144 * the id of the removed appointment form
145 */
146 public static void notifyListenersAppointmentFormRemoval( int nIdAppointmentForm )
147 {
148 AppointmentExecutorService.INSTANCE.execute( ( ) -> {
149 for ( IAppointmentFormRemovalListener appointmentRemovalListener : SpringContextService.getBeansOfType( IAppointmentFormRemovalListener.class ) )
150 {
151 appointmentRemovalListener.notifyAppointmentFormRemoval( nIdAppointmentForm );
152 }
153 } );
154 }
155
156 /**
157 * Notify users that an Notify the listener that an appointment Workflow action has been Triggred
158 *
159 * @param nIdAppointment
160 * the id of the appointment
161 * @param nIdAction
162 * The id of the wf action
163 */
164 public static void notifyAppointmentWFActionTriggered( int nIdAppointment, int nIdAction )
165 {
166 AppointmentExecutorService.INSTANCE.execute( ( ) -> {
167 for ( IAppointmentWorkflowActionListener appointmentListener : SpringContextService.getBeansOfType( IAppointmentWorkflowActionListener.class ) )
168 {
169 appointmentListener.notifyAppointmentWFActionTriggered( nIdAppointment, nIdAction );
170 }
171 } );
172 }
173
174 }