-
Notifications
You must be signed in to change notification settings - Fork 4
/
GetAuditTrailsRequestHandler.java
279 lines (250 loc) · 12.1 KB
/
GetAuditTrailsRequestHandler.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
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
/*
* #%L
* Bitrepository Reference Pillar
* %%
* Copyright (C) 2010 - 2012 The State and University Library, The Royal Library and The State Archives, Denmark
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 2.1 of the
* License, or (at your option) any later version.
*
* This program 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 Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/lgpl-2.1.html>.
* #L%
*/
package org.bitrepository.service.contributor.handler;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.Date;
import javax.xml.bind.JAXBException;
import org.apache.activemq.util.ByteArrayInputStream;
import org.bitrepository.bitrepositorydata.GetAuditTrailsResults;
import org.bitrepository.bitrepositoryelements.ResponseCode;
import org.bitrepository.bitrepositoryelements.ResponseInfo;
import org.bitrepository.bitrepositoryelements.ResultingAuditTrails;
import org.bitrepository.bitrepositorymessages.GetAuditTrailsFinalResponse;
import org.bitrepository.bitrepositorymessages.GetAuditTrailsProgressResponse;
import org.bitrepository.bitrepositorymessages.GetAuditTrailsRequest;
import org.bitrepository.bitrepositorymessages.MessageResponse;
import org.bitrepository.common.JaxbHelper;
import org.bitrepository.common.utils.CalendarUtils;
import org.bitrepository.protocol.*;
import org.bitrepository.service.audit.AuditTrailDatabaseResults;
import org.bitrepository.service.audit.AuditTrailManager;
import org.bitrepository.service.contributor.ContributorContext;
import org.bitrepository.service.exception.InvalidMessageException;
import org.bitrepository.service.exception.RequestHandlerException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;
/**
* Class for handling the GetAuditTrails operation.
*/
public class GetAuditTrailsRequestHandler extends AbstractRequestHandler<GetAuditTrailsRequest> {
/** The log.*/
private Logger log = LoggerFactory.getLogger(getClass());
/** The audit trail manager.*/
private final AuditTrailManager auditManager;
/**
* Constructor.
* @param context The context of the message handler.
* @param auditManager the audit manager
*/
public GetAuditTrailsRequestHandler(ContributorContext context, AuditTrailManager auditManager) {
super(context);
this.auditManager = auditManager;
}
@Override
public Class<GetAuditTrailsRequest> getRequestClass() {
return GetAuditTrailsRequest.class;
}
@Override
public void processRequest(GetAuditTrailsRequest message, MessageContext messageContext) throws RequestHandlerException {
validateCollectionID(message);
validateMessage(message);
sendProgressMessage(message);
AuditTrailDatabaseResults resAudits = collectAudits(message);
handleUpload(message, resAudits);
sendFinalResponse(message, resAudits);
}
@Override
public MessageResponse generateFailedResponse(GetAuditTrailsRequest request) {
return createFinalResponse(request);
}
/**
* Method for validating the content of the message.
* @param message The message requesting the operation, which should be validated.
* @throws InvalidMessageException if the message was invalid
*/
protected void validateMessage(GetAuditTrailsRequest message) throws InvalidMessageException {
if(!message.getContributor().equals(getContext().getSettings().getComponentID())) {
throw new InvalidMessageException(
ResponseCode.REQUEST_NOT_UNDERSTOOD_FAILURE,
"Invalid contributor id.");
}
}
/**
* The method for sending a progress response telling, that the operation is about to be performed.
* @param request The request for the GetStatus operation.
*/
protected void sendProgressMessage(GetAuditTrailsRequest request) {
GetAuditTrailsProgressResponse response = createProgressResponse(request);
// set missing variables in the request: ResponseInfo
ResponseInfo prInfo = new ResponseInfo();
prInfo.setResponseCode(ResponseCode.OPERATION_ACCEPTED_PROGRESS);
prInfo.setResponseText("Starting to extract the requested audit trails.");
response.setResponseInfo(prInfo);
getContext().getResponseDispatcher().dispatchResponse(response, request);
}
/**
* Collect the requested audit trails.
* @param message The message requesting the collecting of audit trails.
* @return The requested audit trails.
*/
protected AuditTrailDatabaseResults collectAudits(GetAuditTrailsRequest message) {
Long minSeq = null;
if(message.getMinSequenceNumber() != null) {
log.trace("Minimum sequence value: {}", message.getMinSequenceNumber().longValue());
minSeq = message.getMinSequenceNumber().longValue();
}
Long maxSeq = null;
if(message.getMaxSequenceNumber() != null) {
log.trace("Maximum sequence value: {}", message.getMaxSequenceNumber().longValue());
maxSeq = message.getMaxSequenceNumber().longValue();
}
Date minDate = null;
if(message.getMinTimestamp() != null) {
log.trace("Minimum date value: {}", message.getMinTimestamp());
minDate = CalendarUtils.convertFromXMLGregorianCalendar(message.getMinTimestamp());
}
Date maxDate = null;
if(message.getMaxTimestamp() != null) {
log.trace("Maximum date value: {}", message.getMaxTimestamp());
maxDate = CalendarUtils.convertFromXMLGregorianCalendar(message.getMaxTimestamp());
}
Long maxNumberOfResults = null;
if(message.getMaxNumberOfResults() != null) {
log.trace("Maximum number of results: {}", message.getMaxNumberOfResults());
maxNumberOfResults = message.getMaxNumberOfResults().longValue();
}
return auditManager.getAudits(message.getCollectionID(), message.getFileID(), minSeq, maxSeq, minDate,
maxDate, maxNumberOfResults);
}
/**
* Handles the potential upload of the audit trails to a given URL.
* @param message The request for the audit trails, which includes the URL for where the audit trails should be
* uploaded
* @param extractedAuditTrails The extracted audit trails.
* @throws InvalidMessageException If the creation, serialization, validation or upload of the file fails.
*/
protected void handleUpload(GetAuditTrailsRequest message, AuditTrailDatabaseResults extractedAuditTrails) throws InvalidMessageException {
if(message.getResultAddress() == null || message.getResultAddress().isEmpty()) {
log.trace("The audit trails are not uploaded.");
return;
}
log.debug("Creating audit trail file and uploading it.");
try {
File fileToUpload = createAuditTrailFile(message, extractedAuditTrails);
URL uploadUrl = new URL(message.getResultAddress());
log.debug("Uploading file: " + fileToUpload.getName() + " to " + uploadUrl.toExternalForm());
getContext().getFileExchange().putFile(new FileInputStream(fileToUpload), uploadUrl);
} catch (Exception e) {
throw new InvalidMessageException(
ResponseCode.FILE_TRANSFER_FAILURE,
"Could not handle the creation and upload of the results due to: " + e.getMessage(), e);
}
}
/**
* Creates a file containing all the audit trails.
* @param request The request for the data.
* @param extractedAuditTrails The extracted audit trails.
* @return The file containing the extracted audit trails.
* @throws IOException If something goes wrong when creating the file or finding the XSD.
* @throws JAXBException If the resulting structure cannot be serialized.
* @throws SAXException If the results does not validate against the XSD.
*/
protected File createAuditTrailFile(GetAuditTrailsRequest request, AuditTrailDatabaseResults extractedAuditTrails)
throws IOException, JAXBException, SAXException {
File checksumResultFile = File.createTempFile(request.getCorrelationID(), new Date().getTime() + ".at");
GetAuditTrailsResults results = new GetAuditTrailsResults();
results.setVersion(ProtocolVersionLoader.loadProtocolVersion().getVersion());
results.setMinVersion(ProtocolVersionLoader.loadProtocolVersion().getMinVersion());
results.setCollectionID(request.getCollectionID());
results.getAuditTrailEvents().add(extractedAuditTrails.getAuditTrailEvents());
OutputStream is = null;
try {
is = new FileOutputStream(checksumResultFile);
JaxbHelper jaxb = new JaxbHelper(XSD_CLASSPATH, XSD_BR_DATA);
String xmlMessage = jaxb.serializeToXml(results);
jaxb.validate(new ByteArrayInputStream(xmlMessage.getBytes(StandardCharsets.UTF_8)));
is.write(xmlMessage.getBytes(StandardCharsets.UTF_8));
is.flush();
} finally {
if(is != null) {
is.close();
}
}
return checksumResultFile;
}
/**
* Method for sending a positive final response.
* @param request The request to respond to.
* @param auditExtract The retrieved audit trails.
*/
protected void sendFinalResponse(GetAuditTrailsRequest request, AuditTrailDatabaseResults auditExtract) {
GetAuditTrailsFinalResponse response = createFinalResponse(request);
ResultingAuditTrails resAuditTrails = new ResultingAuditTrails();
if(request.getResultAddress() == null) {
resAuditTrails.setAuditTrailEvents(auditExtract.getAuditTrailEvents());
} else {
resAuditTrails.setResultAddress(request.getResultAddress());
}
response.setResultingAuditTrails(resAuditTrails);
response.setPartialResult(auditExtract.moreResults());
ResponseInfo responseInfo = new ResponseInfo();
responseInfo.setResponseCode(ResponseCode.OPERATION_COMPLETED);
response.setResponseInfo(responseInfo);
getContext().getResponseDispatcher().dispatchResponse(response, request);
}
/**
* Creates a GetStatusProgressResponse based on a GetStatusRequest. Missing the
* following fields (besides the ones in dispatchResponse):
* <br/> - ResponseInfo
*
* @param message The message to base the response upon.
* @return The GetStatusProgressResponse based on the request.
*/
private GetAuditTrailsProgressResponse createProgressResponse(GetAuditTrailsRequest message) {
GetAuditTrailsProgressResponse res = new GetAuditTrailsProgressResponse();
res.setContributor(getContext().getSettings().getComponentID());
res.setResultAddress(message.getResultAddress());
return res;
}
/**
* Creates a GetStatusFinalResponse based on a GetStatusRequest. Missing the
* following fields (besides the ones in dispatchResponse):
* <ul>
* <li>ResponseInfo</li>
* <li>ResultingAuditTrails</li>
* </ul>
* @param request the audit trail request. Ignored
* @return The GetStatusFinalResponse based on the request.
*/
protected GetAuditTrailsFinalResponse createFinalResponse(GetAuditTrailsRequest request) {
GetAuditTrailsFinalResponse res = new GetAuditTrailsFinalResponse();
res.setContributor(getContext().getSettings().getComponentID());
return res;
}
}