1 /*
2 * Copyright (c) 2002-2014, Mairie de 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 /**
47 * Manager of the ResourceType. Responsible for (un)registering them.
48 */
49 public final class ResourceTypeManager
50 {
51 /** resource type registry */
52 private static Map<String, ResourceType> _mapResourceTypes = new HashMap<String, ResourceType>( );
53
54 ////////////////////////////////////////////////////////////////////////////
55 // Methods
56
57 /**
58 * Creates a new ResourceTypeManager object
59 */
60 private ResourceTypeManager( )
61 {
62 }
63
64 /**
65 * Registers a new resource type
66 *
67 * @param rt 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 Identifier of the seeked resource type
89 * @return the selected resource type
90 */
91 public static ResourceType getResourceType( String strId )
92 {
93 return _mapResourceTypes.get( strId );
94 }
95
96 /**
97 * Registers a collection of resource type
98 *
99 * @param resourceTypeList The resource type list
100 */
101 public static void registerList( Collection<ResourceType> resourceTypeList )
102 {
103 registerList( resourceTypeList, null );
104 }
105
106 /**
107 * Registers a collection of resource type
108 *
109 * @param listResourcesType The resource type list
110 * @param strPluginName The plugin name
111 */
112 public static void registerList( Collection<ResourceType> listResourcesType, String strPluginName )
113 {
114 for ( ResourceType resourceType : listResourcesType )
115 {
116 resourceType.setPluginName( strPluginName );
117 registerResourceType( resourceType );
118 }
119 }
120
121 /**
122 * Gets a localized list of permission for a given resource type
123 * @param strResourceType The resource type
124 * @param locale The Locale
125 * @return A list of permission
126 */
127 public static ReferenceList getPermissionsList( String strResourceType, Locale locale )
128 {
129 ReferenceList list = new ReferenceList( );
130 ResourceType resourceType = getResourceType( strResourceType );
131 Collection<Permission> listPermissions = resourceType.getPermissionList( );
132 I18nService.localizeCollection( listPermissions, locale );
133
134 for ( Permission permission : listPermissions )
135 {
136 list.addItem( permission.getPermissionKey( ), permission.getPermissionTitle( ) );
137 }
138
139 return list;
140 }
141 }