com.screenscraper.util.internal.services.iterator.model

Class APIConnection

java.lang.Object

com.screenscraper.util.internal.services.iterator.model.APIConnection

All Implemented Interfaces:

LogMappable

public final class APIConnection
extends java.lang.Object
implements LogMappable

API connection class used to communicate with the iterator web 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
APIConnection(java.lang.String host, java.lang.String deploymentPath, java.lang.String username, java.lang.String password, int connectionTimeout) Creates a new connection to the given host

Method Summary

Modifier and Type	Method and Description
Developer	addDeveloper(java.lang.String iteratorName, java.lang.String name, java.lang.String email)
boolean	changeIteratorQuery(java.lang.String iteratorId, java.lang.String query, java.lang.Boolean allowFieldReduction, java.util.Collection<java.lang.String> ignoreFields)
boolean	changeIteratorQuery(java.lang.String iteratorId, java.lang.String query, java.util.Collection<java.lang.String> ignoreFields)
java.util.Map<java.lang.String,java.lang.Object>	convertMap() Converts the current object into a mapping of key-value pairs that can be logged
Iterator	createIterator(java.lang.String iteratorName, java.lang.String query)
Iterator	createIterator(java.lang.String iteratorName, java.lang.String query, java.lang.Integer projectId)
IteratorInstance	createIteratorInstance(java.lang.String iteratorName, java.lang.String instanceUID)
Project	createProject(java.lang.String name)
boolean	deleteDeveloper(int developerPk)
boolean	deleteErrorIteration(int iterationPk)
boolean	deleteErrorIterations(java.lang.String instanceId)
boolean	deleteInstance(java.lang.String instanceUID)
boolean	deleteIterator(java.lang.String iteratorName)
boolean	deleteProject(int projectId)
java.util.Collection<java.lang.String>	getAllAvailableIteratorFields(java.lang.String iteratorName)
java.util.Collection<Iteration>	getAllIterations(java.lang.String instanceUID)
java.util.Collection<Iterator>	getAllIterators()
java.util.Collection<Iterator>	getAllIterators(java.lang.Integer projectId)
java.util.Collection<Project>	getAllProjects()
java.util.Collection<Iteration>	getCompletedIterations(java.lang.String instanceUID)
java.util.Collection<Developer>	getDevelopersForIterator(int iteratorPk)
java.util.Collection<Iteration>	getErrorIterations(java.lang.String instanceUID)
Iteration	getIteration(long iterationPk)
Iteration	getIterationForOffset(java.lang.String instanceUID, int offset)
java.util.Map<java.lang.String,java.lang.Object>	getIterationValues(long iterationPk)
java.util.Map<java.lang.String,java.lang.Object>	getIterationValues(java.lang.String instanceUID, int offset)
Iterator	getIterator(int iteratorPk)
Iterator	getIterator(java.lang.String iteratorName)
java.util.Collection<java.lang.String>	getIteratorFields(java.lang.String iteratorName)
IteratorInstance	getIteratorInstance(java.lang.String instanceUID)
java.util.Collection<IteratorInstance>	getIteratorInstances(java.lang.String iteratorName)
Iteration	getNextIteration(java.lang.String instanceUID)
Iteration	getNextIteration(java.lang.String instanceUID, java.lang.Integer port, java.lang.String localUrl)
Iteration	getNextIteration(java.lang.String instanceUID, java.lang.String iteratorName)
Iteration	getNextIteration(java.lang.String instanceUID, java.lang.String iteratorName, java.lang.Integer port, java.lang.String localUrl)
Project	getProject(int projectId)
Project	getProject(java.lang.String name)
Iteration	getRandomIteration(java.lang.String instanceUID)
Iteration	getRandomIteration(java.lang.String instanceUID, java.lang.Integer port, java.lang.String localUrl)
Iteration	getRandomIteration(java.lang.String instanceUID, java.lang.String iteratorName)
Iteration	getRandomIteration(java.lang.String instanceUID, java.lang.String iteratorName, java.lang.Integer port, java.lang.String localUrl)
java.util.Collection<Iteration>	getRemainingIterations(java.lang.String instanceUID)
java.util.Collection<Iteration>	getRunningIterations(java.lang.String instanceUID)
java.util.Collection<IteratorTable>	getTables()
boolean	hasNext(java.lang.String instanceUID)
boolean	hasNext(java.lang.String instanceUID, java.lang.String iteratorId)
org.jdom.Element	issueRequest(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> parameters) Issues a request to the api server
boolean	moveIteratorToProject(java.lang.String iteratorName, int projectId)
boolean	pauseInstance(java.lang.String instanceUID)
Iteration	peekNextIteration(java.lang.String instanceUID)
Iteration	peekNextIteration(java.lang.String instanceUID, java.lang.String iteratorName)
boolean	pingIteration(int iterationPk, java.lang.Long timeSinceLastActivity)
boolean	reportCompletion(long iterationPk, java.lang.String message, int recordCount)
boolean	reportCompletion(long iterationPk, java.lang.String message, int recordCount, boolean forceChange)
boolean	reportError(long iterationPk, java.lang.String message, int recordCount)
boolean	reportError(long iterationPk, java.lang.String message, int recordCount, boolean forceChange)
boolean	reportError(long iterationPk, java.lang.String message, int recordCount, boolean forceChange, boolean rerunImmediately)
boolean	reset(long iterationPk)
boolean	reset(long iterationPk, boolean forceChange)
boolean	resumeInstance(java.lang.String instanceUID)
boolean	rollbackInstance(java.lang.String instanceUID, java.lang.String amount)
boolean	setNote(java.lang.String instanceUID, java.lang.String note)
boolean	updateIteratorFields(java.lang.String iteratorName, java.util.Collection<java.lang.String> usedFields)

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)

