org.wattdepot.client.http.api.csv

Class OrganizationDomain

java.lang.Object

org.wattdepot.client.http.api.csv.OrganizationDomain

public class OrganizationDomain
extends Object

OrganizationDomain - Provides way of initializing an Organization's domain from a definition file and saving out an Organization's domain to a file.

Author:

Cam Moore

Constructor Summary

Constructors

Constructor and Description
OrganizationDomain(String serverUri, String username, String orgId, String password, String fileName) Initializes the OrganizationDomain.

Method Summary

Methods

Modifier and Type	Method and Description
void	initializeFromFile() Ensures that the WattDepot server has all the instances defined in the definition file.
void	initializeFromFile(String name) Ensures that the WattDepot server has all the instances defined in the definition file.
void	saveCurrentDomain() Saves out the Organization's Depositories, Sensors, SensorGroups, and CollectorProcessDefinitions.
void	saveCurrentDomain(String name) Saves out the Organization's Depositories, Sensors, SensorGroups, and CollectorProcessDefinitions.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationDomain

public OrganizationDomain(String serverUri,
                  String username,
                  String orgId,
                  String password,
                  String fileName)
                   throws BadCredentialException,
                          IdNotFoundException,
                          BadSensorUriException

Initializes the OrganizationDomain.

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.

fileName - The name of the definition file.

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.

Method Detail

initializeFromFile

public void initializeFromFile()
                        throws IOException

Ensures that the WattDepot server has all the instances defined in the definition file.

Throws:

IOException - if there is a problem reading the file.

initializeFromFile

public void initializeFromFile(String name)
                        throws IOException

Ensures that the WattDepot server has all the instances defined in the definition file.

Parameters:

name - the name of the definition file.

Throws:

IOException - if there is a problem reading the file.

saveCurrentDomain

public void saveCurrentDomain()
                       throws IOException

Saves out the Organization's Depositories, Sensors, SensorGroups, and CollectorProcessDefinitions.

Throws:

IOException - if there is a problem writing the file.

saveCurrentDomain

public void saveCurrentDomain(String name)
                       throws IOException

Saves out the Organization's Depositories, Sensors, SensorGroups, and CollectorProcessDefinitions.

Parameters:

name - the name of the file to save to.

Throws:

IOException - if there is a problem writing the file.