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.includes;
35
36 import fr.paris.lutece.portal.service.init.LuteceInitException;
37 import fr.paris.lutece.portal.service.util.AppLogService;
38
39 import java.util.ArrayList;
40 import java.util.HashMap;
41 import java.util.List;
42 import java.util.Map;
43
44 /**
45 * This service provides the registration and the list of all Portal Content Includes declared in lutece.properties or in plugin XML files.
46 *
47 * @since 1.2.4
48 */
49 public final class PageIncludeService
50 {
51 private static Map<String, PageIncludeEntry> _mapPageIncludes = new HashMap<>( );
52
53 /**
54 * Contructeur private (singleton pattern)
55 */
56 private PageIncludeService( )
57 {
58 }
59
60 /**
61 * Register a Portal Content Include
62 *
63 * @param entry
64 * The PageInclude entry
65 * @throws LuteceInitException
66 * If an error occured
67 */
68 public static void registerPageInclude( PageIncludeEntry entry ) throws LuteceInitException
69 {
70 try
71 {
72 PageInclude./../../fr/paris/lutece/portal/service/includes/PageInclude.html#PageInclude">PageInclude pageInclude = (PageInclude) Class.forName( entry.getClassName( ) ).newInstance( );
73 entry.setPageInclude( pageInclude );
74 _mapPageIncludes.put( entry.getId( ), entry );
75 AppLogService.info( "New Page Include Service registered : {} {}", entry.getId( ), ( ( !entry.isEnabled( ) ) ? " (disabled)" : "" ) );
76 }
77 catch( ClassNotFoundException | IllegalAccessException | InstantiationException e )
78 {
79 throw new LuteceInitException( e.getMessage( ), e );
80 }
81 }
82
83 /**
84 * Returns a collection of Portal Content Includes
85 *
86 * @return _mapIncludes
87 */
88 public static List<PageInclude> getIncludes( )
89 {
90 List<PageInclude> listIncludes = new ArrayList<>( );
91
92 for ( PageIncludeEntry entry : _mapPageIncludes.values( ) )
93 {
94 if ( entry.isEnable( ) )
95 {
96 listIncludes.add( entry.getPageInclude( ) );
97 }
98 }
99
100 return listIncludes;
101 }
102 }