com.mozilla.secops.alert

Enum AlertMeta.Key

java.lang.Object

java.lang.Enum<AlertMeta.Key>

com.mozilla.secops.alert.AlertMeta.Key

All Implemented Interfaces:

Serializable, Comparable<AlertMeta.Key>

Enclosing class:

AlertMeta

public static enum AlertMeta.Key
extends Enum<AlertMeta.Key>

Keys that may be used for alert metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlertMeta.Key.AssociatedKey Associated key identifiers
static class	AlertMeta.Key.ValueType Storage formats for value fields

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDON_FILENAME
ADDON_FROM_API
ADDON_GUID
ADDON_ID
ADDON_SIZE
ADDON_UPLOAD_HASH
ADDON_USER_ID
ADDON_VERSION
ALERT_HANDLING_SEVERITY
ALERT_NOTIFICATION_TYPE
ALERT_SUBCATEGORY_FIELD
ALERTIO_IGNORE_EVENT
AUTH_ALERT_TYPE
AWS_ACCOUNT_ID
AWS_ACCOUNT_NAME
AWS_REGION
BYTES
COUNT
DESCRIPTION
DOC_LINK
EMAIL
EMAIL_CONTACT
EMAIL_SIMILAR
END
ENDPOINT
ENDPOINT_PATTERN
ENTRY_KEY
ERROR_COUNT
ERROR_THRESHOLD
ESCALATE_TO
EVENT_TIMESTAMP
EVENT_TIMESTAMP_SOURCE_LOCAL
FINDING_ID
FINDING_TYPE
IDENTITY_KEY
IDENTITY_UNTRACKED
INDICATOR
INSTANCE_NAME
IPREPD_EXEMPT
IPREPD_EXEMPT_CREATED_BY
IPREPD_SUPPRESS_RECOVERY
KM_DISTANCE
MATCHED_METADATA_KEY
MATCHED_METADATA_VALUE
MATCHED_OBJECT
MATCHED_TYPE
MEAN
METHOD
MONITORED_RESOURCE
NOTIFY_EMAIL_DIRECT
NOTIFY_MERGE
NOTIFY_MERGED_COUNT
NOTIFY_SLACK_DIRECT
NOTIFY_SLACK_SUPPLEMENTARY
OBJECT
PROJECT_ID
PROJECT_NUMBER
PROVIDER
REAL_ADDRESS_HASH_ACTUAL
REAL_ADDRESS_HASH_EXPECTED
REFERENCE_ID
REQUEST_THRESHOLD
RESOURCE
RESTRICTED_VALUE
RULE_NAME
SLACK_SUPPLEMENTARY_MESSAGE
SOURCE_ALERT
SOURCEADDRESS
SOURCEADDRESS_AS_ORG
SOURCEADDRESS_ASN
SOURCEADDRESS_CITY
SOURCEADDRESS_COUNTRY
SOURCEADDRESS_IS_ANONYMOUS
SOURCEADDRESS_IS_ANONYMOUS_VPN
SOURCEADDRESS_IS_HOSTING_PROVIDER
SOURCEADDRESS_IS_LEGITIMATE_PROXY
SOURCEADDRESS_IS_PUBLIC_PROXY
SOURCEADDRESS_IS_TOR_EXIT_NODE
SOURCEADDRESS_ISP
SOURCEADDRESS_PREVIOUS
SOURCEADDRESS_PREVIOUS_AS_ORG
SOURCEADDRESS_PREVIOUS_ASN
SOURCEADDRESS_PREVIOUS_CITY
SOURCEADDRESS_PREVIOUS_COUNTRY
SOURCEADDRESS_PREVIOUS_ISP
SOURCEADDRESS_RISKSCORE
SOURCEADDRESS_TIMEZONE
SOURCEADDRESSES
START
STATE_ACTION_TYPE
STATUS
TECHNIQUE
TEMPLATE_NAME_EMAIL
TEMPLATE_NAME_SLACK
TEMPLATE_NAME_SLACK_CATCHALL
THRESHOLD
THRESHOLD_MODIFIER
TIME_DELTA_SECONDS
TOTAL_ADDRESS_COUNT
TOTAL_ALERT_COUNT
UID
URL_TO_FINDING
USERAGENT
USERNAME
WATCHLIST_CREATED_BY
WINDOW_TIMESTAMP

