com.screenscraper.util.internal.services.depthtracker

Class APIConnection

java.lang.Object

com.screenscraper.util.internal.services.depthtracker.APIConnection

public final class APIConnection
extends java.lang.Object

API connection class used to communicate with the depth api

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
APIConnection(java.lang.String host, java.lang.String deploymentPath, java.lang.String username, java.lang.String password) Creates a new connection to the given host

Method Summary

Modifier and Type	Method and Description
Category	addCategory(long siteId, java.lang.Long parentId, java.lang.String name) Enters a given category if possible
Site	createSite(java.lang.String name, int maxThreadsPerCategory, int reduceMaxThreadsPerLevel) Creates a new site with the specified number of threads per category
boolean	deleteCategory(long siteId, long categoryId, boolean forceDeletion) Deletes a category
boolean	deleteSite(long siteId, boolean forceDeletion) Deletes a site
boolean	deleteSite(java.lang.String name, boolean forceDeletion) Deletes a site
boolean	deleteThread(long threadId) Deletes a thread
Category	enterCategory(long siteId, java.lang.Long parentId, java.lang.String name, long threadId) Enters a given category if possible
Category	enterCategory(long siteId, java.lang.Long parentId, java.lang.String name, long threadId, boolean isBaseCategory) Enters a given category if possible
Tuple	enterSite(long siteId, java.lang.String name, java.lang.String location) Enters a given site if possible.
void	exitCategory(long siteId, long threadId, long categoryId, int records, RunState completionState, java.lang.Long entryTime) Exits a given category
void	exitSite(long siteId, long threadId) Exits a given site
void	exitSite(long siteId, long threadId, boolean wasError) Exits a given site
void	exitSite(long siteId, long threadId, boolean wasError, java.lang.Long entryTime) Exits a given site
Category	getCategory(long id) Returns the category with the specified id, or null if there is no such category
Category	getCategory(long sitePk, java.lang.Long parentId, java.lang.String name) Returns the category with the specified id, or null if there is no such category
Site	getSite(long id) Returns the site with the given id, or null if there is no site with the specified id
Site	getSite(java.lang.String name) Returns the site with the given name, or null if there is no site with the specified name
ExecutionThread	getThread(long id) Returns the thread with the given id, or null if there is no thread with the specified id
java.lang.Object	issueRequest(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> parameters) Issues a request to the api server
java.util.List<Category>	listChildCategories(long categoryId) Returns a list of all categories that are direct children (one level down) of the given category
java.util.List<Category>	listRootCategories(long siteId) Returns a list of all categories that are roots of the given site
java.util.List<Site>	listSites() Returns a list of all sites known
java.util.List<Category>	listThreadCategories(long siteId, long threadId) Gets a list of categories the specified thread is currently in
java.util.List<ExecutionThread>	listThreadsInCategory(long siteId, long categoryId) Gets a list of threads the specified category has running in it
java.util.List<ExecutionThread>	listThreadsInSite(long siteId) Gets a list of threads in the specified site
void	resetCategory(long siteId, long categoryId) Resets a given category.
void	resetCategory(long siteId, long categoryId, boolean fullReset) Resets a given site.
void	resetSite(long siteId) Resets a given site.
void	resetSite(long siteId, boolean fullReset) Resets a given site.
boolean	setCategoryStatus(long siteId, long categoryId, RunState status) Sets the status of the category without modifying the status of any parent of child

Methods inherited from class java.lang.Object

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

Constructor Detail

APIConnection

public APIConnection(java.lang.String host,
                     java.lang.String deploymentPath,
                     java.lang.String username,
                     java.lang.String password)

Creates a new connection to the given host

Parameters:

host - The host to connect to (including port if required)

username - The username used to authenticate to the server

password - The password for authenticating to the server

Throws:

java.io.IOException - If there was an error establishing the connection

AuthorizationException - If the connection failed to authenticate

Method Detail

issueRequest

@Nullable
public java.lang.Object issueRequest(java.lang.String type,
                                                java.util.Map<java.lang.String,java.lang.Object> parameters)

Issues a request to the api server

Parameters:

type - The type to issue (enterCategory, etc...)

parameters - The additional parameters to send

Returns:

The json object response, or null if there was no associated data

getSite

public Site getSite(long id)

Returns the site with the given id, or null if there is no site with the specified id

Parameters:

id - The id of the site to get

Returns:

