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
38 import java.util.Collection;
39
40
41 /**
42 * This class provides instances management methods (create, find, ...) for RBAC objects
43 */
44 public final class RBACHome
45 {
46 // Static variable pointed at the DAO instance
47 private static IRBACDAO _dao = (IRBACDAO) SpringContextService.getBean( "rBACDAO" );
48
49 /**
50 * Private constructor - this class need not be instantiated
51 */
52 private RBACHome( )
53 {
54 }
55
56 /**
57 * Creation of an instance of rBAC
58 *
59 * @param rBAC The instance of the rBAC which contains the informations to store
60 * @return The instance of rBAC which has been created with its primary key.
61 */
62 public static RBAC create( RBAC rBAC )
63 {
64 _dao.insert( rBAC );
65
66 return rBAC;
67 }
68
69 /**
70 * Update of the rBAC which is specified in parameter
71 *
72 * @param rBAC The instance of the rBAC which contains the data to store
73 * @return The instance of the rBAC which has been updated
74 */
75 public static RBAC update( RBAC rBAC )
76 {
77 _dao.store( rBAC );
78
79 return rBAC;
80 }
81
82 /**
83 * Remove the RBAC whose identifier is specified in parameter
84 *
85 * @param nKey The Primary key of the rBAC to remove
86 */
87 public static void remove( int nKey )
88 {
89 _dao.delete( nKey );
90 }
91
92 ///////////////////////////////////////////////////////////////////////////
93 // Finders
94
95 /**
96 * Returns an instance of a rBAC whose identifier is specified in parameter
97 *
98 * @param nKey The Primary key of the rBAC
99 * @return An instance of rBAC
100 */
101 public static RBAC findByPrimaryKey( int nKey )
102 {
103 return _dao.load( nKey );
104 }
105
106 /**
107 * Returns a collection of rBACs objects
108 * @return A collection of rBACs
109 */
110 public static Collection<RBAC> findAll( )
111 {
112 return _dao.selectRBACList( );
113 }
114
115 /**
116 * Find all the entries for a given role key
117 * @param strRoleKey the role key to search for
118 * @return A collection of rBACs
119 */
120 public static Collection<RBAC> findResourcesByCode( String strRoleKey )
121 {
122 return _dao.selectRBACListByRoleKey( strRoleKey );
123 }
124
125 /**
126 * Update the role key of all the entries of a given role key
127 * @param strOldRoleKey the role key to update
128 * @param strNewRoleKey the new role key
129 */
130 public static void updateRoleKey( String strOldRoleKey, String strNewRoleKey )
131 {
132 _dao.updateRoleKey( strOldRoleKey, strNewRoleKey );
133 }
134
135 /**
136 * Gets all role keys
137 * @param strTypeCode The code type
138 * @param strId The ID
139 * @param strPermission The permission
140 * @return A collection of role keys
141 */
142 public static Collection<String> findRoleKeys( String strTypeCode, String strId, String strPermission )
143 {
144 return _dao.selectRoleKeys( strTypeCode, strId, strPermission );
145 }
146
147 /**
148 * Remove all the entries of the given role key
149 * @param strRoleKey the role key of the entries to remove
150 */
151 public static void removeForRoleKey( String strRoleKey )
152 {
153 _dao.deleteForRoleKey( strRoleKey );
154 }
155 }