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