metron-platform/metron-common/src/main/java/org/apache/metron/common/configuration/IndexingConfigurations.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.common.configuration;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.metron.common.utils.JSONUtils;

/**
 * Allows for retrieval and update of indexing configurations.
 */
public class IndexingConfigurations extends Configurations {
  public static final String BATCH_SIZE_CONF = "batchSize";
  public static final String BATCH_TIMEOUT_CONF = "batchTimeout";
  public static final String ENABLED_CONF = "enabled";
  public static final String INDEX_CONF = "index";
  public static final String OUTPUT_PATH_FUNCTION_CONF = "outputPathFunction";
  public static final String FIELD_NAME_CONVERTER_CONF = "fieldNameConverter";
  public static final String SET_DOCUMENT_ID_CONF = "setDocumentId";
  public static final String GLOBAL_ELASTICSEARCH_SET_DOCUMENT_ID_CONF = "indexing.writer.elasticsearch.setDocumentId";

  /**
   * Gets the indexing config for a specific sensor.
   *
   * @param sensorType The sensor to retrieve config for
   * @param emptyMapOnNonExistent If true and the config doesn't exist return empty map, else null
   * @return Map of the config key -> value. Value on missing depends on emptyMapOnNonExistent
   */
  public Map<String, Object> getSensorIndexingConfig(String sensorType, boolean emptyMapOnNonExistent) {
    Map<String, Object> ret = (Map<String, Object>) getConfigurations().get(getKey(sensorType));
    if(ret == null) {
      return emptyMapOnNonExistent?new HashMap<>():null;
    }
    else {
      return ret;
    }
  }

  public Map<String, Object> getSensorIndexingConfig(String sensorType) {
    return getSensorIndexingConfig(sensorType, true);
  }

  /**
   * Gets the list of sensor types that indexing configurations exist for.
   *
   * @return List of sensor types
   */
  public List<String> getTypes() {
    List<String> ret = new ArrayList<>();
    for(String keyedSensor : getConfigurations().keySet()) {
      if(!keyedSensor.isEmpty() && keyedSensor.startsWith(ConfigurationType.INDEXING.getTypeName())) {
        ret.add(keyedSensor.substring(ConfigurationType.INDEXING.getTypeName().length() + 1));
      }
    }
    return ret;
  }

  public void delete(String sensorType) {
    getConfigurations().remove(getKey(sensorType));
  }

  /**
   * Gets the sensor indexing config for a given writer.
   *
   * @param sensorType The sensor to retrieve configs for
   * @param writerName The particular writer to get configurations for
   * @return A Map of the configuration
   */
  public Map<String, Object> getSensorIndexingConfig(String sensorType, String writerName) {
    String key = getKey(sensorType);
    Map<String, Object> ret = (Map<String, Object>) getConfigurations().get(key);
    if(ret == null) {
      return new HashMap();
    }
    else {
      Map<String, Object> writerConfig = (Map<String, Object>)ret.get(writerName);
      return writerConfig != null?writerConfig:new HashMap<>();
    }
  }

  public void updateSensorIndexingConfig(String sensorType, byte[] data) throws IOException {
    updateSensorIndexingConfig(sensorType, new ByteArrayInputStream(data));
  }

  public void updateSensorIndexingConfig(String sensorType, InputStream io) throws IOException {
    Map<String, Object> sensorIndexingConfig = JSONUtils.INSTANCE.load(io, JSONUtils.MAP_SUPPLIER);
    updateSensorIndexingConfig(sensorType, sensorIndexingConfig);
  }

  public void updateSensorIndexingConfig(String sensorType, Map<String, Object> sensorIndexingConfig) {
    getConfigurations().put(getKey(sensorType), sensorIndexingConfig);
  }

  public static String getKey(String sensorType) {
    return ConfigurationType.INDEXING.getTypeName() + "." + sensorType;
  }

