PortletResourceIdService.java

  1. /*
  2.  * Copyright (c) 2002-2022, 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.portal.service.portlet;

  35. import fr.paris.lutece.portal.business.portlet.PortletHome;
  36. import fr.paris.lutece.portal.business.portlet.PortletType;
  37. import fr.paris.lutece.portal.business.portlet.PortletTypeHome;
  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. import java.util.Locale;

  44. /**
  45.  * Resource Id service for RBAC features to control access to portlet
  46.  */
  47. public class PortletResourceIdService extends ResourceIdService
  48. {
  49.     public static final String PERMISSION_CREATE = "CREATE";
  50.     public static final String PERMISSION_MANAGE = "MANAGE";
  51.     private static final String PROPERTY_LABEL_RESOURCE_TYPE = "portal.site.portlet.resourceType";
  52.     private static final String PROPERTY_LABEL_CREATE = "portal.site.portlet.permission.create";
  53.     private static final String PROPERTY_LABEL_MANAGE = "portal.site.portlet.permission.manage";

  54.     /**
  55.      * Initializes the service
  56.      */
  57.     public void register( )
  58.     {
  59.         ResourceType rt = new ResourceType( );
  60.         rt.setResourceIdServiceClass( PortletResourceIdService.class.getName( ) );
  61.         rt.setResourceTypeKey( PortletType.RESOURCE_TYPE );
  62.         rt.setResourceTypeLabelKey( PROPERTY_LABEL_RESOURCE_TYPE );

  63.         Permission p = new Permission( );
  64.         p.setPermissionKey( PERMISSION_CREATE );
  65.         p.setPermissionTitleKey( PROPERTY_LABEL_CREATE );
  66.         rt.registerPermission( p );

  67.         p = new Permission( );
  68.         p.setPermissionKey( PERMISSION_MANAGE );
  69.         p.setPermissionTitleKey( PROPERTY_LABEL_MANAGE );
  70.         rt.registerPermission( p );

  71.         ResourceTypeManager.registerResourceType( rt );
  72.     }

  73.     /**
  74.      * Returns a list of resource ids
  75.      *
  76.      * @param locale
  77.      *            The current locale
  78.      * @return A list of resource ids
  79.      */
  80.     public ReferenceList getResourceIdList( Locale locale )
  81.     {
  82.         return PortletTypeHome.getPortletsTypesList( locale );
  83.     }

  84.     /**
  85.      * Returns the Title of a given resource
  86.      *
  87.      * @param strPortletTypeId
  88.      *            The Id of the resource
  89.      * @param locale
  90.      *            The current locale
  91.      * @return The Title of a given resource
  92.      */
  93.     public String getTitle( String strPortletTypeId, Locale locale )
  94.     {
  95.         PortletType portletType = PortletHome.getPortletType( strPortletTypeId );
  96.         portletType.setLocale( locale );

  97.         return portletType.getName( );
  98.     }
  99. }