org.wattdepot.client.http.api

Class WattDepotAdminClient

java.lang.Object

org.wattdepot.client.http.api.WattDepotClient

org.wattdepot.client.http.api.WattDepotAdminClient

All Implemented Interfaces:

WattDepotAdminInterface, WattDepotInterface

public class WattDepotAdminClient
extends WattDepotClient
implements WattDepotAdminInterface

WattDepotAdminClient - Admin level client.

Author:

Cam Moore

Constructor Summary

Constructors

Constructor and Description
WattDepotAdminClient(String serverUri, String username, String orgId, String password) Creates a new WattDepotAdminClient.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteOrganization(String id) Deletes the given Organization.
void	deleteUser(String id, String orgId) Deletes the given User.
Organization	getOrganization(String id)
OrganizationList	getOrganizations()
UserInfo	getUser(String id, String orgId)
UserPassword	getUserPassword(String id, String orgId)
UserInfoList	getUsers(String orgId)
boolean	isDefinedOrganization(String id) Checks to see if the given id is a defined Organization's id.
boolean	isDefinedUserInfo(String id, String orgId) Checks to see if the given id and orgId is a defined UserInfo id.
void	putOrganization(Organization org) Stores the given Organization in the WattDepot Server.
void	putUser(UserInfo user) Stores the given user in the WattDepot Server.
void	updateOrganization(Organization org) Updates the Organization in the WattDepot Server.
void	updateUser(UserInfo user) Updates the UserInfo in the WattDepot Server.
void	updateUserPassword(UserPassword password) Updates the Userpassword in the WattDepot Server.

Methods inherited from class org.wattdepot.client.http.api.WattDepotClient

deleteCollectorProcessDefinition, deleteDepository, deleteMeasurement, deleteMeasurementPruningDefinition, deleteMeasurementType, deleteSensor, deleteSensorGroup, deleteSensorModel, getAverageValues, getAverageValues, getCollectorProcessDefinition, getCollectorProcessDefinitions, getDailyValues, getDailyValues, getDepositories, getDepository, getDepositorySensors, getDescriptiveStats, getDescriptiveStats, getEarliestValue, getEarliestValue, getHistoricalValues, getHistoricalValues, getHourlyValues, getHourlyValues, getLatestValue, getLatestValue, getMaximumValues, getMaximumValues, getMeasurementPruningDefinition, getMeasurementPruningDefinitions, getMeasurements, getMeasurements, getMeasurementType, getMeasurementTypes, getMinimumValues, getMinimumValues, getOrganizationId, getSensor, getSensorGroup, getSensorGroups, getSensorModel, getSensorModels, getSensors, getSensorStatus, getSensorStatuses, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, getWattDepotUri, isDefinedCollectorProcessDefinition, isDefinedDepository, isDefinedMeasurementPruningDefinition, isDefinedMeasurementType, isDefinedSensor, isDefinedSensorGroup, isDefinedSensorModel, isHealthy, makeClient, putCollectorProcessDefinition, putDepository, putMeasurement, putMeasurementPruningDefinition, putMeasurements, putMeasurementType, putSensor, putSensorGroup, putSensorModel, updateCollectorProcessDefinition, updateDepository, updateMeasurementPruningDefinition, updateMeasurementType, updateSensor, updateSensorGroup, updateSensorModel

Methods inherited from class java.lang.Object

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

Constructor Detail

WattDepotAdminClient

public WattDepotAdminClient(String serverUri,
                    String username,
                    String orgId,
                    String password)
                     throws BadCredentialException

Creates a new WattDepotAdminClient.

Parameters:

serverUri - The URI of the WattDepot server (e.g. "http://server.wattdepot.org/")

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

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

password - The password for the user.

Throws:

BadCredentialException - If the user or password don't match the credentials on the WattDepot server.

Method Detail

deleteOrganization

public void deleteOrganization(String id)
                        throws IdNotFoundException

Description copied from interface: WattDepotAdminInterface

Deletes the given Organization.

Specified by:

deleteOrganization in interface WattDepotAdminInterface

Parameters:

