com.screenscraper.util.internal.services.iterator

Class IteratorClient

java.lang.Object

com.screenscraper.util.internal.services.iterator.IteratorClient

All Implemented Interfaces:

LogMappable

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

Handles the interaction with the database, and converts the info to easier-to-handle info Author: Mike Date: 3/29/12 Time: 2:40 PM

Constructor Summary

Constructors

Constructor and Description
IteratorClient(ScrapingSession session, java.lang.String iteratorId, java.lang.String host, java.lang.String deploymentLocation, java.lang.String username, java.lang.String password) Create the facade that will interact with the web iterator at the specified URL
IteratorClient(ScrapingSession session, java.lang.String uniqueId, java.lang.String iteratorId, java.lang.String host, java.lang.String deploymentLocation, java.lang.String username, java.lang.String password) Create the facade that will interact with the web iterator at the specified URL

Method Summary

Modifier and Type	Method and Description
void	close()
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
static java.lang.String	generateUniqueId(java.lang.String name) Generates a unique ID based on the given name.
static java.lang.String	generateUniqueId(java.lang.String name, long seed) Generates a unique ID based on the given name.
java.lang.Object	getCurrentValue(java.lang.String field) Gets the current iteration value found for the given field name.
java.util.Map<java.lang.String,java.lang.Object>	getCurrentValues() Returns a copy of the current values in the iteration
IteratorInstance	getInstance() Returns the instance this client is connecting to
java.lang.Integer	getLastIterationPk() More for debugging than anything, this method returns the last pk (on the instance values) in the database that was returned by the iterator
java.util.Map<java.lang.String,java.lang.Object>	getNextValues() Returns a map of the next values from the iterator
java.util.Map<java.lang.String,java.lang.Object>	getNextValues(java.lang.Integer localPort) Returns a map of the next values from the iterator
java.util.Map<java.lang.String,java.lang.Object>	getNextValues(java.lang.Integer localPort, java.lang.String accessURL) Returns a map of the next values from the iterator
java.util.Map<java.lang.String,java.lang.Object>	getNextValues(java.lang.String accessURL) Returns a map of the next values from the iterator
java.lang.Integer	getOffset() More for debugging than anything, this method returns the last offset that was returned by the iterator
java.util.Map<java.lang.String,java.lang.Object>	getRandomValues() Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order
java.util.Map<java.lang.String,java.lang.Object>	getRandomValues(java.lang.Integer localPort) Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order
java.util.Map<java.lang.String,java.lang.Object>	getRandomValues(java.lang.Integer localPort, java.lang.String accessURL) Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order
java.util.Map<java.lang.String,java.lang.Object>	getRandomValues(java.lang.String accessURL) Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order
boolean	hasNext() Checks to see if there is another iteration that can occur
boolean	isClosed() Returns whether or not this client is closed.
void	reportErrorOnIteration() Reports successful iteration completion of the last grabbed iterator value, and causes the current iteration to be repeated later
void	reportErrorOnIteration(java.lang.Integer records) Reports successful iteration completion of the last grabbed iterator value
void	reportErrorOnIteration(java.lang.String message) Reports successful iteration completion of the last grabbed iterator value
void	reportErrorOnIteration(java.lang.String message, java.lang.Integer records) Reports successful iteration completion of the last grabbed iterator value
void	reportErrorOnIteration(java.lang.String message, java.lang.Integer records, boolean rerunImmediately) Reports successful iteration completion of the last grabbed iterator value
void	reportSuccessOnIteration() Reports successful iteration completion of the last grabbed iterator value
void	reportSuccessOnIteration(java.lang.Integer records) Reports successful iteration completion of the last grabbed iterator value
void	reportSuccessOnIteration(java.lang.String message) Reports successful iteration completion of the last grabbed iterator value
void	reportSuccessOnIteration(java.lang.String message, java.lang.Integer records) Reports successful iteration completion of the last grabbed iterator value
void	setCurrentValuesInSession() Sets the value of each field in the session, as SEARCH_[FIELD_NAME]
void	setPingOnSameRecordCount(boolean pingOnSameRecordCount) Sets the client to send pings to the server even if the session hasn't found any new records since the last ping.
boolean	shouldPing() Returns true if this client is in a state that it is allowed to ping, false otherwise
boolean	wasReportedComplete() Returns whether or not the last iteration has been reported yet, either as an error or success

Methods inherited from class java.lang.Object

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

