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.rbac;
35
36 import fr.paris.lutece.portal.service.i18n.I18nService;
37 import fr.paris.lutece.portal.service.util.AppLogService;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.Collection;
41 import java.util.HashMap;
42 import java.util.Locale;
43 import java.util.Map;
44
45 /**
46 * Manager of the ResourceType. Responsible for (un)registering them.
47 */
48 public final class ResourceTypeManager
49 {
50 /** resource type registry */
51 private static Map<String, ResourceType> _mapResourceTypes = new HashMap<>( );
52
53 // //////////////////////////////////////////////////////////////////////////
54 // Methods
55
56 /**
57 * Creates a new ResourceTypeManager object
58 */
59 private ResourceTypeManager( )
60 {
61 }
62
63 /**
64 * Registers a new resource type
65 *
66 * @param rt
67 * the resource type to register
68 */
69 public static void registerResourceType( ResourceType rt )
70 {
71 _mapResourceTypes.put( rt.getResourceTypeKey( ), rt );
72 AppLogService.info( "New RBAC resource type registered : {}", rt.getResourceTypeKey( ) );
73 }
74
75 /**
76 * Returns all registered resource types
77 *
78 * @return A collection containing all registered resource types
79 */
80 public static Collection<ResourceType> getResourceTypeList( )
81 {
82 return _mapResourceTypes.values( );
83 }
84
85 /**
86 * Get a particular resource type
87 *
88 * @param strId
89 * Identifier of the seeked resource type
90 * @return the selected resource type
91 */
92 public static ResourceType getResourceType( String strId )
93 {
94 return _mapResourceTypes.get( strId );
95 }
96
97 /**
98 * Registers a collection of resource type
99 *
100 * @param resourceTypeList
101 * The resource type list
102 */
103 public static void registerList( Collection<ResourceType> resourceTypeList )
104 {
105 registerList( resourceTypeList, null );
106 }
107
108 /**
109 * Registers a collection of resource type
110 *
111 * @param listResourcesType
112 * The resource type list
113 * @param strPluginName
114 * The plugin name
115 */
116 public static void registerList( Collection<ResourceType> listResourcesType, String strPluginName )
117 {
118 for ( ResourceType resourceType : listResourcesType )
119 {
120 resourceType.setPluginName( strPluginName );
121 registerResourceType( resourceType );
122 }
123 }
124
125 /**
126 * Gets a localized list of permission for a given resource type
127 *
128 * @param strResourceType
129 * The resource type
130 * @param locale
131 * The Locale
132 * @return A list of permission
133 */
134 public static ReferenceList getPermissionsList( String strResourceType, Locale locale )
135 {
136 ReferenceListnceList.html#ReferenceList">ReferenceList list = new ReferenceList( );
137 ResourceType resourceType = getResourceType( strResourceType );
138 Collection<Permission> listPermissions = resourceType.getPermissionList( );
139 I18nService.localizeCollection( listPermissions, locale );
140
141 for ( Permission permission : listPermissions )
142 {
143 list.addItem( permission.getPermissionKey( ), permission.getPermissionTitle( ) );
144 }
145
146 return list;
147 }
148 }