com.github.defiancecoding.proxycheck.api.proxycheck.check

Class ProxyCheckSettings

java.lang.Object

com.github.defiancecoding.proxycheck.api.proxycheck.check.ProxyCheckSettings

public class ProxyCheckSettings
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ProxyCheckSettings()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApi_key() Sets the APIKey for use within queries with https://proxycheck.io
int	getMax_detection_days() When the days flag is supplied we will restrict our proxy results to between now and the amount of days you specify.
int	getRiskLevel() Get the risk/strictness level || ACCEPTABLE VALUES [0,1,2]
java.lang.String	getTag()
java.lang.String	getVer()
boolean	isCheck_asn()
boolean	isCheck_node()
boolean	isCheck_port() Get if the API should tell you the active port the proxy is using
boolean	isCheck_seen() Get if the API should return the last time there was activity on the address
boolean	isCheck_time() Get if the API should tell you the time it took to query the address
boolean	isCheck_vpn()
void	setApi_key(java.lang.String api_key)
void	setCheck_asn(boolean check_asn) When the asn flag is supplied we will perform an ASN check on the IP Address and present you with the provider name, ASN, Continent, Country, Country ISOCode, Region, Region ISOCode, City (if it's in a city) and Lat/Long for the IP Address.
void	setCheck_node(boolean check_node) When the node flag is supplied we will display which node within our cluster answered your API call.
void	setCheck_port(boolean check_port) When the port flag is supplied we will display to you the port number we saw this IP Address operating a proxy server on.
void	setCheck_seen(boolean check_seen) When the seen flag is supplied we will display to you the most recent time we saw this IP Address operating as a proxy server.
void	setCheck_time(boolean check_time) When the time flag is supplied we will display how long this query took to be answered by our API excluding network overhead.
void	setCheck_vpn(boolean check_vpn) When the vpn flag is supplied we will perform a VPN check on the IP Address and present the result to you.
void	setMax_detection_days(int max_detection_days)
void	setRiskLevel(int check_risk) When the risk flag is set to 1 we will provide you with a risk score for this IP Address ranging from 0 to 100.
void	setTag(java.lang.String set_tag) When the tag flag is supplied we will tag your query with the message you supply.
void	setVer(java.lang.String ver) Override the API version selection you have set in the customer dashboard with a different version.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyCheckSettings

public ProxyCheckSettings()

Method Detail

getApi_key

public java.lang.String getApi_key()

Sets the APIKey for use within queries with https://proxycheck.io

Returns:

api_key String - APIKey for https://proxycheck.io

setApi_key

public void setApi_key(java.lang.String api_key)

Parameters:

api_key - String - APIKey for https://proxycheck.io

isCheck_vpn

public boolean isCheck_vpn()

Returns:

boolean - should VPNChecks run?

setCheck_vpn

public void setCheck_vpn(boolean check_vpn)

When the vpn flag is supplied we will perform a VPN check on the IP Address and present the result to you.

Parameters:

check_vpn - boolean - Should VPNChecks run?

isCheck_asn

public boolean isCheck_asn()

Returns:

boolean - should ASN be queried?

setCheck_asn

public void setCheck_asn(boolean check_asn)

When the asn flag is supplied we will perform an ASN check on the IP Address and present you with the provider name, ASN, Continent, Country, Country ISOCode, Region, Region ISOCode, City (if it's in a city) and Lat/Long for the IP Address. Provider, Country, Region and City names will be encoded using utf8 for maximum compatibility.

Parameters:

check_asn - boolean - should ASN be queried?

isCheck_node

public boolean isCheck_node()

Returns:

boolean - should node be queried?

setCheck_node

public void setCheck_node(boolean check_node)

When the node flag is supplied we will display which node within our cluster answered your API call. This is only really needed for diagnosing problems with our support staff.

Parameters:

check_node - boolean - Should node be queried?

isCheck_time

public boolean isCheck_time()

Get if the API should tell you the time it took to query the address

Returns:

boolean should the time flag be enabled?

setCheck_time

public void setCheck_time(boolean check_time)

When the time flag is supplied we will display how long this query took to be answered by our API excluding network overhead.

Parameters:

check_time - boolean - should the time flag be enabled

getRiskLevel

public int getRiskLevel()

Get the risk/strictness level || ACCEPTABLE VALUES [0,1,2]

Returns:

the risk/strictness level

setRiskLevel

public void setRiskLevel(int check_risk)

When the risk flag is set to 1 we will provide you with a risk score for this IP Address ranging from 0 to 100. Scores below 33 can be considered low risk while scores between 34 and 66 can be considered high risk. Addresses with scores above 66 are considered very dangerous. When the risk flag is set to 2 we will still provide you with the above risk score, but you'll also receive individual counts for each type of attack we witnessed this IP performing across our customer network and our own honeypots within the days you specify by the &days= flag.

Parameters:

check_risk - the risk/strictness level

isCheck_port

public boolean isCheck_port()

Get if the API should tell you the active port the proxy is using

Returns:

boolean - should the port flag be enabled?

setCheck_port

public void setCheck_port(boolean check_port)

When the port flag is supplied we will display to you the port number we saw this IP Address operating a proxy server on.

Parameters:

check_port - boolean - should the port flag be enabled?

isCheck_seen

public boolean isCheck_seen()

Get if the API should return the last time there was activity on the address

Returns:

should the seen flag be enabled?

setCheck_seen

public void setCheck_seen(boolean check_seen)

When the seen flag is supplied we will display to you the most recent time we saw this IP Address operating as a proxy server.

Parameters:

check_seen - boolean - should the seen flag be enabled?

getMax_detection_days

public int getMax_detection_days()

When the days flag is supplied we will restrict our proxy results to between now and the amount of days you specify. For example if you supplied &days=2 we would only check our database for Proxies that we saw within the past 48 hours. By default, without this flag supplied we search within the past 7 days.

Returns:

int - days to restrict results to?

setMax_detection_days

public void setMax_detection_days(int max_detection_days)

Parameters:

max_detection_days - int - days to restrict results to?

getTag

public java.lang.String getTag()

Returns:

String - tag to add along queries for easier identification.

setTag

public void setTag(java.lang.String set_tag)

When the tag flag is supplied we will tag your query with the message you supply. You can supply your tag using the POST method, and we recommend you do so.

Parameters:

set_tag - String - tag to add along queries for easier identification.

setVer

public void setVer(java.lang.String ver)

Override the API version selection you have set in the customer dashboard with a different version. You can view the version dates supported by &ver from within the dashboard. Format examples: &ver=16-August-2020 or &ver=17-November-2020

Parameters:

ver - apiVersion to use?

getVer

public java.lang.String getVer()

Returns:

apiVersion to use?