id - the unique id of the Organization.

Throws:

IdNotFoundException - if the Organization's id is not found.

deleteUser

public void deleteUser(String id,
              String orgId)
                throws IdNotFoundException

Description copied from interface: WattDepotAdminInterface

Deletes the given User.

Specified by:

deleteUser in interface WattDepotAdminInterface

Parameters:

id - the unique id of the User.

orgId - the id of the user's organization.

Throws:

IdNotFoundException - if the User's id is not found.

putOrganization

public void putOrganization(Organization org)

Description copied from interface: WattDepotAdminInterface

Stores the given Organization in the WattDepot Server.

Specified by:

putOrganization in interface WattDepotAdminInterface

Parameters:

org - the Organization to store.

putUser

public void putUser(UserInfo user)

Description copied from interface: WattDepotAdminInterface

Stores the given user in the WattDepot Server.

Specified by:

putUser in interface WattDepotAdminInterface

Parameters:

user - The UserInfo to store.

updateOrganization

public void updateOrganization(Organization org)

Description copied from interface: WattDepotAdminInterface

Updates the Organization in the WattDepot Server.

Specified by:

updateOrganization in interface WattDepotAdminInterface

Parameters:

org - the Organization to update.

updateUser

public void updateUser(UserInfo user)

Description copied from interface: WattDepotAdminInterface

Updates the UserInfo in the WattDepot Server.

Specified by:

updateUser in interface WattDepotAdminInterface

Parameters:

user - the UserInfo to update.

getOrganization

public Organization getOrganization(String id)
                             throws IdNotFoundException

Specified by:

getOrganization in interface WattDepotAdminInterface

Parameters:

id - The unique id of the Organization.

Returns:

The Organization with the given id.

Throws:

IdNotFoundException - if the id does not exist.

getOrganizations

public OrganizationList getOrganizations()

Specified by:

getOrganizations in interface WattDepotAdminInterface

Returns:

All the defined Organizations in an OrganizationList.

getUser

public UserInfo getUser(String id,
               String orgId)
                 throws IdNotFoundException

Specified by:

getUser in interface WattDepotAdminInterface

Parameters:

id - The unique id of the UserInfo.

orgId - the id of the user's organization.

Returns:

The UserInfo with the given id.

Throws:

IdNotFoundException - if the id does not exist.

getUsers

public UserInfoList getUsers(String orgId)

Specified by:

getUsers in interface WattDepotAdminInterface

Parameters:

orgId - the id of the users' organization.

Returns:

All the defined Users in a UserInfoList.

getUserPassword

public UserPassword getUserPassword(String id,
                           String orgId)
                             throws IdNotFoundException

Specified by:

getUserPassword in interface WattDepotAdminInterface

Parameters:

id - The unique id of the UserPassword.

orgId - the organization id.

Returns:

The UserPassword with the given id.

Throws:

IdNotFoundException - if the id does not exist.

updateUserPassword

public void updateUserPassword(UserPassword password)
                        throws IdNotFoundException

Description copied from interface: WattDepotAdminInterface

Updates the Userpassword in the WattDepot Server.

Specified by:

updateUserPassword in interface WattDepotAdminInterface

Parameters:

password - the UserPassword to update.

Throws:

IdNotFoundException - if the user id or organization ids are not defined.

isDefinedOrganization

public boolean isDefinedOrganization(String id)

Description copied from interface: WattDepotAdminInterface

Checks to see if the given id is a defined Organization's id.

Specified by:

isDefinedOrganization in interface WattDepotAdminInterface

Parameters:

id - the id to check.

Returns:

true if there is a defined Organization with the given id, false otherwise.

isDefinedUserInfo

public boolean isDefinedUserInfo(String id,
                        String orgId)

Description copied from interface: WattDepotAdminInterface

Checks to see if the given id and orgId is a defined UserInfo id.

Specified by:

isDefinedUserInfo in interface WattDepotAdminInterface

Parameters:

id - the id to check.

orgId - the organization id.

Returns:

true if there is a defined UserInfo with the given id and orgId, false otherwise.