\r
index - The name of the _Index_ to persist the _Document_ in.\r
\r
+**Request Header**\r
+\r
+ X-Create-Index = true = Allow index to be implicitly created if it does not already exist in the document store.\r
+ \r
**Request Payload**\r
\r
Document contents expressed as a JSON object. (see **Syntax**) \r
index - The name of the _Index_ to persist the Document in.\r
id - The identifier to associate with this Document.\r
\r
+**Request Header**\r
+\r
+ X-Create-Index = true = Allow index to be implicitly created if it does not already exist in the document store.\r
+ \r
**Request Payload**\r
\r
Document contents expressed as a JSON object. (see **Syntax**) \r
Accept = application/json\r
X-TransactionId = Unique id set by client (for logging purposes)\r
X-FromAppId = Application identifier (for logging purposes)\r
+ X-Create-Index = true = Allow index to be implicitly created if it does not already exist in the document store.\r
Content-Type = application/json \r
If-Match = The ETag value for the document to be updated.\r
\r
<dependency>
<groupId>org.openecomp.aai.logging-service</groupId>
<artifactId>common-logging</artifactId>
- <version>1.0.0-SNAPSHOT</version>
+ <!--<version>1.0.0-SNAPSHOT</version>-->
+ <version>1.0.0</version>
</dependency>
<!-- Jersey Test Framework. -->
public class DocumentApi {
private static final String REQUEST_HEADER_RESOURCE_VERSION = "If-Match";
private static final String RESPONSE_HEADER_RESOURCE_VERSION = "ETag";
-
+ private static final String REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION = "X-CreateIndex";
+
protected SearchServiceApi searchService = null;
private Logger logger = LoggerFactory.getInstance().getLogger(DocumentApi.class.getName());
DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
document.setContent(content);
- DocumentOperationResult result = documentStore.createDocument(index, document);
+ DocumentOperationResult result = documentStore.createDocument(index, document, implicitlyCreateIndex(headers));
String output = null;
if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getDocument());
DocumentOperationResult result = null;
if (resourceVersion == null) {
- result = documentStore.createDocument(index, document);
+ result = documentStore.createDocument(index, document, implicitlyCreateIndex(headers));
} else {
- result = documentStore.updateDocument(index, document);
+ result = documentStore.updateDocument(index, document, implicitlyCreateIndex(headers));
}
String output = null;
}
}
+
+ /**
+ * Checks the supplied HTTP headers to see if we should allow the underlying document
+ * store to implicitly create the index referenced in a document PUT or POST if it
+ * does not already exist in the data store.
+ *
+ * @param headers - The HTTP headers to examine.
+ *
+ * @return - true if the headers indicate that missing indices should be implicitly created,
+ * false otherwise.
+ */
+ private boolean implicitlyCreateIndex(HttpHeaders headers) {
+
+ boolean createIndexIfNotPresent = false;
+ String implicitIndexCreationHeader =
+ headers.getRequestHeaders().getFirst(REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION);
+
+ if( (implicitIndexCreationHeader != null) && (implicitIndexCreationHeader.equals("true")) ) {
+ createIndexIfNotPresent = true;
+ }
+
+ return createIndexIfNotPresent;
+ }
+
+
private String prepareOutput(ObjectMapper mapper, SearchOperationResult result)
throws JsonProcessingException {
StringBuffer output = new StringBuffer();
public OperationResult deleteIndex(String indexName) throws DocumentStoreOperationException;
- public DocumentOperationResult createDocument(String indexName, DocumentStoreDataEntity document)
- throws DocumentStoreOperationException;
+ public DocumentOperationResult createDocument(String indexName,
+ DocumentStoreDataEntity document,
+ boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
- public DocumentOperationResult updateDocument(String indexName, DocumentStoreDataEntity document)
- throws DocumentStoreOperationException;
+ public DocumentOperationResult updateDocument(String indexName,
+ DocumentStoreDataEntity document,
+ boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
public DocumentOperationResult deleteDocument(String indexName, DocumentStoreDataEntity document)
throws DocumentStoreOperationException;
}
@Override
- public DocumentOperationResult createDocument(String indexName, DocumentStoreDataEntity document)
+ public DocumentOperationResult createDocument(String indexName,
+ DocumentStoreDataEntity document,
+ boolean allowImplicitIndexCreation)
throws DocumentStoreOperationException {
+
+ if(!allowImplicitIndexCreation) {
+
+ // Before we do anything, make sure that the specified index actually exists in the
+ // document store - we don't want to rely on ElasticSearch to fail the document
+ // create because it could be configured to implicitly create a non-existent index,
+ // which can lead to hard-to-debug behaviour with queries down the road.
+ OperationResult indexExistsResult = checkIndexExistence(indexName);
+ if ((indexExistsResult.getResultCode() < 200) || (indexExistsResult.getResultCode() >= 300)) {
+
+ DocumentOperationResult opResult = new DocumentOperationResult();
+ opResult.setResultCode(Status.NOT_FOUND.getStatusCode());
+ opResult.setResult("Document Index '" + indexName + "' does not exist.");
+ opResult.setFailureCause("Document Index '" + indexName + "' does not exist.");
+ return opResult;
+ }
+ }
+
if (document.getId() == null || document.getId().isEmpty()) {
return createDocumentWithoutId(indexName, document);
} else {
}
@Override
- public DocumentOperationResult updateDocument(String indexName, DocumentStoreDataEntity document)
+ public DocumentOperationResult updateDocument(String indexName,
+ DocumentStoreDataEntity document,
+ boolean allowImplicitIndexCreation)
throws DocumentStoreOperationException {
+
+ if(!allowImplicitIndexCreation) {
+
+ // Before we do anything, make sure that the specified index actually exists in the
+ // document store - we don't want to rely on ElasticSearch to fail the document
+ // create because it could be configured to implicitly create a non-existent index,
+ // which can lead to hard-to-debug behaviour with queries down the road.
+ OperationResult indexExistsResult = checkIndexExistence(indexName);
+ if ((indexExistsResult.getResultCode() < 200) || (indexExistsResult.getResultCode() >= 300)) {
+
+ DocumentOperationResult opResult = new DocumentOperationResult();
+ opResult.setResultCode(Status.NOT_FOUND.getStatusCode());
+ opResult.setResult("Document Index '" + indexName + "' does not exist.");
+ opResult.setFailureCause("Document Index '" + indexName + "' does not exist.");
+ return opResult;
+ }
+ }
+
DocumentOperationResult opResult = new DocumentOperationResult();
// Initialize operation result with a failure codes / fault string
@Override
- public OperationResult createIndex(String index, DocumentSchema documentSchema) {
+ public OperationResult createIndex(String index,
+ DocumentSchema documentSchema) {
// Just return an OK result, with the parameters that we were passed
// bundled in the response string. This allows unit tests to validate
}
@Override
- public DocumentOperationResult createDocument(String indexName,
- DocumentStoreDataEntity document) throws DocumentStoreOperationException {
+ public DocumentOperationResult createDocument(String indexName,
+ DocumentStoreDataEntity document,
+ boolean allowImplicitIndexCreation)
+ throws DocumentStoreOperationException {
+
DocumentOperationResult opResult = buildSampleDocumentOperationResult();
if (indexName.equals(DOES_NOT_EXIST_INDEX)) {
}
@Override
- public DocumentOperationResult updateDocument(String indexName,
- DocumentStoreDataEntity document) throws DocumentStoreOperationException {
+ public DocumentOperationResult updateDocument(String indexName,
+ DocumentStoreDataEntity document,
+ boolean allowImplicitIndexCreation)
+ throws DocumentStoreOperationException {
+
DocumentOperationResult opResult = buildSampleDocumentOperationResult();
if (indexName.equals(DOES_NOT_EXIST_INDEX)) {
@Test
public void testCreateDocument() throws Exception {
- OperationResult result = elasticSearch.createDocument("test", testDocument);
+ OperationResult result = elasticSearch.createDocument("test", testDocument, false);
System.out.println(result);
DocumentStoreDataEntityImpl ds = new DocumentStoreDataEntityImpl();
public void testUpdateDocument() throws Exception {
testDocument.setEdgeTagQueryEntityFieldValue("567890");
- OperationResult result = elasticSearch.updateDocument("test", testDocument);
+ OperationResult result = elasticSearch.updateDocument("test", testDocument, false);
System.out.println(result);
result = elasticSearch.getDocument("test", testDocument);
doc.setSearchTagIDs("" + i);
doc.setSearchTags("service-instance-id");
- OperationResult result = elasticSearch.createDocument("test", doc);
+ OperationResult result = elasticSearch.createDocument("test", doc, false);
System.out.println(result);
}
}
doc.setSearchTagIDs("321");
doc.setSearchTags("service-instance-id");
- OperationResult result = elasticSearch.createDocument("test", doc);
+ OperationResult result = elasticSearch.createDocument("test", doc, false);
System.out.println(result);
}