metron-platform/metron-indexing/metron-indexing-common/src/main/java/org/apache/metron/indexing/dao/update/UpdateDao.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.metron.indexing.dao.update;

import org.apache.metron.indexing.dao.RetrieveLatestDao;

import java.io.IOException;
import java.util.Map;
import java.util.Optional;

import static java.lang.String.format;

public interface UpdateDao {

  /**
   * Update a given Document and optionally the index where the document exists.  This is a full
   * update, meaning the current document will be replaced if it exists or a new document will be
   * created if it does not exist.  Partial updates are not supported in this method.
   *
   * @param update The document to replace from the index.
   * @param index The index where the document lives.
   * @return The updated document
   * @throws IOException If an error occurs during the update.
   */
  Document update(Document update, Optional<String> index) throws IOException;

  /**
   * Similar to the update method but accepts multiple documents and performs updates in batch.
   *
   * @param updates A map of the documents to update to the index where they live.
   * @return The updated documents.
   * @throws IOException If an error occurs during the updates.
   */
  Map<Document, Optional<String>> batchUpdate(Map<Document, Optional<String>> updates) throws IOException;

  Document addCommentToAlert(CommentAddRemoveRequest request) throws IOException;

  Document removeCommentFromAlert(CommentAddRemoveRequest request) throws IOException;

  Document addCommentToAlert(CommentAddRemoveRequest request, Document latest) throws IOException;

  Document removeCommentFromAlert(CommentAddRemoveRequest request, Document latest) throws IOException;

  /**
   * Update a document in an index given a JSON Patch (see RFC 6902 at
   * https://tools.ietf.org/html/rfc6902)
   * @param request The patch request
   * @param timestamp Optionally a timestamp to set. If not specified then current time is used.
   * @return The patched document.
   * @throws OriginalNotFoundException If the original is not found, then it cannot be patched.
   * @throws IOException If an error occurs while patching.
   */
  default Document patch(RetrieveLatestDao retrieveLatestDao, PatchRequest request
      , Optional<Long> timestamp
  ) throws OriginalNotFoundException, IOException {
    Document d = getPatchedDocument(retrieveLatestDao, request, timestamp);
    return update(d, Optional.ofNullable(request.getIndex()));
  }

  default Document getPatchedDocument(RetrieveLatestDao retrieveLatestDao, PatchRequest request,
      Optional<Long> optionalTimestamp
  ) throws OriginalNotFoundException, IOException {
    String guid = request.getGuid();
    String sensorType = request.getSensorType();
    String documentID = null;
    Long timestamp = optionalTimestamp.orElse(System.currentTimeMillis());

    Map<String, Object> originalSource = request.getSource();
    if (originalSource == null) {
      // no document source provided, lookup the latest
      Document toPatch = retrieveLatestDao.getLatest(guid, sensorType);
      if(toPatch != null && toPatch.getDocument() != null) {
        originalSource = toPatch.getDocument();
        documentID = toPatch.getDocumentID().orElse(null);

      } else {
        String error = format("Document does not exist, but is required; guid=%s, sensorType=%s", guid, sensorType);
        throw new OriginalNotFoundException(error);
      }
    }

    Map<String, Object> patchedSource = PatchUtils.INSTANCE.applyPatch(request.getPatch(), originalSource);
    return new Document(patchedSource, guid, sensorType, timestamp, documentID);
  }
}