RoleViewController.java
8.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
package net.ziemers.swxercise.ui;
import net.ziemers.swxercise.lg.model.user.Role;
import net.ziemers.swxercise.lg.user.dto.RoleDto;
import net.ziemers.swxercise.lg.user.enums.RightState;
import net.ziemers.swxercise.lg.user.service.RoleService;
import net.ziemers.swxercise.ui.enums.ResponseState;
import net.ziemers.swxercise.ui.utils.RestResponse;
import javax.annotation.security.RolesAllowed;
import javax.enterprise.context.ApplicationScoped;
import javax.inject.Inject;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import java.util.Collection;
/**
* REST-Methoden für die Rollen- und Rechteverwaltung.
*
* Copyright (c) 2017 Dipl.-Inform. Thomas Ziemer
*
* This file is part of swXercise.
*
* swXercise is free software: you can redistribute it and/or modify it under the terms of the
* GNU General Public License as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* swXercise is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with swXercise.
* If not, see <http://www.gnu.org/licenses/>.
*/
@ApplicationScoped
@Path(RoleViewController.webContextPath)
public class RoleViewController {
static final String webContextPath = "/";
@Inject
private RoleService roleService;
/**
* Liefert alle Role-Objekte zurück.
* <p>
* Aufruf:
* GET http://localhost:8080/swxercise/rest/v1/roles
*
* @return die Role-Objekte, oder ein leeres JSON-Array, falls keine existieren.
*/
@GET
@Path("v1/roles")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public Collection<Role> getAllRoles() {
return roleService.findAllRoles();
}
/**
* Liefert das Role-Objekt mit der gewünschten Id zurück.
* <p>
* Aufruf:
* GET http://localhost:8080/swxercise/rest/v1/role/42
*
* @param id die Id des gewünschten Role-Objekts
* @return das Role-Objekt als JSON, oder <code>null</code>, falls keines existiert.
*/
@GET
@Path("v1/role/{id}")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public Role getRole(@PathParam("id") Long id) {
return roleService.findRole(id);
}
/**
* Liefert das Role-Objekt des zurzeit angemeldeten Benutzers zurück.
* <p>
* Aufruf:
* GET http://localhost:8080/swxercise/rest/v1/role
*
* @return das Role-Objekt als JSON, oder <code>null</code>, falls keines existiert.
*/
@GET
@Path("v1/role")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.LOGGED_IN)
public Role getRole() {
return roleService.findRole();
}
/**
* Erstellt ein neues Role-Objekt mit den gewünschten Eigenschaften, welche mittels {@link RoleDto} definiert werden.
* <p>
* Aufruf:
* POST http://localhost:8080/swxercise/rest/v1/role
*
* @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link RoleDto}
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@POST
@Path("v1/role")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse createRole(RoleDto dto) {
final Long id = roleService.createRole(dto);
if (id != null) {
return new RestResponse(ResponseState.SUCCESS, String.valueOf(id));
}
return new RestResponse(ResponseState.ALREADY_EXISTING);
}
/**
* Aktualisiert das Role-Objekt mit der gewünschten Id mit den Eigenschaften,
* welche mittels {@link RoleDto} definiert werden. Der Pfadparameter wird
* als erstes ge'marshal't, das DTO im Post-Content danach (REST-Konvention).
* <p>
* Aufruf:
* PUT http://localhost:8080/swxercise/rest/v1/role/42
*
* @param id die Id des zu aktualisierenden Role-Objekts
* @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link RoleDto}
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@PUT
@Path("v1/role/{id}")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse updateRole(@PathParam("id") Long id, RoleDto dto) {
if (roleService.updateRole(id, dto)) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/** Fügt der angegebenen Rolle das angegebene Recht hinzu.
* <p>
* Aufruf:
* PUT http://localhost:8080/swxercise/rest/v1/role/add/42/admin
*
* @param id die Id der gewünschen Rolle
* @param rightName der Name des gewünschten Rechts
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@PUT
@Path("v1/role/add/{id}/{rightname}")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse addRight(@PathParam("id") Long id, @PathParam("rightname") String rightName) {
if (roleService.addRight(id, rightName)) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Aktualisiert das Role-Objekt des zurzeit angemeldeten Benutzers mit den
* Eigenschaften, welche mittels {@link RoleDto} definiert werden. Der
* Pfadparameter wird als erstes ge'marshal't, das DTO im Post-Content
* danach (REST-Konvention).
* <p>
* Aufruf:
* PUT http://localhost:8080/swxercise/rest/v1/role
*
* @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link RoleDto}
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@PUT
@Path("v1/role")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse updateRole(RoleDto dto) {
if (roleService.updateRole(dto)) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Verknüpft eine Rolle (die "Kindrolle") mit einer anderen Rolle (der "Vaterrolle").
* <p>
* Aufruf:
* PUT http://localhost:8080/swxercise/rest/v1/role/childname/parentname
*
* @param childName die Kindrolle, welche mit der Vaterrolle verknüpft werden soll
* @param parentName die Vaterrolle, welche mit der Kindrolle verknüpft werden soll.
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@PUT
@Path("v1/role/link/{childname}/{parentname}")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse linkRoles(@PathParam("childname") String childName, @PathParam("parentname") String parentName) {
if (roleService.linkRoles(childName, parentName)) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Löscht das Role-Objekt mit der gewünschten Id.
* <p>
* Aufruf:
* DELETE http://localhost:8080/swxercise/rest/v1/role/42
*
* @param id die Id des gewünschten Role-Objekts
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@DELETE
@Path("v1/role/{id}")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse deletetRole(@PathParam("id") Long id) {
roleService.deleteRole(id);
return new RestResponse();
}
/**
* Löscht das Role-Objekt des zurzeit angemeldeten Benutzers.
* <p>
* Aufruf:
* DELETE http://localhost:8080/swxercise/rest/v1/role
*
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@DELETE
@Path("v1/role")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse deleteRole() {
if (roleService.deleteRole()) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
}