deploymentPath - The path the API is located at, such as /IteratorAPI

username - The username used to authenticate to the server

password - The password for authenticating to the server

Throws:

AuthorizationException - If the connection failed to authenticate

APIConnection

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

Creates a new connection to the given host

Parameters:

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

deploymentPath - The path the API is located at, such as /IteratorAPI

username - The username used to authenticate to the server

password - The password for authenticating to the server

connectionTimeout - The timeout for connections to the server

Throws:

AuthorizationException - If the connection failed to authenticate

Method Detail

convertMap

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> convertMap()

Description copied from interface: LogMappable

Converts the current object into a mapping of key-value pairs that can be logged

Specified by:

convertMap in interface LogMappable

Returns:

The mapping of key-value pairs to then log

issueRequest

@Nullable
public org.jdom.Element 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

getAllIterators

@NotNull
public java.util.Collection<Iterator> getAllIterators()

getAllIterators

@NotNull
public java.util.Collection<Iterator> getAllIterators(java.lang.Integer projectId)

getAllProjects

@NotNull
public java.util.Collection<Project> getAllProjects()

getTables

@NotNull
public java.util.Collection<IteratorTable> getTables()

getDevelopersForIterator

@NotNull
public java.util.Collection<Developer> getDevelopersForIterator(int iteratorPk)

deleteDeveloper

public boolean deleteDeveloper(int developerPk)

addDeveloper

public Developer addDeveloper(java.lang.String iteratorName,
                              java.lang.String name,
                              java.lang.String email)

getProject

public Project getProject(int projectId)

deleteProject

public boolean deleteProject(int projectId)

getProject

public Project getProject(java.lang.String name)

createProject

public Project createProject(java.lang.String name)

moveIteratorToProject

public boolean moveIteratorToProject(java.lang.String iteratorName,
                                     int projectId)

changeIteratorQuery

public boolean changeIteratorQuery(java.lang.String iteratorId,
                                   java.lang.String query,
                                   java.util.Collection<java.lang.String> ignoreFields)

changeIteratorQuery

public boolean changeIteratorQuery(java.lang.String iteratorId,
                                   java.lang.String query,
                                   java.lang.Boolean allowFieldReduction,
                                   java.util.Collection<java.lang.String> ignoreFields)

getIterator

public Iterator getIterator(java.lang.String iteratorName)

getIterator

public Iterator getIterator(int iteratorPk)

createIterator

@Nullable
public Iterator createIterator(java.lang.String iteratorName,
                                          java.lang.String query)

createIterator

public Iterator createIterator(java.lang.String iteratorName,
                               java.lang.String query,
                               java.lang.Integer projectId)

deleteIterator

public boolean deleteIterator(java.lang.String iteratorName)

getIteratorInstances

@NotNull
public java.util.Collection<IteratorInstance> getIteratorInstances(java.lang.String iteratorName)

getAllAvailableIteratorFields

@NotNull
public java.util.Collection<java.lang.String> getAllAvailableIteratorFields(java.lang.String iteratorName)

getIteratorFields

@NotNull
public java.util.Collection<java.lang.String> getIteratorFields(java.lang.String iteratorName)

