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.modules.database.authentication.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 org.apache.commons.lang3.StringUtils;
43  
44  import java.util.Locale;
45  
46  /**
47   * RBAC Resource Id Service to allow roles on AdminUser Services
48   */
49  public class DatabaseResourceIdService extends ResourceIdService
50  {
51      public static final String PERMISSION_MANAGE = "MANAGE";
52      public static final String PERMISSION_IMPORT_EXPORT_DATABASE_USERS = "IMPORT_EXPORT_DATABASE_USERS";
53      public static final String RESOURCE_TYPE = "DATABASE";
54      private static final String PROPERTY_LABEL_RESOURCE_TYPE = "module.mylutece.database.databaseService.ressourceType";
55      private static final String PROPERTY_LABEL_MANAGE = "module.mylutece.database.databaseService.permission.manageAdvancedParameters";
56      private static final String PROPERTY_LABEL_IMPORT_EXPORT_DATABASE_USERS = "module.mylutece.database.databaseService.permission.importExportDatabaseUsers";
57  
58      /**
59       * Initializes the service
60       */
61      public void register( )
62      {
63          ResourceType rt = new ResourceType( );
64          rt.setResourceIdServiceClass( DatabaseResourceIdService.class.getName( ) );
65          rt.setResourceTypeKey( RESOURCE_TYPE );
66          rt.setResourceTypeLabelKey( PROPERTY_LABEL_RESOURCE_TYPE );
67  
68          Permission p = new Permission( );
69          p.setPermissionKey( PERMISSION_MANAGE );
70          p.setPermissionTitleKey( PROPERTY_LABEL_MANAGE );
71          rt.registerPermission( p );
72  
73          p = new Permission( );
74          p.setPermissionKey( PERMISSION_IMPORT_EXPORT_DATABASE_USERS );
75          p.setPermissionTitleKey( PROPERTY_LABEL_IMPORT_EXPORT_DATABASE_USERS );
76          rt.registerPermission( p );
77  
78          ResourceTypeManager.registerResourceType( rt );
79      }
80  
81      /**
82       * Returns a list of resource ids
83       * 
84       * @param locale
85       *            The current locale
86       * @return A list of resource ids
87       */
88      public ReferenceList getResourceIdList( Locale locale )
89      {
90          return null;
91      }
92  
93      /**
94       * Returns the Title of a given resource
95       * 
96       * @param strAdminUserId
97       *            The Id of the admin user
98       * @param locale
99       *            The current locale
100      * @return The Title of a given resource
101      */
102     public String getTitle( String strAdminUserId, Locale locale )
103     {
104         return StringUtils.EMPTY;
105     }
106 }