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
|
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.document.restapi.resource;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.inject.Inject;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.yahoo.container.jdisc.HttpRequest;
import com.yahoo.container.jdisc.HttpResponse;
import com.yahoo.container.jdisc.LoggingRequestHandler;
import com.yahoo.container.logging.AccessLog;
import com.yahoo.document.DocumentTypeManager;
import com.yahoo.document.TestAndSetCondition;
import com.yahoo.document.config.DocumentmanagerConfig;
import com.yahoo.document.json.SingleDocumentParser;
import com.yahoo.document.restapi.OperationHandler;
import com.yahoo.document.restapi.OperationHandlerImpl;
import com.yahoo.document.restapi.Response;
import com.yahoo.document.restapi.RestApiException;
import com.yahoo.document.restapi.RestUri;
import com.yahoo.documentapi.messagebus.MessageBusDocumentAccess;
import com.yahoo.documentapi.messagebus.MessageBusParams;
import com.yahoo.documentapi.messagebus.loadtypes.LoadTypeSet;
import com.yahoo.vespaxmlparser.VespaXMLFeedReader;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
import java.util.Optional;
import java.util.concurrent.Executor;
import java.util.concurrent.atomic.AtomicInteger;
/**
* API for handling single operation on a document and visiting.
*
* @author dybis
*/
public class RestApi extends LoggingRequestHandler {
private static final String CREATE_PARAMETER_NAME = "create";
private static final String CONDITION_PARAMETER_NAME = "condition";
private static final String DOCUMENTS = "documents";
private static final String FIELDS = "fields";
private static final String DOC_ID_NAME = "id";
private static final String PATH_NAME = "pathId";
private static final String SELECTION = "selection";
private static final String CLUSTER = "cluster";
private static final String CONTINUATION = "continuation";
private static final String APPLICATION_JSON = "application/json";
private final OperationHandler operationHandler;
private SingleDocumentParser singleDocumentParser;
private ObjectMapper mapper = new ObjectMapper();
private AtomicInteger threadsAvailableForApi = new AtomicInteger(20 /*max concurrent requests */);
@Inject
public RestApi(Executor executor, AccessLog accessLog, DocumentmanagerConfig documentManagerConfig) {
super(executor, accessLog);
final LoadTypeSet loadTypes = new LoadTypeSet("client");
this.operationHandler = new OperationHandlerImpl(new MessageBusDocumentAccess(new MessageBusParams(loadTypes)));
this.singleDocumentParser = new SingleDocumentParser(new DocumentTypeManager(documentManagerConfig));
}
// For testing and development
public RestApi(
Executor executor,
AccessLog accessLog,
OperationHandler operationHandler) {
super(executor, accessLog);
this.operationHandler = operationHandler;
}
@Override
public void destroy() {
operationHandler.shutdown();
}
// For testing and development
protected void setDocTypeManagerForTests(DocumentTypeManager docTypeManager) {
this.singleDocumentParser = new SingleDocumentParser(docTypeManager);
}
// Returns null if invalid value.
private Optional<Boolean> parseBoolean(String parameter, HttpRequest request) {
final String property = request.getProperty(parameter);
if (property != null && ! property.isEmpty()) {
switch (property) {
case "true" : return Optional.of(true);
case "false": return Optional.of(false);
default : return null;
}
}
return Optional.empty();
}
@Override
public HttpResponse handle(HttpRequest request) {
try {
if (threadsAvailableForApi.decrementAndGet() < 1) {
return Response.createErrorResponse(
429 /* Too Many Requests */,
"Too many parallel requests, consider using http-vespa-java-client. Please try again later.");
}
return handleInternal(request);
} finally {
threadsAvailableForApi.incrementAndGet();
}
}
// protected for testing
protected HttpResponse handleInternal(HttpRequest request) {
final RestUri restUri;
try {
restUri = new RestUri(request.getUri());
} catch (RestApiException e) {
return e.getResponse();
} catch (Exception e2) {
return Response.createErrorResponse(500, "Exception while parsing URI: " + e2.getMessage());
}
Optional<Boolean> create = parseBoolean(CREATE_PARAMETER_NAME, request);
if (create == null) {
return Response.createErrorResponse(403, "Non valid value for 'create' parameter, must be empty, true, or " +
"false: " + request.getProperty(CREATE_PARAMETER_NAME));
}
String condition = request.getProperty(CONDITION_PARAMETER_NAME);
Optional<ObjectNode> resultJson = Optional.empty();
try {
switch (request.getMethod()) {
case GET: // Vespa Visit/Get
return restUri.getDocId().isEmpty() ? handleVisit(restUri, request) : handleGet(restUri);
case POST: // Vespa Put
operationHandler.put(restUri, createPutOperation(request, restUri.generateFullId(), condition));
break;
case PUT: // Vespa Update
operationHandler.update(restUri, createUpdateOperation(request, restUri.generateFullId(), condition, create));
break;
case DELETE: // Vespa Delete
operationHandler.delete(restUri, condition);
break;
default:
return new Response(405, Optional.empty(), Optional.of(restUri));
}
} catch (RestApiException e) {
return e.getResponse();
} catch (Exception e2) {
// We always blame the user. This might be a bit nasty, but the parser throws various kind of exception
// types, but with nice descriptions.
return Response.createErrorResponse(400, e2.getMessage(), restUri);
}
return new Response(200, resultJson, Optional.of(restUri));
}
private VespaXMLFeedReader.Operation createPutOperation(HttpRequest request, String id, String condition) {
final VespaXMLFeedReader.Operation operationPut =
singleDocumentParser.parsePut(request.getData(), id);
if (condition != null && ! condition.isEmpty()) {
operationPut.setCondition(new TestAndSetCondition(condition));
}
return operationPut;
}
private VespaXMLFeedReader.Operation createUpdateOperation(HttpRequest request, String id, String condition, Optional<Boolean> create) {
final VespaXMLFeedReader.Operation operationUpdate =
singleDocumentParser.parseUpdate(request.getData(), id);
if (condition != null && ! condition.isEmpty()) {
operationUpdate.getDocumentUpdate().setCondition(new TestAndSetCondition(condition));
}
if (create.isPresent()) {
operationUpdate.getDocumentUpdate().setCreateIfNonExistent(create.get());
}
return operationUpdate;
}
private HttpResponse handleGet(RestUri restUri) throws RestApiException {
final Optional<String> getDocument = operationHandler.get(restUri);
final ObjectNode resultNode = mapper.createObjectNode();
if (getDocument.isPresent()) {
final JsonNode parseNode;
try {
parseNode = mapper.readTree(getDocument.get());
} catch (IOException e) {
throw new RuntimeException("Failed while parsing my own results", e);
}
resultNode.putPOJO(FIELDS, parseNode.get(FIELDS));
}
resultNode.put(DOC_ID_NAME, restUri.generateFullId());
resultNode.put(PATH_NAME, restUri.getRawPath());
return new HttpResponse(getDocument.isPresent() ? 200 : 404) {
@Override
public String getContentType() { return APPLICATION_JSON; }
@Override
public void render(OutputStream outputStream) throws IOException {
outputStream.write(resultNode.toString().getBytes(StandardCharsets.UTF_8.name()));
}
};
}
private HttpResponse handleVisit(RestUri restUri, HttpRequest request) throws RestApiException {
if (restUri.getGroup().isPresent() && ! restUri.getGroup().get().value.isEmpty()) {
return Response.createErrorResponse(
400,
"Visiting does not support setting value for group/value, try using expression parameter instead.",
restUri);
}
String documentSelection = Optional.ofNullable(request.getProperty(SELECTION)).orElse("");
Optional<String> cluster = Optional.ofNullable(request.getProperty(CLUSTER));
Optional<String> continuation = Optional.ofNullable(request.getProperty(CONTINUATION));
final OperationHandler.VisitResult visit = operationHandler.visit(restUri, documentSelection, cluster, continuation);
final ObjectNode resultNode = mapper.createObjectNode();
if (visit.token.isPresent()) {
resultNode.put(CONTINUATION, visit.token.get());
}
resultNode.putArray(DOCUMENTS).addPOJO(visit.documentsAsJsonList);
resultNode.put(PATH_NAME, restUri.getRawPath());
HttpResponse httpResponse = new HttpResponse(200) {
@Override
public String getContentType() { return APPLICATION_JSON; }
@Override
public void render(OutputStream outputStream) throws IOException {
try {
outputStream.write(resultNode.toString().getBytes(StandardCharsets.UTF_8));
} catch (Exception e) {
throw new RuntimeException(e);
}
}
};
return httpResponse;
}
}
|
