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