View Javadoc
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.plugins.myportal.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.lang.StringUtils;
43  
44  import java.util.Locale;
45  
46  /**
47   *
48   * MyPortalResourceIdService
49   *
50   */
51  public class MyPortalResourceIdService extends ResourceIdService
52  {
53      public static final String RESOURCE_TYPE = "MYPORTAL";
54      public static final String PERMISSION_MANAGE_ADVANCED_PARAMETERS = "MANAGE_ADVANCED_PARAMETERS";
55      private static final String PROPERTY_LABEL_RESOURCE_TYPE = "myportal.permission.label.resource_type_myportal";
56      private static final String PROPERTY_LABEL_MANAGE_ADVANCED_PARAMETERS = "myportal.permission.label.manage_advanced_parameters";
57  
58      /**
59       * Constructor
60       */
61      public MyPortalResourceIdService( )
62      {
63          setPluginName( MyPortalPlugin.PLUGIN_NAME );
64      }
65  
66      /**
67       * Initializes the service
68       */
69      public void register( )
70      {
71          ResourceType rt = new ResourceType( );
72          rt.setResourceIdServiceClass( MyPortalResourceIdService.class.getName( ) );
73          rt.setPluginName( MyPortalPlugin.PLUGIN_NAME );
74          rt.setResourceTypeKey( RESOURCE_TYPE );
75          rt.setResourceTypeLabelKey( PROPERTY_LABEL_RESOURCE_TYPE );
76  
77          Permission p = new Permission( );
78          p.setPermissionKey( PERMISSION_MANAGE_ADVANCED_PARAMETERS );
79          p.setPermissionTitleKey( PROPERTY_LABEL_MANAGE_ADVANCED_PARAMETERS );
80          rt.registerPermission( p );
81  
82          ResourceTypeManager.registerResourceType( rt );
83      }
84  
85      /**
86       * Returns a list of resource ids
87       *
88       * @param locale
89       *            The current locale
90       * @return A list of resource ids
91       */
92      public ReferenceList getResourceIdList( Locale locale )
93      {
94          return null;
95      }
96  
97      /**
98       * Returns the Title of a given resource
99       *
100      * @param strId
101      *            The Id of the resource
102      * @param locale
103      *            The current locale
104      * @return The Title of a given resource
105      */
106     public String getTitle( String strId, Locale locale )
107     {
108         return StringUtils.EMPTY;
109     }
110 }