  /**
   * Determines if a configuration is default or not. In particular, this means the config is null
   * for the sensor/writer combo.
   *
   * @param sensorName The sensor to check for default
   * @param writerName The specific writer to check for default
   * @return True if default, false otherwise.
   */
  public boolean isDefault(String sensorName, String writerName) {
    Map<String, Object> ret = (Map<String, Object>) getConfigurations().get(getKey(sensorName));
    if(ret == null) {
      return true;
    }
    else {
      Map<String, Object> writerConfig = (Map<String, Object>)ret.get(writerName);
      return writerConfig != null?false:true;
    }
  }

  public int getBatchSize(String sensorName, String writerName ) {
    return getBatchSize(getSensorIndexingConfig(sensorName, writerName));
  }

  public int getBatchTimeout(String sensorName, String writerName ) {
    return getBatchTimeout(getSensorIndexingConfig(sensorName, writerName));
  }

  /**
   * Returns all configured values of batchTimeout, for all configured sensors,
   * but only for the specific writer identified by {@code writerName}.  So, if it is
   * an hdfs writer, it will return the batchTimeouts for hdfs writers for all the sensors.
   * The goal is to return to a {@link org.apache.metron.common.bolt.ConfiguredBolt}
   * the set of all and only batchTimeouts relevant to that ConfiguredBolt.
   *
   * @param writerName The name of the writer to look up.
   * @return list of integer batchTimeouts, one per configured sensor
   */
  public List<Integer> getAllConfiguredTimeouts(String writerName) {
    // The configuration infrastructure was not designed to enumerate sensors, so we synthesize.
    // Since getKey is in this same class, we know we can pass it a null string to get the key prefix
    // for all sensor types within this capability.  We then enumerate all keys in configurations.keySet
    // and select those that match the key prefix, as being sensor keys.  The suffix substring of
    // each such key is used as a sensor name to query the batchTimeout settings, if any.
    String keyPrefixString = getKey("");
    int prefixStringLength = keyPrefixString.length();
    List<Integer> configuredBatchTimeouts = new ArrayList<>();
    for (String sensorKeyString : getConfigurations().keySet()) {
      if (sensorKeyString.startsWith(keyPrefixString)) {
        String configuredSensorName = sensorKeyString.substring(prefixStringLength);
        configuredBatchTimeouts.add(getBatchTimeout(configuredSensorName, writerName));
      }
    }
    return configuredBatchTimeouts;
  }

  public String getIndex(String sensorName, String writerName) {
    return getIndex(getSensorIndexingConfig(sensorName, writerName), sensorName);
  }

  public boolean isEnabled(String sensorName, String writerName) {
    return isEnabled(getSensorIndexingConfig(sensorName, writerName));
  }

  public String getOutputPathFunction(String sensorName, String writerName) {
    return getOutputPathFunction(getSensorIndexingConfig(sensorName, writerName), sensorName);
  }

  public String getFieldNameConverter(String sensorName, String writerName) {
    return getFieldNameConverter(getSensorIndexingConfig(sensorName, writerName), sensorName);
  }

  public boolean isSetDocumentId(String sensorName, String writerName) {
    return isSetDocumentId(getGlobalConfig(true), getSensorIndexingConfig(sensorName, writerName));
  }

  /**
   *  Retrieves the enabled value from the config.
   *
   * @param conf The configuration to retrieve from
   * @return True if this configuration is enabled, false otherwise
   */
  public static boolean isEnabled(Map<String, Object> conf) {
    return getAs( ENABLED_CONF
                 ,conf
                , true
                , Boolean.class
                );
  }

  /**
   *  Retrieves the batch size value from the config.
   *
   * @param conf The configuration to retrieve from
   * @return  The batch size if defined, 1 by default
   */
  public static int getBatchSize(Map<String, Object> conf) {
    return getAs( BATCH_SIZE_CONF
                 ,conf
                , 1
                , Integer.class
                );
  }

  /**
   *  Retrieves the batch timeout value from the config.
   *
   * @param conf The configuration to retrieve from
   * @return  The batch timeout if defined, 0 by default
   */
  public static int getBatchTimeout(Map<String, Object> conf) {
    return getAs( BATCH_TIMEOUT_CONF
                 ,conf
                , 0
                , Integer.class
                );
  }