The site, or null if there is no such site

getSite

public Site getSite(java.lang.String name)

Returns the site with the given name, or null if there is no site with the specified name

Parameters:

name - The name of the site to get

Returns:

The site, or null if there is no such site

getThread

public ExecutionThread getThread(long id)

Returns the thread with the given id, or null if there is no thread with the specified id

Parameters:

id - The id of the thread to get

Returns:

The thread, or null if there is no such thread

getCategory

public Category getCategory(long id)

Returns the category with the specified id, or null if there is no such category

Parameters:

id - The id of the category

Returns:

The category, or null if there is no such category

getCategory

public Category getCategory(long sitePk,
                            java.lang.Long parentId,
                            java.lang.String name)

Returns the category with the specified id, or null if there is no such category

Parameters:

sitePk - The id of the site the category is part of

parentId - The id of the parent category, or null if this is a top-level category

name - The name of the category

Returns:

The category, or null if there is no such category

listSites

@NotNull
public java.util.List<Site> listSites()

Returns a list of all sites known

Returns:

A list of all known sites

listRootCategories

@NotNull
public java.util.List<Category> listRootCategories(long siteId)

Returns a list of all categories that are roots of the given site

Parameters:

siteId - The id of the site to list roots for

Returns:

A list of categories that are roots of the given site

listChildCategories

@NotNull
public java.util.List<Category> listChildCategories(long categoryId)

Returns a list of all categories that are direct children (one level down) of the given category

Parameters:

categoryId - The id of the category to list children for

Returns:

A list of child categories to the given category

createSite

public Site createSite(java.lang.String name,
                       int maxThreadsPerCategory,
                       int reduceMaxThreadsPerLevel)

Creates a new site with the specified number of threads per category

Parameters:

name - The name of the site

maxThreadsPerCategory - The number of threads allowed in any given category (must be > 0)

reduceMaxThreadsPerLevel - The amount to reduce the maximum number of threads for each level down the tree we go (must be ≥ 0)

Returns:

The newly created site or null if the site could not be created

enterSite

public Tuple enterSite(long siteId,
                       java.lang.String name,
                       java.lang.String location)

Enters a given site if possible. The site must already exist

Parameters:

siteId - The id of the site to enter

name - The name for the entering thread, or null for no name

location - The location of the thread, or null to let the server determine it

Returns:

The tuple representing the entered site and thread [site, thread], or null if it could not be entered

exitSite

public void exitSite(long siteId,
                     long threadId)

Exits a given site

Parameters:

siteId - The id of the site

threadId - id of the thread exiting the site

exitSite

public void exitSite(long siteId,
                     long threadId,
                     boolean wasError)

Exits a given site

Parameters:

siteId - The id of the site

threadId - id of the thread exiting the site

wasError - True to indicate an error occurred, false if no errors occurred

exitSite

public void exitSite(long siteId,
                     long threadId,
                     boolean wasError,
                     java.lang.Long entryTime)

Exits a given site

Parameters:

siteId - The id of the site

threadId - id of the thread exiting the site

wasError - True to indicate an error occurred, false if no errors occurred

entryTime - The time the site was entered by the client

deleteSite

public boolean deleteSite(java.lang.String name,
                          boolean forceDeletion)

Deletes a site

Parameters:

name - The name of the site to delete

forceDeletion - True if deletion should be forced. Forced deletion means that the site will be deleted even if there are still active threads running in the site

Returns:

True iff the site was deleted

setCategoryStatus

public boolean setCategoryStatus(long siteId,
                                 long categoryId,
                                 @NotNull
                                 RunState status)

Sets the status of the category without modifying the status of any parent of child

Parameters:

siteId - The id of the site the category is part of

categoryId - The id of the category

status - The status to set the category to

Returns:

True if the operation was successful, false otherwise

deleteSite

public boolean deleteSite(long siteId,
                          boolean forceDeletion)

Deletes a site

Parameters:

siteId - The id of the site to delete

forceDeletion - True if deletion should be forced. Forced deletion means that the site will be deleted even if there are still active threads running in the site

Returns:

True iff the site was deleted

deleteThread

public boolean deleteThread(long threadId)

Deletes a thread

Parameters:

threadId - The id of the thread to delete

Returns:

True iff the thread was deleted

deleteCategory

public boolean deleteCategory(long siteId,
                              long categoryId,
                              boolean forceDeletion)