Method Summary

Modifier and Type	Method and Description
AlertMeta.Key	getAssociatedKey(AlertMeta.Key.AssociatedKey association) Obtain given associated key type
boolean	getIsSensitive() Return if key is considered sensitive
String	getKey() Return the string that will be used as the metadata key
AlertMeta.Key.ValueType	getValueType() Get value field type
boolean	validate(String value) Validate the format of a value to be used for this key
static AlertMeta.Key	valueOf(String name) Returns the enum constant of this type with the specified name.
static AlertMeta.Key[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADDON_FILENAME

public static final AlertMeta.Key ADDON_FILENAME

ADDON_FROM_API

public static final AlertMeta.Key ADDON_FROM_API

ADDON_GUID

public static final AlertMeta.Key ADDON_GUID

ADDON_ID

public static final AlertMeta.Key ADDON_ID

ADDON_SIZE

public static final AlertMeta.Key ADDON_SIZE

ADDON_UPLOAD_HASH

public static final AlertMeta.Key ADDON_UPLOAD_HASH

ADDON_USER_ID

public static final AlertMeta.Key ADDON_USER_ID

ADDON_VERSION

public static final AlertMeta.Key ADDON_VERSION

ALERT_HANDLING_SEVERITY

public static final AlertMeta.Key ALERT_HANDLING_SEVERITY

ALERT_NOTIFICATION_TYPE

public static final AlertMeta.Key ALERT_NOTIFICATION_TYPE

ALERT_SUBCATEGORY_FIELD

public static final AlertMeta.Key ALERT_SUBCATEGORY_FIELD

ALERTIO_IGNORE_EVENT

public static final AlertMeta.Key ALERTIO_IGNORE_EVENT

AUTH_ALERT_TYPE

public static final AlertMeta.Key AUTH_ALERT_TYPE

AWS_ACCOUNT_ID

public static final AlertMeta.Key AWS_ACCOUNT_ID

AWS_ACCOUNT_NAME

public static final AlertMeta.Key AWS_ACCOUNT_NAME

AWS_REGION

public static final AlertMeta.Key AWS_REGION

BYTES

public static final AlertMeta.Key BYTES

COUNT

public static final AlertMeta.Key COUNT

DESCRIPTION

public static final AlertMeta.Key DESCRIPTION

DOC_LINK

public static final AlertMeta.Key DOC_LINK

EMAIL

public static final AlertMeta.Key EMAIL

EMAIL_CONTACT

public static final AlertMeta.Key EMAIL_CONTACT

EMAIL_SIMILAR

public static final AlertMeta.Key EMAIL_SIMILAR

END

public static final AlertMeta.Key END

ENDPOINT

public static final AlertMeta.Key ENDPOINT

ENDPOINT_PATTERN

public static final AlertMeta.Key ENDPOINT_PATTERN

ENTRY_KEY

public static final AlertMeta.Key ENTRY_KEY

ERROR_COUNT

public static final AlertMeta.Key ERROR_COUNT

ERROR_THRESHOLD

public static final AlertMeta.Key ERROR_THRESHOLD

ESCALATE_TO

public static final AlertMeta.Key ESCALATE_TO

EVENT_TIMESTAMP

public static final AlertMeta.Key EVENT_TIMESTAMP

EVENT_TIMESTAMP_SOURCE_LOCAL

public static final AlertMeta.Key EVENT_TIMESTAMP_SOURCE_LOCAL

FINDING_ID

public static final AlertMeta.Key FINDING_ID

FINDING_TYPE

public static final AlertMeta.Key FINDING_TYPE

IDENTITY_KEY

public static final AlertMeta.Key IDENTITY_KEY

IDENTITY_UNTRACKED

public static final AlertMeta.Key IDENTITY_UNTRACKED

INDICATOR

public static final AlertMeta.Key INDICATOR

INSTANCE_NAME

public static final AlertMeta.Key INSTANCE_NAME

IPREPD_EXEMPT

public static final AlertMeta.Key IPREPD_EXEMPT

IPREPD_EXEMPT_CREATED_BY

public static final AlertMeta.Key IPREPD_EXEMPT_CREATED_BY

IPREPD_SUPPRESS_RECOVERY

public static final AlertMeta.Key IPREPD_SUPPRESS_RECOVERY

KM_DISTANCE

public static final AlertMeta.Key KM_DISTANCE

MATCHED_METADATA_KEY

public static final AlertMeta.Key MATCHED_METADATA_KEY

MATCHED_METADATA_VALUE

public static final AlertMeta.Key MATCHED_METADATA_VALUE

MATCHED_OBJECT

public static final AlertMeta.Key MATCHED_OBJECT

MATCHED_TYPE

public static final AlertMeta.Key MATCHED_TYPE

MEAN

public static final AlertMeta.Key MEAN

METHOD

public static final AlertMeta.Key METHOD

MONITORED_RESOURCE

public static final AlertMeta.Key MONITORED_RESOURCE

NOTIFY_EMAIL_DIRECT

public static final AlertMeta.Key NOTIFY_EMAIL_DIRECT

NOTIFY_MERGE

public static final AlertMeta.Key NOTIFY_MERGE

NOTIFY_MERGED_COUNT

public static final AlertMeta.Key NOTIFY_MERGED_COUNT

NOTIFY_SLACK_DIRECT

public static final AlertMeta.Key NOTIFY_SLACK_DIRECT

NOTIFY_SLACK_SUPPLEMENTARY

public static final AlertMeta.Key NOTIFY_SLACK_SUPPLEMENTARY

OBJECT

public static final AlertMeta.Key OBJECT

PROJECT_ID

public static final AlertMeta.Key PROJECT_ID

PROJECT_NUMBER

public static final AlertMeta.Key PROJECT_NUMBER

PROVIDER

public static final AlertMeta.Key PROVIDER

REAL_ADDRESS_HASH_ACTUAL

public static final AlertMeta.Key REAL_ADDRESS_HASH_ACTUAL

REAL_ADDRESS_HASH_EXPECTED

public static final AlertMeta.Key REAL_ADDRESS_HASH_EXPECTED

REFERENCE_ID

public static final AlertMeta.Key REFERENCE_ID

REQUEST_THRESHOLD

public static final AlertMeta.Key REQUEST_THRESHOLD

RESOURCE

public static final AlertMeta.Key RESOURCE

RESTRICTED_VALUE

public static final AlertMeta.Key RESTRICTED_VALUE

RULE_NAME

public static final AlertMeta.Key RULE_NAME

SLACK_SUPPLEMENTARY_MESSAGE

public static final AlertMeta.Key SLACK_SUPPLEMENTARY_MESSAGE

SOURCE_ALERT

public static final AlertMeta.Key SOURCE_ALERT

SOURCEADDRESS_AS_ORG

public static final AlertMeta.Key SOURCEADDRESS_AS_ORG

SOURCEADDRESS_ASN

public static final AlertMeta.Key SOURCEADDRESS_ASN

SOURCEADDRESS_CITY

public static final AlertMeta.Key SOURCEADDRESS_CITY

SOURCEADDRESS_COUNTRY

public static final AlertMeta.Key SOURCEADDRESS_COUNTRY

SOURCEADDRESS_IS_ANONYMOUS

public static final AlertMeta.Key SOURCEADDRESS_IS_ANONYMOUS

SOURCEADDRESS_IS_ANONYMOUS_VPN

public static final AlertMeta.Key SOURCEADDRESS_IS_ANONYMOUS_VPN

SOURCEADDRESS_IS_HOSTING_PROVIDER

public static final AlertMeta.Key SOURCEADDRESS_IS_HOSTING_PROVIDER

SOURCEADDRESS_IS_LEGITIMATE_PROXY

public static final AlertMeta.Key SOURCEADDRESS_IS_LEGITIMATE_PROXY

SOURCEADDRESS_IS_PUBLIC_PROXY

public static final AlertMeta.Key SOURCEADDRESS_IS_PUBLIC_PROXY

SOURCEADDRESS_IS_TOR_EXIT_NODE

public static final AlertMeta.Key SOURCEADDRESS_IS_TOR_EXIT_NODE

SOURCEADDRESS_ISP

public static final AlertMeta.Key SOURCEADDRESS_ISP

SOURCEADDRESS_PREVIOUS_AS_ORG

public static final AlertMeta.Key SOURCEADDRESS_PREVIOUS_AS_ORG

SOURCEADDRESS_PREVIOUS_ASN

public static final AlertMeta.Key SOURCEADDRESS_PREVIOUS_ASN

SOURCEADDRESS_PREVIOUS_CITY

public static final AlertMeta.Key SOURCEADDRESS_PREVIOUS_CITY

SOURCEADDRESS_PREVIOUS_COUNTRY

public static final AlertMeta.Key SOURCEADDRESS_PREVIOUS_COUNTRY

SOURCEADDRESS_PREVIOUS_ISP

public static final AlertMeta.Key SOURCEADDRESS_PREVIOUS_ISP

SOURCEADDRESS_RISKSCORE

public static final AlertMeta.Key SOURCEADDRESS_RISKSCORE

SOURCEADDRESS_TIMEZONE

public static final AlertMeta.Key SOURCEADDRESS_TIMEZONE

SOURCEADDRESSES

public static final AlertMeta.Key SOURCEADDRESSES

START

public static final AlertMeta.Key START

STATE_ACTION_TYPE

public static final AlertMeta.Key STATE_ACTION_TYPE

STATUS

public static final AlertMeta.Key STATUS

TECHNIQUE

public static final AlertMeta.Key TECHNIQUE

TEMPLATE_NAME_EMAIL

public static final AlertMeta.Key TEMPLATE_NAME_EMAIL

TEMPLATE_NAME_SLACK

public static final AlertMeta.Key TEMPLATE_NAME_SLACK

TEMPLATE_NAME_SLACK_CATCHALL

public static final AlertMeta.Key TEMPLATE_NAME_SLACK_CATCHALL

THRESHOLD

public static final AlertMeta.Key THRESHOLD

THRESHOLD_MODIFIER

public static final AlertMeta.Key THRESHOLD_MODIFIER

TIME_DELTA_SECONDS

public static final AlertMeta.Key TIME_DELTA_SECONDS

TOTAL_ADDRESS_COUNT

public static final AlertMeta.Key TOTAL_ADDRESS_COUNT

TOTAL_ALERT_COUNT

public static final AlertMeta.Key TOTAL_ALERT_COUNT

UID

public static final AlertMeta.Key UID

USERAGENT

public static final AlertMeta.Key USERAGENT

USERNAME

public static final AlertMeta.Key USERNAME

URL_TO_FINDING

public static final AlertMeta.Key URL_TO_FINDING

WATCHLIST_CREATED_BY

public static final AlertMeta.Key WATCHLIST_CREATED_BY

WINDOW_TIMESTAMP

public static final AlertMeta.Key WINDOW_TIMESTAMP

SOURCEADDRESS

public static final AlertMeta.Key SOURCEADDRESS

SOURCEADDRESS_PREVIOUS

public static final AlertMeta.Key SOURCEADDRESS_PREVIOUS

Method Detail

values

public static AlertMeta.Key[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AlertMeta.Key c : AlertMeta.Key.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AlertMeta.Key valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Return the string that will be used as the metadata key

Returns:

String

getIsSensitive

public boolean getIsSensitive()

Return if key is considered sensitive

Returns:

boolean

getValueType

public AlertMeta.Key.ValueType getValueType()

Get value field type

Returns:

ValueType

getAssociatedKey

public AlertMeta.Key getAssociatedKey(AlertMeta.Key.AssociatedKey association)

Obtain given associated key type

If a key associated has been established for this key of a given type, return the associated key. Returns null if no association has been established.

Parameters:

association - Association type

Returns:

Key or null if not found

validate

public boolean validate(String value)

Validate the format of a value to be used for this key

Parameters:

value - Value

Returns:

True if value was formatted correctly for key