View Javadoc
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.rbac;
35  
36  import fr.paris.lutece.util.ReferenceList;
37  
38  import java.util.Locale;
39  
40  /**
41   * This class gives the methods to implement in order to allow the restitution of the ids and labels for a given resource type.
42   */
43  public abstract class ResourceIdService
44  {
45      // the plugin name
46      private String _strPluginName;
47  
48      /**
49       * This method should register permissions and resource type
50       */
51      public abstract void register( );
52  
53      /**
54       * Provide the list of all resources (id - label)
55       *
56       * @return the list of all resources available for restricted access
57       * @param locale
58       *            The locale
59       */
60      public abstract ReferenceList getResourceIdList( Locale locale );
61  
62      /**
63       * Provide the title of a resource given its id
64       *
65       * @return the title the corresponding label
66       * @param locale
67       *            The locale
68       * @param strId
69       *            the id of the resource
70       */
71      public abstract String getTitle( String strId, Locale locale );
72  
73      /**
74       * Sets the name of the plugin associated
75       * 
76       * @param strPluginName
77       *            the plugin name
78       */
79      public void setPluginName( String strPluginName )
80      {
81          _strPluginName = strPluginName;
82      }
83  
84      /**
85       * Gets the name of the plugin associated
86       * 
87       * @return the plugin name
88       */
89      public String getPluginName( )
90      {
91          return _strPluginName;
92      }
93  }