  /**
   *  Retrieves the index value from the config.
   *
   * @param conf The configuration to retrieve from
   * @param sensorName The name of the sensor to retrieve the index for
   * @return  The index if defined, the sensor name by default
   */
  public static String getIndex(Map<String, Object> conf, String sensorName) {
    return getAs( INDEX_CONF
                 ,conf
                , sensorName
                , String.class
                );
  }

  /**
   *  Retrieves the output path function value from the config.
   *
   * @param conf The configuration to retrieve from
   * @param sensorName Unused
   * @return  The output path function if defined, empty string otherwise
   */
  public static String getOutputPathFunction(Map<String, Object> conf, String sensorName) {
    return getAs(OUTPUT_PATH_FUNCTION_CONF
            ,conf
            , ""
            , String.class
    );
  }

  /**
   *  Retrieves the field name converter value from the config.
   *
   * @param conf The configuration to retrieve from
   * @param sensorName Unused
   * @return  The field name converter if defined, empty string otherwise
   */
  public static String getFieldNameConverter(Map<String, Object> conf, String sensorName) {
    return getAs(FIELD_NAME_CONVERTER_CONF, conf, "", String.class);
  }

  /**
   * Determines if the Metron generated id should be used when indexing
   *
   * @param globalConf The global config
   * @param sensorConf The indexing config for a given sensor
   * @return True if the Metron generated id should be used as the id, False otherwise
   */
  public static boolean isSetDocumentId(Map<String, Object> globalConf, Map<String, Object> sensorConf) {
    return getAs(SET_DOCUMENT_ID_CONF, sensorConf, getAs(GLOBAL_ELASTICSEARCH_SET_DOCUMENT_ID_CONF, globalConf, false, Boolean.class), Boolean.class);
  }

  /**
   * Sets the enabled flag in the config.
   *
   * @param conf The configuration map to set enabled in. If null replaced with empty map.
   * @param enabled True if enabled, false otherwise
   * @return The configuration with the enabled value set
   */
  public static Map<String, Object> setEnabled(Map<String, Object> conf, boolean enabled) {
    Map<String, Object> ret = conf == null?new HashMap<>():conf;
    ret.put(ENABLED_CONF, enabled);
    return ret;
  }

  /**
   * Sets the batch size in the config.
   *
   * @param conf The configuration map to set enabled in. If null, replaced with empty map.
   * @param batchSize The desired batch size
   * @return The configuration with the batch size value set
   */
  public static Map<String, Object> setBatchSize(Map<String, Object> conf, int batchSize) {
    Map<String, Object> ret = conf == null?new HashMap<>():conf;
    ret.put(BATCH_SIZE_CONF, batchSize);
    return ret;
  }

  /**
   * Sets the batch timeout in the config.
   *
   * @param conf The configuration map to set enabled in. If null, replaced with empty map.
   * @param batchTimeout The desired batch timeout
   * @return The configuration with the batch timeout value set
   */
  public static Map<String, Object> setBatchTimeout(Map<String, Object> conf, int batchTimeout) {
    Map<String, Object> ret = conf == null?new HashMap<>():conf;
    ret.put(BATCH_TIMEOUT_CONF, batchTimeout);
    return ret;
  }

  /**
   * Sets the index in the config.
   *
   * @param conf The configuration map to set enabled in. If null, replaced with empty map.
   * @param index The desired index
   * @return The configuration with the index value set
   */
  public static Map<String, Object> setIndex(Map<String, Object> conf, String index) {
    Map<String, Object> ret = conf == null?new HashMap<>():conf;
    ret.put(INDEX_CONF, index);
    return ret;
  }

  /**
   * Sets the field name converter in the config.
   *
   * @param conf The configuration map to set enabled in. If null, replaced with empty map.
   * @param index The desired index
   * @return The configuration with the field name converter value set
   */
  public static Map<String, Object> setFieldNameConverter(Map<String, Object> conf, String index) {
    Map<String, Object> ret = conf == null ? new HashMap<>(): conf;
    ret.put(FIELD_NAME_CONVERTER_CONF, index);
    return ret;
  }

}