io.github.defiancecoding.proxycheck.api.proxycheck.dashboard

Class DashboardUtil

java.lang.Object

io.github.defiancecoding.proxycheck.api.proxycheck.dashboard.DashboardUtil

public class DashboardUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DashboardUtil()

Method Summary

Modifier and Type	Method and Description
java.lang.String	basicListAccess(ListSelection listSelection, ListAction listAction, java.lang.String apiKey) Basic list access that allows you to CLEAR or LIST a list stored on your dashboard
java.lang.String	exportDetections(boolean useJsonFormat, java.lang.String apiKey, int limit, int offset) Used to get output your previous detections.
java.lang.String	exportQueries(boolean useJsonFormat, java.lang.String apiKey)
java.lang.String	exportTags(java.lang.String apiKey, int limit, int offset, int addresses, int days) Used to grab the tags sent along with your proxycheck queries and their stats.
java.lang.String	exportTags(java.lang.String apiKey, int limit, int offset, long start, long end) Used to grab the tags sent along with your proxycheck queries and their stats.
java.lang.String	exportUsage(java.lang.String apiKey) Grabs your account usage
java.lang.String	modifyList(ListSelection listSelection, ListAction listAction, java.lang.String apiKey, java.util.ArrayList<java.lang.String> ipArray) Modify selected list with selected action and ipArray

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardUtil

public DashboardUtil()

Method Detail

exportDetections

public java.lang.String exportDetections(boolean useJsonFormat,
                                         java.lang.String apiKey,
                                         int limit,
                                         int offset)

Used to get output your previous detections.

Parameters:

useJsonFormat - exports detection as a JSON Type String

apiKey - APIKey from https://proxycheck.io/

limit - limit of detections to output

offset - how many detections to skip before reading

Returns:

jsonString response from HTTPQuery

exportTags

public java.lang.String exportTags(java.lang.String apiKey,
                                   int limit,
                                   int offset,
                                   int addresses,
                                   int days)

Used to grab the tags sent along with your proxycheck queries and their stats.

Parameters:

apiKey - APIKey from https://proxycheck.io/

limit - limit of detections to output

offset - how many detections to skip before reading

addresses - amount of addresses to query

days - amount of days to search back

Returns:

jsonString response from HTTPQuery

exportTags

public java.lang.String exportTags(java.lang.String apiKey,
                                   int limit,
                                   int offset,
                                   long start,
                                   long end)

Used to grab the tags sent along with your proxycheck queries and their stats.

Parameters:

apiKey - APIKey from https://proxycheck.io

limit - number of tags to list

offset - how many tags to skip

start - start date in long Milliseconds Time Units

end - start date in long Milliseconds Time Units

Returns:

jsonString response from HTTPQuery

exportUsage

public java.lang.String exportUsage(java.lang.String apiKey)

Grabs your account usage

Parameters:

apiKey - APIKey from https://proxycheck.io/

Returns:

jsonString response from HTTPQuery

exportQueries

public java.lang.String exportQueries(boolean useJsonFormat,
                                      java.lang.String apiKey)

Parameters:

useJsonFormat - Tells the API to print the result in Json Formatting or not

apiKey - APIKey from https://www.proxycheck.io

Returns:

response of all your queries

basicListAccess

public java.lang.String basicListAccess(ListSelection listSelection,
                                        ListAction listAction,
                                        java.lang.String apiKey)
                                 throws InvalidParameterException

Basic list access that allows you to CLEAR or LIST a list stored on your dashboard

Parameters:

listSelection - Which list to access

listAction - What to do with said list

apiKey - APIKey from https://proxycheck.io

Returns:

jsonString response from HTTPQuery

Throws:

InvalidParameterException - Throws when you input an invalid parameter

modifyList

public java.lang.String modifyList(ListSelection listSelection,
                                   ListAction listAction,
                                   java.lang.String apiKey,
                                   java.util.ArrayList<java.lang.String> ipArray)
                            throws InvalidParameterException

Modify selected list with selected action and ipArray

Parameters:

listSelection - Which list to access

listAction - What to do with said list

apiKey - APIKey from https://proxycheck.io

ipArray - List of ips you want to modify to the list

Returns:

jsonString response from HTTPQuery

Throws:

InvalidParameterException - Throws when you input an invalid parameter