com.mozilla.secops

Class Minfraud

java.lang.Object

com.mozilla.secops.Minfraud

All Implemented Interfaces:

Serializable

public class Minfraud
extends Object
implements Serializable

Query Maxmind minFraud API

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Minfraud(String accountId, String licenseKey, String project) Create Minfraud client by passing in accountId and licenseKey.

Method Summary

Modifier and Type	Method and Description
static void	cacheClear() Clear insights cache
static void	cacheInsightsResource(String ipAddress, String resourcePath) Cache and force a particular response for an IP address
com.maxmind.minfraud.response.InsightsResponse	getInsights(String ipAddress, String email) Get Insights response from Minfraud using an IP address and an optional email address
static void	main(String[] args) main routine can be used to fetch minfraud insights for an ip or email (or both) from the command line
static void	setCacheOnly(Boolean value) Enable cache only

Methods inherited from class java.lang.Object

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

Constructor Detail

Minfraud

public Minfraud(String accountId,
                String licenseKey,
                String project)

Create Minfraud client by passing in accountId and licenseKey.

Supports RuntimeSecrets

Parameters:

accountId - Minfraud Account ID

licenseKey - Minfraud License Key

project - GCP project name, only required if decrypting accountId or licenseKey via RuntimeSecrets

Method Detail

setCacheOnly

public static void setCacheOnly(Boolean value)

Enable cache only

Parameters:

value - True to enable cache only

cacheClear

public static void cacheClear()

Clear insights cache

Intended for tests.

cacheInsightsResource

public static void cacheInsightsResource(String ipAddress,
                                         String resourcePath)
                                  throws IOException

Cache and force a particular response for an IP address

This method can be used to cache a response for an IP address, which will be returned for an insights query (instead of querying the actual API).

Intended for tests.

Parameters:

ipAddress - IP address

resourcePath - Path to resource JSON file to use as response

Throws:

IOException - IOException

getInsights

public com.maxmind.minfraud.response.InsightsResponse getInsights(String ipAddress,
                                                                  String email)

Get Insights response from Minfraud using an IP address and an optional email address

See Maxmind's minfraud documentation for more details.

Parameters:

ipAddress - IP address string (required)

email - email address string (optional)

Returns:

InsightsResponse from Minfraud or null if an error occurred.

main

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

main routine can be used to fetch minfraud insights for an ip or email (or both) from the command line

Parameters:

args - Command line arguments

Throws:

Exception - Exception