updateIteratorFields

public boolean updateIteratorFields(java.lang.String iteratorName,
                                    java.util.Collection<java.lang.String> usedFields)

getIteratorInstance

public IteratorInstance getIteratorInstance(java.lang.String instanceUID)

createIteratorInstance

public IteratorInstance createIteratorInstance(java.lang.String iteratorName,
                                               java.lang.String instanceUID)

deleteInstance

public boolean deleteInstance(java.lang.String instanceUID)

hasNext

public boolean hasNext(java.lang.String instanceUID)

hasNext

public boolean hasNext(java.lang.String instanceUID,
                       java.lang.String iteratorId)

rollbackInstance

public boolean rollbackInstance(java.lang.String instanceUID,
                                java.lang.String amount)

pauseInstance

public boolean pauseInstance(java.lang.String instanceUID)

resumeInstance

public boolean resumeInstance(java.lang.String instanceUID)

setNote

public boolean setNote(java.lang.String instanceUID,
                       java.lang.String note)

getNextIteration

@Nullable
public Iteration getNextIteration(java.lang.String instanceUID)

getNextIteration

@Nullable
public Iteration getNextIteration(java.lang.String instanceUID,
                                             java.lang.String iteratorName)

getNextIteration

@Nullable
public Iteration getNextIteration(java.lang.String instanceUID,
                                             java.lang.Integer port,
                                             java.lang.String localUrl)

getNextIteration

public Iteration getNextIteration(java.lang.String instanceUID,
                                  java.lang.String iteratorName,
                                  java.lang.Integer port,
                                  java.lang.String localUrl)

getRandomIteration

@Nullable
public Iteration getRandomIteration(java.lang.String instanceUID)

getRandomIteration

@Nullable
public Iteration getRandomIteration(java.lang.String instanceUID,
                                               java.lang.String iteratorName)

getRandomIteration

@Nullable
public Iteration getRandomIteration(java.lang.String instanceUID,
                                               java.lang.Integer port,
                                               java.lang.String localUrl)

getRandomIteration

public Iteration getRandomIteration(java.lang.String instanceUID,
                                    java.lang.String iteratorName,
                                    java.lang.Integer port,
                                    java.lang.String localUrl)

peekNextIteration

@Nullable
public Iteration peekNextIteration(java.lang.String instanceUID)

peekNextIteration

public Iteration peekNextIteration(java.lang.String instanceUID,
                                   java.lang.String iteratorName)

getIterationForOffset

public Iteration getIterationForOffset(java.lang.String instanceUID,
                                       int offset)

deleteErrorIterations

public boolean deleteErrorIterations(java.lang.String instanceId)

getAllIterations

@NotNull
public java.util.Collection<Iteration> getAllIterations(java.lang.String instanceUID)

getErrorIterations

@NotNull
public java.util.Collection<Iteration> getErrorIterations(java.lang.String instanceUID)

getCompletedIterations

@NotNull
public java.util.Collection<Iteration> getCompletedIterations(java.lang.String instanceUID)

getRemainingIterations

@NotNull
public java.util.Collection<Iteration> getRemainingIterations(java.lang.String instanceUID)

getRunningIterations

@NotNull
public java.util.Collection<Iteration> getRunningIterations(java.lang.String instanceUID)

getIteration

public Iteration getIteration(long iterationPk)

getIterationValues

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getIterationValues(java.lang.String instanceUID,
                                                                                     int offset)

getIterationValues

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getIterationValues(long iterationPk)

reportCompletion

public boolean reportCompletion(long iterationPk,
                                java.lang.String message,
                                int recordCount)

reportCompletion

public boolean reportCompletion(long iterationPk,
                                java.lang.String message,
                                int recordCount,
                                boolean forceChange)

reportError

public boolean reportError(long iterationPk,
                           java.lang.String message,
                           int recordCount)

reportError

public boolean reportError(long iterationPk,
                           java.lang.String message,
                           int recordCount,
                           boolean forceChange)

reportError

public boolean reportError(long iterationPk,
                           java.lang.String message,
                           int recordCount,
                           boolean forceChange,
                           boolean rerunImmediately)

reset

public boolean reset(long iterationPk)

reset

public boolean reset(long iterationPk,
                     boolean forceChange)

pingIteration

public boolean pingIteration(int iterationPk,
                             java.lang.Long timeSinceLastActivity)

deleteErrorIteration

public boolean deleteErrorIteration(int iterationPk)