1 /* 2 * Copyright (c) 2002-2023, 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.document.service.rules; 35 36 import fr.paris.lutece.plugins.document.business.rules.Rule; 37 import fr.paris.lutece.plugins.document.business.rules.RuleHome; 38 import fr.paris.lutece.plugins.document.service.DocumentEvent; 39 import fr.paris.lutece.plugins.document.service.DocumentEventListener; 40 import fr.paris.lutece.plugins.document.service.DocumentException; 41 42 import java.util.Locale; 43 44 45 /** 46 * Rule engine. Executes rules on every document event. 47 */ 48 public class RuleEngine implements DocumentEventListener 49 { 50 private static RuleEngineument/service/rules/RuleEngine.html#RuleEngine">RuleEngine _singleton = new RuleEngine( ); 51 52 /** 53 * Creates a new instance of RuleEngine 54 */ 55 private RuleEngine( ) 56 { 57 } 58 59 /** 60 * Gets the unique instance 61 * @return The unique instance 62 */ 63 public static RuleEngine getInstance( ) 64 { 65 return _singleton; 66 } 67 68 /** 69 * Initialize 70 */ 71 public void init( ) 72 { 73 // Initialize rules 74 for ( Rule ruleType : RuleHome.getRuleTypes( ) ) 75 { 76 ruleType.init( ); 77 } 78 } 79 80 /** 81 * Process a document event 82 * @param event The event to process 83 * @throws DocumentException raise when error occurs in event or rule 84 */ 85 public void processDocumentEvent( DocumentEvent event ) 86 throws DocumentException 87 { 88 for ( Rule rule : RuleHome.findAll( Locale.getDefault( ) ) ) 89 { 90 rule.apply( event ); 91 } 92 } 93 }