View Javadoc
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.service.rbac.Permission;
37  import fr.paris.lutece.portal.service.rbac.ResourceIdService;
38  import fr.paris.lutece.portal.service.rbac.ResourceType;
39  import fr.paris.lutece.portal.service.rbac.ResourceTypeManager;
40  import fr.paris.lutece.util.ReferenceList;
41  
42  import java.util.Locale;
43  
44  /**
45   *
46   * class RoleResourceIdService
47   *
48   */
49  public class MyLuteceResourceIdService extends ResourceIdService
50  {
51      /** Permission assign role */
52      public static final String RESOURCE_TYPE = "MYLUTECE";
53      public static final String PERMISSION_CREATE_ATTRIBUTE = "CREATE_ATTRIBUTE";
54      public static final String PERMISSION_MODIFY_ATTRIBUTE = "MODIFY_ATTRIBUTE";
55      public static final String PERMISSION_DELETE_ATTRIBUTE = "DELETE_ATTRIBUTE";
56      public static final String PERMISSION_MANAGE_AUTHENTICATION_FILTER = "MANAGE_AUTHENTICATION_FILTER";
57      private static final String PROPERTY_LABEL_RESOURCE_TYPE = "mylutece.resourceType.mylutece_users.label";
58      private static final String PROPERTY_LABEL_PERMISSION_CREATE_ATTRIBUTE = "mylutece.permission.mylutece_users.create_attribute.label";
59      private static final String PROPERTY_LABEL_PERMISSION_MODIFY_ATTRIBUTE = "mylutece.permission.mylutece_users.modify_attribute.label";
60      private static final String PROPERTY_LABEL_PERMISSION_DELETE_ATTRIBUTE = "mylutece.permission.mylutece_users.delete_attribute.label";
61      private static final String PROPERTY_LABEL_MANAGE_AUTHENTICATION_FILTER = "mylutece.permission.authentication_filter.manage.label";
62      private static final String PLUGIN_NAME = "mylutece";
63  
64      /** Creates a new instance of RoleResourceIdService */
65      public MyLuteceResourceIdService( )
66      {
67          setPluginName( PLUGIN_NAME );
68      }
69  
70      /**
71       * Initializes the service
72       */
73      public void register( )
74      {
75          ResourceType rt = new ResourceType( );
76          rt.setResourceIdServiceClass( MyLuteceResourceIdService.class.getName( ) );
77          rt.setPluginName( PLUGIN_NAME );
78          rt.setResourceTypeKey( RESOURCE_TYPE );
79          rt.setResourceTypeLabelKey( PROPERTY_LABEL_RESOURCE_TYPE );
80  
81          Permission p = new Permission( );
82          p.setPermissionKey( PERMISSION_CREATE_ATTRIBUTE );
83          p.setPermissionTitleKey( PROPERTY_LABEL_PERMISSION_CREATE_ATTRIBUTE );
84          rt.registerPermission( p );
85  
86          p = new Permission( );
87          p.setPermissionKey( PERMISSION_MODIFY_ATTRIBUTE );
88          p.setPermissionTitleKey( PROPERTY_LABEL_PERMISSION_MODIFY_ATTRIBUTE );
89          rt.registerPermission( p );
90  
91          p = new Permission( );
92          p.setPermissionKey( PERMISSION_DELETE_ATTRIBUTE );
93          p.setPermissionTitleKey( PROPERTY_LABEL_PERMISSION_DELETE_ATTRIBUTE );
94          rt.registerPermission( p );
95  
96          p = new Permission( );
97          p.setPermissionKey( PERMISSION_MANAGE_AUTHENTICATION_FILTER );
98          p.setPermissionTitleKey( PROPERTY_LABEL_MANAGE_AUTHENTICATION_FILTER );
99          rt.registerPermission( p );
100 
101         ResourceTypeManager.registerResourceType( rt );
102     }
103 
104     /**
105      * Returns a list of role resource ids
106      * 
107      * @param locale
108      *            The current locale
109      * @return A list of role resource ids
110      */
111     public ReferenceList getResourceIdList( Locale locale )
112     {
113         return null;
114     }
115 
116     /**
117      * Returns the Title of a given resource
118      * 
119      * @param strId
120      *            The Id of the resource
121      * @param locale
122      *            The current locale
123      * @return The Title of a given resource
124      */
125     public String getTitle( String strId, Locale locale )
126     {
127         return "";
128     }
129 }