UserViewController.java
7.94 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
package net.ziemers.swxercise.ui;
import java.util.Collection;
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 net.ziemers.swxercise.lg.user.enums.RightState;
import net.ziemers.swxercise.lg.user.service.SessionContext;
import net.ziemers.swxercise.lg.model.user.User;
import net.ziemers.swxercise.lg.user.dto.UserDto;
import net.ziemers.swxercise.lg.user.service.UserService;
import net.ziemers.swxercise.ui.enums.ResponseState;
import net.ziemers.swxercise.ui.utils.RestResponse;
import org.slf4j.Logger;
/**
* REST-Methoden für die Benutzerverwaltung.
*/
@ApplicationScoped
@Path(UserViewController.webContextPath)
public class UserViewController {
static final String webContextPath = "/";
/*
* SLF4J: "Simple Logging Facade for Java"
* Dependency Injection erfolgt mit dem {@link net.ziemers.swxercise.lg.utils.LoggerProducer}
*/
@Inject
private Logger logger;
@Inject
private UserService userService;
/**
* Liefert alle User-Objekte zurück.
* <p>
* Aufruf:
* GET http://localhost:8080/swxercise/rest/v1/users
*
* @return die User-Objekte, oder ein leeres JSON-Array, falls keine existieren.
*/
@GET
@Path("v1/users")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public Collection<User> getAllUsers() {
return userService.findAllUsers();
}
/**
* Liefert das User-Objekt mit der gewünschten Id zurück.
* <p>
* Aufruf:
* GET http://localhost:8080/swxercise/rest/v1/user/42
*
* @param id die Id des gewünschten User-Objekts
* @return das User-Objekt als JSON, oder <code>null</code>, falls keines existiert.
*/
@GET
@Path("v1/user/{id}")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public User getUser(@PathParam("id") Long id) {
return userService.findUser(id);
}
/**
* Liefert das User-Objekt des zurzeit angemeldeten Benutzers zurück.
* <p>
* Aufruf:
* GET http://localhost:8080/swxercise/rest/v1/user
*
* @return das User-Objekt als JSON, oder <code>null</code>, falls keines existiert.
*/
@GET
@Path("v1/user")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.LOGGED_IN)
public User getUser() {
logger.info("Trying to get user's profile info.");
return userService.findUser(); }
/**
* Erstellt ein neues User-Objekt mit den gewünschten Eigenschaften, welche mittels {@link UserDto} definiert werden.
* <p>
* Aufruf:
* POST http://localhost:8080/swxercise/rest/v1/user
*
* @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@POST
@Path("v1/user")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse createUser(UserDto dto) {
if (userService.createUser(dto)) {
return new RestResponse();
}
return new RestResponse(ResponseState.ALREADY_EXISTING);
}
/**
* Aktualisiert das User-Objekt mit der gewünschten Id mit den Eigenschaften,
* welche mittels {@link UserDto} 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/user/42
*
* @param id die Id des zu aktualisierenden User-Objekts
* @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@PUT
@Path("v1/user/{id}")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse updateUser(@PathParam("id") Long id, UserDto dto) {
if (userService.updateUser(id, dto)) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Aktualisiert das User-Objekt des zurzeit angemeldeten Benutzers mit den
* Eigenschaften, welche mittels {@link UserDto} 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/user
*
* @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@PUT
@Path("v1/user")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.LOGGED_IN)
public RestResponse updateUser(UserDto dto) {
if (userService.updateUser(dto)) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Löscht das User-Objekt mit der gewünschten Id.
* <p>
* Aufruf:
* DELETE http://localhost:8080/swxercise/rest/v1/user/42
*
* @param id die Id des gewünschten User-Objekts
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@DELETE
@Path("v1/user/{id}")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.ADMIN)
public RestResponse deleteUser(@PathParam("id") Long id) {
if (userService.deleteUser(id) != null) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Löscht das User-Objekt des zurzeit angemeldeten Benutzers.
* <p>
* Aufruf:
* DELETE http://localhost:8080/swxercise/rest/v1/user
*
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@DELETE
@Path("v1/user")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.LOGGED_IN)
public RestResponse deleteUser() {
if (userService.deleteUser()) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Meldet einen Benutzer durch übergebenen username und password mit einem neuen User-{@link SessionContext} an.
* <p>
* Aufruf:
* POST http://localhost:8080/swxercise/rest/v1/user/login
*
* @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@POST
@Path("v1/user/login")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.NOT_LOGGED_IN)
public RestResponse loginUser(UserDto dto) {
logger.info("Trying to log-in user '{}'.", dto.getUsername());
if (userService.loginUser(dto)) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
/**
* Meldet den angemeldeten Benutzer von seinem User-{@link SessionContext} ab.
* <p>
* Aufruf:
* POST http://localhost:8080/swxercise/rest/v1/user/logout
*
* @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
*/
@POST
@Path("v1/user/logout")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed(RightState.Constants.LOGGED_IN)
public RestResponse logoutUser() {
logger.info("Trying to log-out user.");
if (userService.logoutUser()) {
return new RestResponse();
}
return new RestResponse(ResponseState.FAILED);
}
}