View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.document.service;
35  
36  import fr.paris.lutece.plugins.document.business.DocumentMassAction;
37  import fr.paris.lutece.plugins.document.business.DocumentType;
38  import fr.paris.lutece.plugins.document.business.DocumentTypeHome;
39  import fr.paris.lutece.portal.service.rbac.Permission;
40  import fr.paris.lutece.portal.service.rbac.ResourceIdService;
41  import fr.paris.lutece.portal.service.rbac.ResourceType;
42  import fr.paris.lutece.portal.service.rbac.ResourceTypeManager;
43  import fr.paris.lutece.util.ReferenceList;
44  
45  import java.util.Locale;
46  
47  
48  /**
49   * Resource Id service for RBAC features to control access to document depending
50   * their type
51   */
52  public class DocumentMassActionResourceService extends ResourceIdService
53  {
54      /** Permission for modifying a document */
55      public static final String PERMISSION_MASS_ARCHIVE = "MASS_ARCHIVE";
56      private static final String PROPERTY_LABEL_MASS_ARCHIVE = "document.workflow.mass_action.mass_archive";
57      private static final String PLUGIN_NAME = "document";
58      private static final String PROPERTY_LABEL_RESOURCE_TYPE = "document.workflow.mass_action";
59  
60      /** Creates a new instance of DocumentTypeResourceIdService */
61      public DocumentMassActionResourceService(  )
62      {
63          setPluginName( PLUGIN_NAME );
64      }
65  
66      /**
67       * Initializes the service
68       */
69      public void register(  )
70      {
71          ResourceType rt = new ResourceType(  );
72          rt.setResourceIdServiceClass( DocumentMassActionResourceService.class.getName(  ) );
73          rt.setPluginName( PLUGIN_NAME );
74          rt.setResourceTypeKey( DocumentMassAction.RESOURCE_TYPE );
75          rt.setResourceTypeLabelKey( PROPERTY_LABEL_RESOURCE_TYPE );
76  
77          Permission p = new Permission(  );
78          p.setPermissionKey( PERMISSION_MASS_ARCHIVE );
79          p.setPermissionTitleKey( PROPERTY_LABEL_MASS_ARCHIVE );
80          rt.registerPermission( p );
81  
82          ResourceTypeManager.registerResourceType( rt );
83      }
84  
85      /**
86       * Returns the Title of a given resource
87       * @param strId The Id of the resource
88       * @param locale The current locale
89       * @return The Title of a given resource
90       */
91      public String getTitle( String strId, Locale locale )
92      {
93          DocumentType type = DocumentTypeHome.findByPrimaryKey( strId );
94  
95          return type.getName(  );
96      }
97  
98      @Override
99      public ReferenceList getResourceIdList( Locale locale )
100     {
101         return null;
102     }
103 }