Constructor Detail

IteratorClient

public IteratorClient(ScrapingSession session,
                      java.lang.String uniqueId,
                      java.lang.String iteratorId,
                      java.lang.String host,
                      java.lang.String deploymentLocation,
                      java.lang.String username,
                      java.lang.String password)

Create the facade that will interact with the web iterator at the specified URL

Parameters:

session - The scraping session

uniqueId - The unique id of the iterator instance

iteratorId - The name of the iterator

host - The host where the Iterator API is located, including the port if needed

deploymentLocation - The path on the host where the API is found, such as /IteratorAPI

username - The username for using the iterator

password - The password for the iterator

Throws:

AuthorizationException - If the connection failed to authenticate

java.lang.IllegalStateException - If the specified iterator instance could not be found or created

IteratorClient

public IteratorClient(ScrapingSession session,
                      @NotNull
                      java.lang.String iteratorId,
                      java.lang.String host,
                      java.lang.String deploymentLocation,
                      java.lang.String username,
                      java.lang.String password)

Create the facade that will interact with the web iterator at the specified URL

Parameters:

session - The scraping session

iteratorId - The name of the iterator

host - The host where the Iterator API is located, including the port if needed

deploymentLocation - The path on the host where the API is found, such as /IteratorAPI

username - The username for using the iterator

password - The password for the iterator

Throws:

AuthorizationException - If the connection failed to authenticate

java.lang.IllegalStateException - If the specified iterator instance could not be found or created

Method Detail

generateUniqueId

@Nullable
public static java.lang.String generateUniqueId(@NotNull
                                                           java.lang.String name)

Generates a unique ID based on the given name. This will not return the same id when called with an equal string

Parameters:

name - The name to use when generating the id

Returns:

A unique id

generateUniqueId

@Nullable
public static java.lang.String generateUniqueId(@NotNull
                                                           java.lang.String name,
                                                           long seed)

Generates a unique ID based on the given name. This will return the same id when called with an equal string and seed

Parameters:

name - The name to use when generating the id

seed - The random seed to use for generating the id

Returns:

A unique id

setPingOnSameRecordCount

public void setPingOnSameRecordCount(boolean pingOnSameRecordCount)

Sets the client to send pings to the server even if the session hasn't found any new records since the last ping. By default this is set to true. This is useful in determining which scrapes are still running, but aren't actually saving anything. Sometimes this is helpful to know, depending on the scrape.

Parameters:

pingOnSameRecordCount - True if the client should ping the server for this iteration even if record counts haven't changed.

getCurrentValues

public java.util.Map<java.lang.String,java.lang.Object> getCurrentValues()

Returns a copy of the current values in the iteration

Returns:

A copy of the last retrieved iteration values

getNextValues

public java.util.Map<java.lang.String,java.lang.Object> getNextValues()

Returns a map of the next values from the iterator

Returns:

A map of values for the next iteration

getNextValues

public java.util.Map<java.lang.String,java.lang.Object> getNextValues(java.lang.Integer localPort)

Returns a map of the next values from the iterator

Parameters:

localPort - The local port and URL to connect to the location this is running on

Returns:

A map of values for the next iteration

getNextValues

public java.util.Map<java.lang.String,java.lang.Object> getNextValues(java.lang.String accessURL)

Returns a map of the next values from the iterator

Parameters:

accessURL - The URL that can be used to access the interface for the location this is running

Returns:

A map of values for the next iteration

getNextValues

public java.util.Map<java.lang.String,java.lang.Object> getNextValues(@Nullable
                                                                      java.lang.Integer localPort,
                                                                      java.lang.String accessURL)

Returns a map of the next values from the iterator

Parameters:

localPort - The local port and URL to connect to the location this is running on

accessURL - The URL that can be used to access the interface for the location this is running

Returns:

A map of values for the next iteration

getRandomValues

public java.util.Map<java.lang.String,java.lang.Object> getRandomValues()

Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order

Returns:

A map of values for the next iteration, taken at random from the available iterations

getRandomValues

public java.util.Map<java.lang.String,java.lang.Object> getRandomValues(java.lang.Integer localPort)

Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order

Parameters:

localPort - The local port and URL to connect to the location this is running on

Returns:

A map of values for the next iteration, taken at random from the available iterations

getRandomValues

public java.util.Map<java.lang.String,java.lang.Object> getRandomValues(java.lang.String accessURL)

Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order

