org.wattdepot.client.http.api.collector

Class MultiThreadedCollector

java.lang.Object

java.util.TimerTask

org.wattdepot.client.http.api.collector.MultiThreadedCollector

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

EGaugeCollector, NOAAWeatherCollector, SharkCollector, StressCollector

public abstract class MultiThreadedCollector
extends TimerTask

MultiThreadedCollector - Abstract base class for all Multi-Threaded Collectors.

Author:

Cam Moore

Field Summary

Fields

Modifier and Type	Field and Description
protected WattDepotClient	client The client used to communicate with the WattDepot server.
protected boolean	debug Flag for debugging messages.
protected CollectorProcessDefinition	definition The definition about the collector.
protected Depository	depository The Depository for storing measurements.

Constructor Summary

Constructors

Constructor and Description
MultiThreadedCollector(String serverUri, String username, String orgId, String password, String collectorId, boolean debug) Initializes the MultiThreadedCollector.
MultiThreadedCollector(String serverUri, String username, String orgId, String password, String sensorId, Long pollingInterval, Depository depository, boolean debug)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isValid()
static boolean	start(String serverUri, String username, String orgId, String password, String collectorId, boolean debug)

Methods inherited from class java.util.TimerTask

cancel, run, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected boolean debug

Flag for debugging messages.

definition

protected CollectorProcessDefinition definition

The definition about the collector.

client

protected WattDepotClient client

The client used to communicate with the WattDepot server.

depository

protected Depository depository

The Depository for storing measurements.

Constructor Detail

MultiThreadedCollector

public MultiThreadedCollector(String serverUri,
                      String username,
                      String orgId,
                      String password,
                      String collectorId,
                      boolean debug)
                       throws BadCredentialException,
                              IdNotFoundException,
                              BadSensorUriException

Initializes the MultiThreadedCollector.

Parameters:

serverUri - The URI for the WattDepot server.

username - The name of a user defined in the WattDepot server.

orgId - the id of the organization the user is in.

password - The password for the user.

collectorId - The CollectorProcessDefinitionId used to initialize this collector.

debug - flag for debugging messages.

Throws:

BadCredentialException - if the user or password don't match the credentials in WattDepot.

IdNotFoundException - if the processId is not defined.

BadSensorUriException - if the Sensor's URI isn't valid.

MultiThreadedCollector

public MultiThreadedCollector(String serverUri,
                      String username,
                      String orgId,
                      String password,
                      String sensorId,
                      Long pollingInterval,
                      Depository depository,
                      boolean debug)
                       throws BadCredentialException,
                              BadSensorUriException,
                              IdNotFoundException

Parameters:

serverUri - The URI for the WattDepot server.

username - The name of a user defined in the WattDepot server.

orgId - the id of the user's organization.

password - The password for the user.

sensorId - The id of the Sensor to poll.

pollingInterval - The polling interval in seconds.

depository - The Depository to store the measurements.

debug - flag for debugging messages.

Throws:

BadCredentialException - if the user or password don't match the credentials in WattDepot.

BadSensorUriException - if the Sensor's URI isn't valid.

IdNotFoundException - if there is a problem with the sensorId.

Method Detail

isValid

public boolean isValid()

Returns:

true if everything is good to go.

start

public static boolean start(String serverUri,
            String username,
            String orgId,
            String password,
            String collectorId,
            boolean debug)
                     throws InterruptedException,
                            BadCredentialException

Parameters:

serverUri - The URI for the WattDepot server.

username - The name of a user defined in the WattDepot server.

orgId - the user's organization id.

password - The password for the user.

collectorId - The CollectorProcessDefinitionId used to initialize this collector.

debug - flag for debugging messages.

Returns:

true if sensor starts successfully.

Throws:

InterruptedException - If sleep is interrupted for some reason.

BadCredentialException - if the username and password are invalid.