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

Class DashboardAPI

java.lang.Object

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

public class DashboardAPI
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DashboardAPI()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addArrayToList(java.lang.String apiKey, ListSelection listSelection, java.util.ArrayList<java.lang.String> ipArray) Adds the ipArray to the selected list
java.lang.String	clearList(java.lang.String apiKey, ListSelection listSelection) Clears the selected list
java.lang.String	exportQueries(boolean useJsonFormatting, java.lang.String apiKey) Export your queries
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 startTime, long endTime) Used to grab the tags sent along with your proxycheck queries and their stats.
java.lang.String	exportUsage(java.lang.String apiKey) Export your API Usage
java.lang.String	getList(java.lang.String apiKey, ListSelection listSelection) Get a printout of the selected list from our API
java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode>	mapExportedQueriesToArray(java.lang.String apiKey) Maps all your queries to a JsonNode all mapped into a HashMap K: String V: JsonNode
UsageResults	mapUsage(java.lang.String apikey) Maps your usage to an instanced class
java.lang.String	removeArrayFromList(java.lang.String apiKey, ListSelection listSelection, java.util.ArrayList<java.lang.String> ipArray) Removes the ipArray from the selected list
java.lang.String	setList(java.lang.String apiKey, ListSelection listSelection, java.util.ArrayList<java.lang.String> ipArray) THIS METHOD WILL OVERWRITE YOUR CURRENT DATA IN THE LIST

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardAPI

public DashboardAPI()

Method Detail

getList

public java.lang.String getList(java.lang.String apiKey,
                                ListSelection listSelection)
                         throws InvalidParameterException

Get a printout of the selected list from our API

Parameters:

apiKey - APIKey from https://proxycheck.io

listSelection - Which list do you want to modify

Returns:

jsonString response from HTTPQuery;

Throws:

InvalidParameterException - Throws an exception when the params are invalid

See Also:

HTTPQuery

setList

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

THIS METHOD WILL OVERWRITE YOUR CURRENT DATA IN THE LIST

Parameters:

apiKey - APIKey from https://proxycheck.io

listSelection - Which list do you want to modify

ipArray - Array of ips that you want to set a list to

Returns:

jsonString response from HTTPQuery

Throws:

InvalidParameterException - Throws an exception when the params are invalid

clearList

public java.lang.String clearList(java.lang.String apiKey,
                                  ListSelection listSelection)
                           throws InvalidParameterException

Clears the selected list

Parameters:

apiKey - APIKey from https://proxycheck.io

listSelection - Which list do you want to modify

Returns:

jsonString response from HTTPQuery

Throws:

InvalidParameterException - Throws an exception when the params are invalid

addArrayToList

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

Adds the ipArray to the selected list

Parameters:

apiKey - APIKey from https://proxycheck.io

listSelection - Which list do you want to modify

ipArray - Array of ips to pass an ADD command with the HTTPQuery

Returns:

jsonString response from HTTPQuery

Throws:

InvalidParameterException - Throws an exception when the params are invalid

removeArrayFromList

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

Removes the ipArray from the selected list

Parameters:

apiKey - APIKey from https://proxycheck.io

listSelection - Which list do you want to modify

ipArray - Array of ips to pass a REMOVE command with the HTTPQuery

Returns:

jsonString response from HTTPQuery

Throws:

InvalidParameterException - Throws an exception when the params are invalid

exportQueries

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

Export your queries

Parameters:

useJsonFormatting - get response as JSON String

apiKey - APIKey from https://proxycheck.io

Returns:

jsonString response from HTTPQuery

exportUsage

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

Export your API Usage

Parameters:

apiKey - APIKey from https://proxycheck.io

Returns:

jsonString response from HTTPQuery

exportTags

public java.lang.String exportTags(java.lang.String apiKey,
                                   int limit,
                                   int offset,
                                   long startTime,
                                   long endTime)

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

startTime - start date in long Milliseconds Time Units

endTime - end date in long Milliseconds Time Units

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

mapExportedQueriesToArray

public java.util.HashMap<java.lang.String,com.fasterxml.jackson.databind.JsonNode> mapExportedQueriesToArray(java.lang.String apiKey)
                                                                                                      throws com.fasterxml.jackson.core.JsonProcessingException

Maps all your queries to a JsonNode all mapped into a HashMap K: String V: JsonNode

Parameters:

apiKey - APIKey from https://proxycheck.io

Returns:

HashMap of Queries stored as JsonNode

Throws:

com.fasterxml.jackson.core.JsonProcessingException - throws when json isnt detected

mapUsage

public UsageResults mapUsage(java.lang.String apikey)
                      throws com.fasterxml.jackson.core.JsonProcessingException

Maps your usage to an instanced class

Parameters:

apikey - String - APIKey from https://proxycheck.io

Returns:

returns an instanced class with getters and setters for ease of access

Throws:

com.fasterxml.jackson.core.JsonProcessingException - throws when json isnt detected

See Also:

UsageResults