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

import java.util.HashMap;
import java.util.Map;

public class Constants {

  public static final String ZOOKEEPER_ROOT = "/metron";
  public static final String ZOOKEEPER_TOPOLOGY_ROOT = ZOOKEEPER_ROOT + "/topology";
  public static final long DEFAULT_CONFIGURED_BOLT_TIMEOUT = 5000;
  public static final String SENSOR_TYPE = "source.type";
  public static final String SENSOR_TYPE_FIELD_PROPERTY = "source.type.field";
  public static final String THREAT_SCORE_FIELD_PROPERTY = "threat.triage.score.field";
  public static final String ENRICHMENT_TOPIC = "enrichments";
  public static final String INDEXING_TOPIC = "indexing";
  public static final String ERROR_STREAM = "error";
  public static final String ERROR_TYPE = "error";
  public static final String SIMPLE_HBASE_ENRICHMENT = "hbaseEnrichment";
  public static final String SIMPLE_HBASE_THREAT_INTEL = "hbaseThreatIntel";
  public static final String STELLAR_CONTEXT_CONF = "stellarContext";
  public static final String GUID = "guid";

  /**
   * The key in the global configuration that defines the global parser error topic.
   *
   * <p>This value is used only if the error topic is left undefined in a sensor's parser configuration.
   */
  public static final String PARSER_ERROR_TOPIC_GLOBALS_KEY = "parser.error.topic";

  public interface Field {
    String getName();
  }

  public enum Fields implements Field {
     SRC_ADDR("ip_src_addr")
    ,SRC_PORT("ip_src_port")
    ,DST_ADDR("ip_dst_addr")
    ,DST_PORT("ip_dst_port")
    ,PROTOCOL("protocol")
    ,TIMESTAMP("timestamp")
    ,ORIGINAL("original_string")
    ,INCLUDES_REVERSE_TRAFFIC("includes_reverse_traffic")
    ;
    private static Map<String, Fields> nameToField;

    static {
      nameToField = new HashMap<>();
      for (Fields f : Fields.values()) {
        nameToField.put(f.getName(), f);
      }
    }

    private String name;

    Fields(String name) {
      this.name = name;
    }

    public String getName() {
      return name;
    }

    public static Fields fromString(String fieldName) {
      return nameToField.get(fieldName);
    }
  }

  public enum ErrorFields {
    MESSAGE("message")
    ,FAILED_SENSOR_TYPE("failed_sensor_type")
    ,ERROR_TYPE("error_type")
    ,EXCEPTION("exception")
    ,STACK("stack")
    ,TIMESTAMP("timestamp")
    ,HOSTNAME("hostname")
    ,RAW_MESSAGE("raw_message")
    ,RAW_MESSAGE_BYTES("raw_message_bytes")
    ,ERROR_FIELDS("error_fields")
    ,ERROR_HASH("error_hash")
    ,METADATA("metadata")
    ;

    private String name;

    ErrorFields(String name) {
      this.name = name;
    }

    public String getName() {
      return name;
    }
  }

  public enum ErrorType {

     PARSER_ERROR("parser_error")
    ,PARSER_INVALID("parser_invalid")
    ,ENRICHMENT_ERROR("enrichments_error")
    ,THREAT_INTEL_ERROR("threatintel_error")
    ,INDEXING_ERROR("indexing_error")
    ,DEFAULT_ERROR("error")
    ;

    private String type;

    ErrorType(String type) {
      this.type = type;
    }

    public String getType() {
      return type;
    }
  }

}