com.mozilla.secops

Class Watchlist

java.lang.Object

com.mozilla.secops.Watchlist

public class Watchlist
extends Object

Watchlist is used by pipelines to query watchlist entries stored within Datastore.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Watchlist.WatchlistEntry

Field Summary

Fields

Modifier and Type	Field and Description
static String	watchlistDatastoreNamespace Namespace for watchlist entries in Datastore
static String	watchlistEmailKind Kind for watchlist email entry in Datastore
static String	watchlistIpKind Kind for watchlist IP entry in Datastore

Constructor Summary

Constructors

Constructor and Description
Watchlist() Return a new watchlist interface for fetching watchlist entries
Watchlist(String datastoreProject) Return a new watchlist interface for fetching watchlist entries

Method Summary

Modifier and Type	Method and Description
void	done() Closes state interfaces to datastore.
Watchlist.WatchlistEntry[]	getWatchedEmails() Returns watched email addresses
Watchlist.WatchlistEntry[]	getWatchedIPs() Returns watched ip addresses
ArrayList<Watchlist.WatchlistEntry>	getWatchlistEntries(String type, ArrayList<String> values) Get all watchlist entries of the specific type that match a value in the provided value array.
static void	main(String[] args) main routine used to create watchlist entries.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

watchlistDatastoreNamespace

public static final String watchlistDatastoreNamespace

Namespace for watchlist entries in Datastore

See Also:

Constant Field Values

watchlistIpKind

public static final String watchlistIpKind

Kind for watchlist IP entry in Datastore

See Also:

Constant Field Values

watchlistEmailKind

public static final String watchlistEmailKind

Kind for watchlist email entry in Datastore

See Also:

Constant Field Values

Constructor Detail

Watchlist

public Watchlist()
          throws StateException

Return a new watchlist interface for fetching watchlist entries

Throws:

StateException - StateException

Watchlist

public Watchlist(String datastoreProject)
          throws StateException

Return a new watchlist interface for fetching watchlist entries

Supports specifiying a GCP project name where the watchlist entries are stored in Datastore

Parameters:

datastoreProject - GCP project name that contains the watchlist entries

Throws:

StateException - StateException

Method Detail

getWatchlistEntries

public ArrayList<Watchlist.WatchlistEntry> getWatchlistEntries(String type,
                                                               ArrayList<String> values)

Get all watchlist entries of the specific type that match a value in the provided value array.

Parameters:

type - Type of watchlist entry (email, ip, etc)

values - List of values to look up.

Returns:

ArrayList of matching entries

getWatchedEmails

public Watchlist.WatchlistEntry[] getWatchedEmails()

Returns watched email addresses

Returns:

Array of WatchlistEntry of type "email"

getWatchedIPs

public Watchlist.WatchlistEntry[] getWatchedIPs()

Returns watched ip addresses

Returns:

Array of WatchlistEntry of type "ip"

done

public void done()

Closes state interfaces to datastore. Must be called when finished using the instantiated Watchlist

main

public static void main(String[] args)
                 throws Exception

main routine used to create watchlist entries.

Parameters:

args - Command line arguments

Throws:

Exception - Exception