Deletes a category

Parameters:

siteId - The id of the site the category is part of

categoryId - The id of the category to delete

forceDeletion - True if deletion should be forced. Forced deletion means that the category will be deleted even if there are still active threads running in the category

Returns:

True iff the category was deleted

enterCategory

@Nullable
public Category enterCategory(long siteId,
                                         java.lang.Long parentId,
                                         java.lang.String name,
                                         long threadId)

Enters a given category if possible

Parameters:

siteId - The id of the site the category is part of

parentId - The id of the parent category, or null if this is a top level category

name - The name of the category

threadId - The id of the entering thread

Returns:

The category that was entered, or null if it could not be entered

enterCategory

public Category enterCategory(long siteId,
                              java.lang.Long parentId,
                              java.lang.String name,
                              long threadId,
                              boolean isBaseCategory)

Enters a given category if possible

Parameters:

siteId - The id of the site the category is part of

parentId - The id of the parent category, or null if this is a top level category

name - The name of the category

threadId - The id of the entering thread

isBaseCategory - True if this category is known to be the lowest category in the tree, or rather that only a single thread should be allowed in this category, regardless of other settings. This only affects the current thread. In other words, if one thread enters a category with this set, but another attempts to enter without this set, the second thread can still be given access.

Returns:

The category that was entered, or null if it could not be entered

addCategory

public Category addCategory(long siteId,
                            java.lang.Long parentId,
                            java.lang.String name)

Enters a given category if possible

Parameters:

siteId - The id of the site the category is part of

parentId - The id of the parent category, or null if this is a top level category

name - The name of the category

Returns:

The category that was added, or null if it could not be added (which could simply mean it was already in the database)

exitCategory

public void exitCategory(long siteId,
                         long threadId,
                         long categoryId,
                         int records,
                         @NotNull
                         RunState completionState,
                         java.lang.Long entryTime)

Exits a given category

Parameters:

siteId - The id of the site the category is part of

threadId - The id of the exiting thread

categoryId - The id of the category to exit

records - The number of records for this category. This only matters for leaf categories, as parents are computed from their children

completionState - The state to return for completion

entryTime - The time the site was entered by the client

resetSite

public void resetSite(long siteId)

Resets a given site. This will reset the number of threads in all categories to 0, and set all categories to IN_QUEUE. It can accomplish this by either deleting all categories for the site or actually resetting the values to their base states

Parameters:

siteId - The id of the site to reset

resetSite

public void resetSite(long siteId,
                      boolean fullReset)

Resets a given site. This will reset the number of threads in all categories to 0, and set all categories to IN_QUEUE. It can accomplish this by either deleting all categories for the site or actually resetting the values to their base states

Parameters:

siteId - The id of the site to reset

fullReset - True if all values should be reset (including entry dates), false to only reset the main values

resetCategory

public void resetCategory(long siteId,
                          long categoryId)

Resets a given category. This will reset the number of threads in this and all subcategories to 0, and set the same categories to IN_QUEUE. It can accomplish this by either deleting the categories or resetting their values

Parameters:

siteId - The id of the site to reset

categoryId - The id of the category to reset

resetCategory

public void resetCategory(long siteId,
                          long categoryId,
                          boolean fullReset)

Resets a given site. This will reset the number of threads in all categories to 0, and set all categories to IN_QUEUE. It can accomplish this by either deleting all categories for the site or actually resetting the values to their base states

Parameters:

siteId - The id of the site to reset

categoryId - The id of the category to reset

fullReset - True if all values should be reset (including entry dates), false to only reset the main values

listThreadCategories

@NotNull
public java.util.List<Category> listThreadCategories(long siteId,
                                                               long threadId)

Gets a list of categories the specified thread is currently in

Parameters:

siteId - The id of the site the thread is running in

threadId - The id of the thread

Returns:

A view listing each category

listThreadsInCategory

@NotNull
public java.util.List<ExecutionThread> listThreadsInCategory(long siteId,
                                                                       long categoryId)

Gets a list of threads the specified category has running in it

Parameters:

siteId - The id of the site the category is in

categoryId - The id of the category

Returns:

A view listing each thread

listThreadsInSite

@NotNull
public java.util.List<ExecutionThread> listThreadsInSite(long siteId)

Gets a list of threads in the specified site

Parameters:

siteId - The id of the site the threads are running in

Returns:

A view listing each thread