1 /*
2 * Copyright (c) 2002-2021, 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.mylutece.service;
35
36 import fr.paris.lutece.portal.business.role.Role;
37 import fr.paris.lutece.portal.business.role.RoleHome;
38 import fr.paris.lutece.portal.service.rbac.Permission;
39 import fr.paris.lutece.portal.service.rbac.ResourceIdService;
40 import fr.paris.lutece.portal.service.rbac.ResourceType;
41 import fr.paris.lutece.portal.service.rbac.ResourceTypeManager;
42 import fr.paris.lutece.util.ReferenceList;
43
44 import java.util.Locale;
45
46 /**
47 *
48 * class RoleResourceIdService
49 *
50 */
51 public class RoleResourceIdService extends ResourceIdService
52 {
53 /** Permission assign role */
54 public static final String PERMISSION_ASSIGN_ROLE = "ASSIGN_ROLE";
55 private static final String PROPERTY_LABEL_RESOURCE_TYPE = "mylutece.resourceType.role.label";
56 private static final String PROPERTY_LABEL_PERMISSION_ASSIGN_ROLE = "mylutece.permission.role.assign.label";
57
58 /** Creates a new instance of RoleResourceIdService */
59 public RoleResourceIdService( )
60 {
61 setPluginName( MyLutecePlugin.PLUGIN_NAME );
62 }
63
64 /**
65 * Initializes the service
66 */
67 public void register( )
68 {
69 ResourceType rt = new ResourceType( );
70 rt.setResourceIdServiceClass( RoleResourceIdService.class.getName( ) );
71 rt.setPluginName( MyLutecePlugin.PLUGIN_NAME );
72 rt.setResourceTypeKey( Role.RESOURCE_TYPE );
73 rt.setResourceTypeLabelKey( PROPERTY_LABEL_RESOURCE_TYPE );
74
75 Permission p = new Permission( );
76 p.setPermissionKey( PERMISSION_ASSIGN_ROLE );
77 p.setPermissionTitleKey( PROPERTY_LABEL_PERMISSION_ASSIGN_ROLE );
78 rt.registerPermission( p );
79
80 ResourceTypeManager.registerResourceType( rt );
81 }
82
83 /**
84 * Returns a list of role resource ids
85 *
86 * @param locale
87 * The current locale
88 * @return A list of role resource ids
89 */
90 public ReferenceList getResourceIdList( Locale locale )
91 {
92 return RoleHome.getRolesList( );
93 }
94
95 /**
96 * Returns the Title of a given resource
97 *
98 * @param strId
99 * The Id of the resource
100 * @param locale
101 * The current locale
102 * @return The Title of a given resource
103 */
104 public String getTitle( String strId, Locale locale )
105 {
106 Role role = RoleHome.findByPrimaryKey( strId );
107
108 if ( role != null )
109 {
110 return role.getRole( );
111 }
112
113 return "";
114 }
115 }