This project has retired. For details please refer to its
Attic page.
RoleManagementService xref
1 package org.apache.archiva.redback.rest.api.services;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21 import org.apache.archiva.redback.authorization.RedbackAuthorization;
22 import org.apache.archiva.redback.integration.security.role.RedbackRoleConstants;
23 import org.apache.archiva.redback.rest.api.model.Application;
24 import org.apache.archiva.redback.rest.api.model.ApplicationRoles;
25 import org.apache.archiva.redback.rest.api.model.Role;
26 import org.apache.archiva.redback.rest.api.model.User;
27
28 import javax.ws.rs.Consumes;
29 import javax.ws.rs.GET;
30 import javax.ws.rs.POST;
31 import javax.ws.rs.Path;
32 import javax.ws.rs.PathParam;
33 import javax.ws.rs.Produces;
34 import javax.ws.rs.QueryParam;
35 import javax.ws.rs.core.MediaType;
36 import java.util.List;
37
38
39
40
41 @Path( "/roleManagementService/" )
42 public interface RoleManagementService
43 {
44
45 @Path( "createTemplatedRole" )
46 @GET
47 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
48 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
49 Boolean createTemplatedRole( @QueryParam( "templateId" ) String templateId,
50 @QueryParam( "resource" ) String resource )
51 throws RedbackServiceException;
52
53
54
55
56
57
58
59
60
61
62 @Path( "removeTemplatedRole" )
63 @GET
64 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
65 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
66 Boolean removeTemplatedRole( @QueryParam( "templateId" ) String templateId,
67 @QueryParam( "resource" ) String resource )
68 throws RedbackServiceException;
69
70
71
72
73
74
75
76
77
78
79
80
81
82 @Path( "updateRole" )
83 @GET
84 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
85 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
86 Boolean updateRole( @QueryParam( "templateId" ) String templateId, @QueryParam( "oldResource" ) String oldResource,
87 @QueryParam( "newResource" ) String newResource )
88 throws RedbackServiceException;
89
90
91
92
93
94
95
96
97
98 @Path( "assignRole" )
99 @GET
100 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
101 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
102 Boolean assignRole( @QueryParam( "roleId" ) String roleId, @QueryParam( "principal" ) String principal )
103 throws RedbackServiceException;
104
105
106
107
108
109
110
111
112 @Path( "assignRoleByName" )
113 @GET
114 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
115 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
116 Boolean assignRoleByName( @QueryParam( "roleName" ) String roleName, @QueryParam( "principal" ) String principal )
117 throws RedbackServiceException;
118
119
120
121
122
123
124
125
126
127
128 @Path( "assignTemplatedRole" )
129 @GET
130 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
131 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
132 Boolean assignTemplatedRole( @QueryParam( "templateId" ) String templateId,
133 @QueryParam( "resource" ) String resource,
134 @QueryParam( "principal" ) String principal )
135 throws RedbackServiceException;
136
137
138
139
140
141
142
143
144 @Path( "unassignRole" )
145 @GET
146 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
147 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
148 Boolean unassignRole( @QueryParam( "roleId" ) String roleId, @QueryParam( "principal" ) String principal )
149 throws RedbackServiceException;
150
151
152
153
154
155
156
157
158 @Path( "unassignRoleByName" )
159 @GET
160 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
161 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
162 Boolean unassignRoleByName( @QueryParam( "roleName" ) String roleName, @QueryParam( "principal" ) String principal )
163 throws RedbackServiceException;
164
165
166
167
168
169
170
171
172 @Path( "roleExists" )
173 @GET
174 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
175 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
176 Boolean roleExists( @QueryParam( "roleId" ) String roleId )
177 throws RedbackServiceException;
178
179
180
181
182
183
184
185
186
187 @Path( "templatedRoleExists" )
188 @GET
189 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
190 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
191 Boolean templatedRoleExists( @QueryParam( "templateId" ) String templateId,
192 @QueryParam( "resource" ) String resource )
193 throws RedbackServiceException;
194
195
196
197
198
199
200
201
202
203 @Path( "verifyTemplatedRole" )
204 @GET
205 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
206 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
207 Boolean verifyTemplatedRole( @QueryParam( "templateId" ) String templateId,
208 @QueryParam( "resource" ) String resource )
209 throws RedbackServiceException;
210
211
212
213
214 @Path( "getEffectivelyAssignedRoles/{username}" )
215 @GET
216 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
217 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
218 List<Role> getEffectivelyAssignedRoles( @PathParam( "username" ) String username )
219 throws RedbackServiceException;
220
221
222
223
224
225 @Path( "allRoles" )
226 @GET
227 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
228 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
229 List<Role> getAllRoles()
230 throws RedbackServiceException;
231
232
233
234
235 @Path( "detailledAllRoles" )
236 @GET
237 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
238 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
239 List<Role> getDetailedAllRoles()
240 throws RedbackServiceException;
241
242
243
244
245
246 @Path( "getApplications/{username}" )
247 @GET
248 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
249 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
250 List<Application> getApplications( @PathParam( "username" ) String username )
251 throws RedbackServiceException;
252
253
254
255
256
257 @Path( "getRole/{roleName}" )
258 @GET
259 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
260 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
261 Role getRole( @PathParam( "roleName" ) String roleName )
262 throws RedbackServiceException;
263
264
265
266
267 @Path( "updateRoleDescription" )
268 @GET
269 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
270 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
271 Boolean updateRoleDescription( @QueryParam( "roleName" ) String roleName,
272 @QueryParam( "roleDescription" ) String description )
273 throws RedbackServiceException;
274
275
276
277
278
279 @Path( "updateRoleUsers" )
280 @POST
281 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
282 @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
283 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
284 Boolean updateRoleUsers( Role role )
285 throws RedbackServiceException;
286
287
288
289
290 @Path( "getApplicationRoles/{username}" )
291 @GET
292 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
293 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
294 List<ApplicationRoles> getApplicationRoles( @PathParam( "username" ) String username )
295 throws RedbackServiceException;
296
297
298
299
300
301 @Path( "updateUserRoles" )
302 @POST
303 @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
304 @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )
305 @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )
306 Boolean updateUserRoles( User user )
307 throws RedbackServiceException;
308
309 }