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.business.rbac;
35
36 import fr.paris.lutece.portal.service.spring.SpringContextService;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40
41 /**
42 * This class provides instances management methods (create, find, ...) for RBACRole objects
43 */
44 public final class RBACRoleHome
45 {
46 // Static variable pointed at the DAO instance
47 private static IRBACRoleDAO _dao = SpringContextService.getBean( "rbacRoleDAO" );
48
49 /**
50 * Private constructor - this class need not be instantiated
51 */
52 private RBACRoleHome( )
53 {
54 }
55
56 /**
57 * Creation of an instance of role
58 *
59 * @param role
60 * The instance of the role which contains the informations to store
61 * @return The instance of role which has been created with its primary key.
62 */
63 public static RBACRole../../../../../../fr/paris/lutece/portal/business/rbac/RBACRole.html#RBACRole">RBACRole create( RBACRole role )
64 {
65 _dao.insert( role );
66
67 return role;
68 }
69
70 /**
71 * Update of the role which is specified in parameter
72 *
73 * @param strRoleKey
74 * the key of the role to update
75 * @param role
76 * The instance of the role which contains the new data to store
77 * @return The instance of the role which has been updated
78 */
79 public static RBACRoler/paris/lutece/portal/business/rbac/RBACRole.html#RBACRole">RBACRole update( String strRoleKey, RBACRole role )
80 {
81 _dao.store( strRoleKey, role );
82
83 return role;
84 }
85
86 /**
87 * Remove the RBACRole whose identifier is specified in parameter
88 *
89 * @param strRoleKey
90 * The RBACRole object to remove
91 */
92 public static void remove( String strRoleKey )
93 {
94 _dao.delete( strRoleKey );
95 }
96
97 // /////////////////////////////////////////////////////////////////////////
98 // Finders
99
100 /**
101 * Returns an instance of a role whose identifier is specified in parameter
102 *
103 * @param strRoleKey
104 * The Primary key of the role
105 * @return An instance of role
106 */
107 public static RBACRole findByPrimaryKey( String strRoleKey )
108 {
109 return _dao.load( strRoleKey );
110 }
111
112 /**
113 * Returns a collection of roles objects
114 *
115 * @return A collection of roles
116 */
117 public static Collection<RBACRole> findAll( )
118 {
119 return _dao.selectRoleList( );
120 }
121
122 /**
123 * Returns a reference of roles objects
124 *
125 * @return A collection of roles
126 */
127 public static ReferenceList getRolesList( )
128 {
129 ReferenceListnceList.html#ReferenceList">ReferenceList list = new ReferenceList( );
130 Collection<RBACRole> listRoles = _dao.selectRoleList( );
131
132 for ( RBACRole role : listRoles )
133 {
134 list.addItem( role.getKey( ), role.getDescription( ) );
135 }
136
137 return list;
138 }
139
140 /**
141 * Check that the given key points to an existing role
142 *
143 * @param strRoleKey
144 * The role key
145 * @return true if the role exists, false otherwise
146 */
147 public static boolean checkExistRole( String strRoleKey )
148 {
149 return _dao.checkExistRole( strRoleKey );
150 }
151 }