-
Notifications
You must be signed in to change notification settings - Fork 188
/
AbstractRestController.java
182 lines (148 loc) · 7.31 KB
/
AbstractRestController.java
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
package com.evolveum.midpoint.rest.impl;
import static org.springframework.http.ResponseEntity.status;
import java.net.URI;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import com.evolveum.midpoint.audit.api.AuditEventRecord;
import com.evolveum.midpoint.audit.api.AuditEventStage;
import com.evolveum.midpoint.audit.api.AuditEventType;
import com.evolveum.midpoint.audit.api.AuditService;
import com.evolveum.midpoint.model.impl.ModelRestService;
import com.evolveum.midpoint.model.impl.security.SecurityHelper;
import com.evolveum.midpoint.prism.PrismObject;
import com.evolveum.midpoint.schema.constants.SchemaConstants;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.schema.result.OperationResultStatus;
import com.evolveum.midpoint.security.api.MidPointPrincipal;
import com.evolveum.midpoint.task.api.Task;
import com.evolveum.midpoint.task.api.TaskManager;
import com.evolveum.midpoint.util.exception.*;
import com.evolveum.midpoint.util.logging.LoggingUtils;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.xml.ns._public.common.common_3.FocusType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.OperationResultType;
/**
* Base REST controller class providing common (utility) methods and logger.
*/
class AbstractRestController {
protected final Trace logger = TraceManager.getTrace(getClass());
private final String opNamePrefix = getClass().getName() + ".";
@Autowired protected AuditService auditService;
@Autowired protected SecurityHelper securityHelper;
@Autowired protected TaskManager taskManager;
protected Task initRequest() {
// No need to audit login. it was already audited during authentication
Task task = taskManager.createTaskInstance(ModelRestService.OPERATION_REST_SERVICE);
task.setChannel(SchemaConstants.CHANNEL_REST_URI);
return task;
}
protected OperationResult createSubresult(Task task, String operation) {
return task.getResult().createSubresult(opNamePrefix + operation);
}
protected ResponseEntity<?> createResponse(HttpStatus statusCode, OperationResult result) {
return createResponse(statusCode, null, result, false);
}
protected <T> ResponseEntity<?> createResponse(
HttpStatus httpStatus, T body, OperationResult result) {
return createResponse(httpStatus, body, result, false);
}
protected <T> ResponseEntity<?> createResponse(HttpStatus httpStatus,
T body, OperationResult result, boolean sendOriginObjectIfNotSuccess) {
result.computeStatusIfUnknown();
if (result.isPartialError()) {
return createBody(status(250), sendOriginObjectIfNotSuccess, body, result);
} else if (result.isHandledError()) {
return createBody(status(240), sendOriginObjectIfNotSuccess, body, result);
}
return status(httpStatus).body(body);
}
protected ResponseEntity<?> createResponseWithLocation(
HttpStatus httpStatus, URI location, OperationResult result) {
result.computeStatusIfUnknown();
if (result.isPartialError()) {
return ResponseEntity.status(250).location(location).body(result);
} else if (result.isHandledError()) {
return ResponseEntity.status(240).location(location).body(result);
}
return location == null ? ResponseEntity.status(httpStatus).build()
: ResponseEntity.status(httpStatus).location(location).build();
}
protected <T> ResponseEntity<?> createBody(ResponseEntity.BodyBuilder builder,
boolean sendOriginObjectIfNotSuccess, T body, OperationResult result) {
if (sendOriginObjectIfNotSuccess) {
return builder.body(body);
}
return builder.body(result);
}
protected ResponseEntity<?> handleException(OperationResult result, Throwable t) {
LoggingUtils.logUnexpectedException(logger, "Got exception while servicing REST request: {}", t,
result != null ? result.getOperation() : "(null)");
return handleExceptionNoLog(result, t);
}
protected ResponseEntity<?> handleExceptionNoLog(OperationResult result, Throwable t) {
return createErrorResponseBuilder(result, t);
}
protected ResponseEntity<?> createErrorResponseBuilder(OperationResult result, Throwable t) {
if (t instanceof ObjectNotFoundException) {
return createErrorResponseBuilder(HttpStatus.NOT_FOUND, result);
}
if (t instanceof CommunicationException || t instanceof TunnelException) {
return createErrorResponseBuilder(HttpStatus.GATEWAY_TIMEOUT, result);
}
if (t instanceof SecurityViolationException) {
return createErrorResponseBuilder(HttpStatus.FORBIDDEN, result);
}
if (t instanceof ConfigurationException) {
return createErrorResponseBuilder(HttpStatus.BAD_GATEWAY, result);
}
if (t instanceof SchemaException || t instanceof ExpressionEvaluationException) {
return createErrorResponseBuilder(HttpStatus.BAD_REQUEST, result);
}
if (t instanceof PolicyViolationException
|| t instanceof ObjectAlreadyExistsException
|| t instanceof ConcurrencyException) {
return createErrorResponseBuilder(HttpStatus.CONFLICT, result);
}
return createErrorResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, result);
}
protected ResponseEntity<?> createErrorResponseBuilder(
HttpStatus status, OperationResult result) {
OperationResultType resultBean;
if (result != null) {
result.computeStatusIfUnknown();
resultBean = result.createOperationResultType();
} else {
resultBean = null;
}
return status(status).body(resultBean);
}
protected void finishRequest() {
auditEvent();
SecurityContextHolder.getContext().setAuthentication(null);
}
private void auditEvent() {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
Object principal = authentication.getPrincipal();
String name = null;
if (principal instanceof MidPointPrincipal) {
name = ((MidPointPrincipal) principal).getUsername();
} else if (principal != null) {
return;
}
PrismObject<? extends FocusType> user = principal != null ? ((MidPointPrincipal) principal).getFocus().asPrismObject() : null;
Task task = taskManager.createTaskInstance();
task.setOwner(user);
task.setChannel(SchemaConstants.CHANNEL_REST_URI);
AuditEventRecord record = new AuditEventRecord(AuditEventType.TERMINATE_SESSION, AuditEventStage.REQUEST);
record.setInitiator(user);
record.setParameter(name);
record.setChannel(SchemaConstants.CHANNEL_REST_URI);
record.setTimestamp(System.currentTimeMillis());
record.setOutcome(OperationResultStatus.SUCCESS);
auditService.audit(record, task);
}
}