Parameters:

accessURL - The URL that can be used to access the interface for the location this is running

Returns:

A map of values for the next iteration, taken at random from the available iterations

getRandomValues

public java.util.Map<java.lang.String,java.lang.Object> getRandomValues(@Nullable
                                                                        java.lang.Integer localPort,
                                                                        java.lang.String accessURL)

Returns a map of the next values from the iterator, but they will be a random available iteration rather than a predictable order

Parameters:

localPort - The local port and URL to connect to the location this is running on

accessURL - The URL that can be used to access the interface for the location this is running

Returns:

A map of values for the next iteration, taken at random from the available iterations

setCurrentValuesInSession

public void setCurrentValuesInSession()

Sets the value of each field in the session, as SEARCH_[FIELD_NAME]

getOffset

public java.lang.Integer getOffset()

More for debugging than anything, this method returns the last offset that was returned by the iterator

Returns:

The last offset, or null if nothing has been returned yet.

getLastIterationPk

public java.lang.Integer getLastIterationPk()

More for debugging than anything, this method returns the last pk (on the instance values) in the database that was returned by the iterator

Returns:

The last pk, or null if nothing has been returned yet.

shouldPing

public boolean shouldPing()

Returns true if this client is in a state that it is allowed to ping, false otherwise

Returns:

True if this client considers itself in a ping-able state

wasReportedComplete

public boolean wasReportedComplete()

Returns whether or not the last iteration has been reported yet, either as an error or success

Returns:

True if either an error or success was reported back to the iterator for the last values obtained

getCurrentValue

public java.lang.Object getCurrentValue(@Nullable
                                        java.lang.String field)

Gets the current iteration value found for the given field name. If the field was not in the iteration, null will be returned

Parameters:

field - The field, not case-sensitive, for which to get the value

Returns:

The value of the field in the last retrieved iteration values

hasNext

public boolean hasNext()

Checks to see if there is another iteration that can occur

Returns:

True if there are more values to iterate over

reportErrorOnIteration

public void reportErrorOnIteration()

Reports successful iteration completion of the last grabbed iterator value, and causes the current iteration to be repeated later

reportErrorOnIteration

public void reportErrorOnIteration(java.lang.String message)

Reports successful iteration completion of the last grabbed iterator value

Parameters:

message - A message to include with the run data for this iteration

reportErrorOnIteration

public void reportErrorOnIteration(java.lang.Integer records)

Reports successful iteration completion of the last grabbed iterator value

Parameters:

records - The number of records to report for this iteration

reportErrorOnIteration

public void reportErrorOnIteration(java.lang.String message,
                                   java.lang.Integer records)

Reports successful iteration completion of the last grabbed iterator value

Parameters:

message - A message to include with the run data for this iteration

records - The number of records to report for this iteration

reportErrorOnIteration

public void reportErrorOnIteration(java.lang.String message,
                                   @Nullable
                                   java.lang.Integer records,
                                   boolean rerunImmediately)

Reports successful iteration completion of the last grabbed iterator value

Parameters:

message - A message to include with the run data for this iteration

records - The number of records to report for this iteration

rerunImmediately - True if the iteration should be rerun again as soon as a new iteration is requested, false to wait until other iterations have run

reportSuccessOnIteration

public void reportSuccessOnIteration()

Reports successful iteration completion of the last grabbed iterator value

reportSuccessOnIteration

public void reportSuccessOnIteration(java.lang.String message)

Reports successful iteration completion of the last grabbed iterator value

Parameters:

message - A message to include with the run data for this iteration

reportSuccessOnIteration

public void reportSuccessOnIteration(java.lang.Integer records)

Reports successful iteration completion of the last grabbed iterator value

Parameters:

records - The number of records to report for this iteration

reportSuccessOnIteration

public void reportSuccessOnIteration(java.lang.String message,
                                     @Nullable
                                     java.lang.Integer records)

Reports successful iteration completion of the last grabbed iterator value

Parameters:

message - A message to include with the run data for this iteration

records - The number of records to report for this iteration

getInstance

@Nullable
public IteratorInstance getInstance()

Returns the instance this client is connecting to

Returns:

The instance this client is connecting to

isClosed

public boolean isClosed()

Returns whether or not this client is closed. A closed client will no longer accept requests and queries

Returns:

True if the client has been closed

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

close

public void close()
           throws java.lang.Exception

Throws:

java.lang.Exception