org.wattdepot.common.http.api

Class API

java.lang.Object

org.wattdepot.common.http.api.API

public class API
extends Object

API - Defines the Strings that make up the HTTP API.

Author:

Cam Moore

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_URI /wattdepot/{org-id}/ URI for the group administration User Interface.
static String	BASE_URI /wattdepot/ URI for seeing if the server is alive.
static String	COLLECTOR_PROCESS_DEFINITION_PUT_URI /wattdepot/{org-id}/collector-process-definition/ URI for storing CollectorProcessDefinition.
static String	COLLECTOR_PROCESS_DEFINITION_URI /wattdepot/{org-id}/collector-process-definition/{collector-process- definition-id} URI for manipulating CollectorProcessDefinition.
static String	COLLECTOR_PROCESS_DEFINITIONS_URI /wattdepot/{org-id}/collector-process-definitions/ URI for getting all the defined CollectorProcessDefinition.
static String	DAILY_VALUES_URI /wattdepot/{org-id}/depository/{depository-id}/daily/values/ URI for getting daily samples.
static String	DAY_HOURLY_VALUES_URI /wattdepot/{org-id}/depository/{depository-id}/day-hourly/values/ URI for getting a day's hourly samples.
static String	DEPOSITORIES_URI /wattdepot/{org-id}/depositories/ URI for getting all Depositories.
static String	DEPOSITORY_PUT_URI /wattdepot/{org-id}/depository/ URI for storing new Depositories.
static String	DEPOSITORY_SENSOR_SUMMARY_URI /wattdepot/{org-id}/depository/{depository-id}/summary/ URI for getting all the sensors that have stored measurements in the depository.
static String	DEPOSITORY_SENSORS_URI /wattdepot/{org-id}/depository/{depository-id}/sensors/ URI for getting all the sensors that have stored measurements in the depository.
static String	DEPOSITORY_URI /wattdepot/{org-id}/depository/{depository-id} URI for Depository manipulation.
static String	DESCRIPTIVE_STATS_URI /wattdepot/{org-id}/depository/{depository-id}/descriptive-stats/{hourly-daily}/ URI to get the historical values for a sensor or sensor group.
static String	HISTORICAL_VALUES_URI /wattdepot/{org-id}/depository/{depository-id}/historical-values/{hourly-daily}/ URI to get the historical values for a sensor or sensor group.
static String	HOURLY_VALUES_URI /wattdepot/{org-id}/depository/{depository-id}/hourly/values/ URI for getting hourly samples.
static String	LATEST_VALUE_URI /wattdepot/{org-id}/depository/{depository-id}/latest/value/ URI to get the latest value(s) for a sensor or sensor group.
static String	MEASUREMENT_PRUNING_DEFINITION_PUT_URI /wattdepot/{org-id}/measurement-pruning-definition/ URI for putting a MeasurementPruningDefinition.
static String	MEASUREMENT_PRUNING_DEFINITION_URI /wattdepot/{org-id}/measurement-pruning-definition/{measurement-pruning- definition-id} URI for getting a MeasurementPruningDefinition.
static String	MEASUREMENT_PRUNING_DEFINITIONS_URI /wattdepot/{org-id}/measurement-pruning-definitions/ URI for getting all defined MeasurementPruningDefinition.
static String	MEASUREMENT_PUT_URI /wattdepot/{org-id}/depository/{depository-id}/measurement/ URI for putting a measurement into the depository.
static String	MEASUREMENT_TYPE_PUT_URI /wattdepot/public/measurement-type/ URI for storing new MeasurmentTypes.
static String	MEASUREMENT_TYPE_URI /wattdepot/public/measurement-type/{measurement-type-id} URI for MeasurmentType manipulation.
static String	MEASUREMENT_TYPES_URI /wattdepot/public/measurement-types/ URI for getting all MeasurmentTypes.
static String	MEASUREMENT_URI /wattdepot/{org-id}/depository/{depository-id}/measurement/{ measurement-id} URI for manipulating a measurement in the depsository.
static String	MEASUREMENTS_GVIZ_URI /wattdepot/{org-id}/depository/{depository-id}/measurements/gviz/ URI to get all the measurements in the depsository.
static String	MEASUREMENTS_PUT_URI /wattdepot/{org-id}/depository/{depository-id}/measurements/ URI for putting measurements into the depository.
static String	MEASUREMENTS_URI /wattdepot/{org-id}/depository/{depository-id}/measurements/ URI to get all the measurements in the depsository.
static String	ORGANIZATION_PUT_URI /wattdepot/{org-id}/organization/ URI to store UserGroups.
static String	ORGANIZATION_SUMMARY_URI /wattdepot/{org-id}/summary/ URI for the Organization Summary User Interface.
static String	ORGANIZATION_URI /wattdepot/{org-id}/user-group/{user-org-id} URI to manipulate SensorGroups.
static String	ORGANIZATION_VISUALIZE_URI /wattdepot/{org-id}/visualize/ URI for the Organization Visualization User Interface.
static String	ORGANIZATIONS_URI /wattdepot/{org-id}/user-groups/ URI to get all defined SensorGroups.
static String	SENSOR_GROUP_PUT_URI /wattdepot/{org-id}/sensor-group/ URI to store SensorGroups.
static String	SENSOR_GROUP_URI /wattdepot/{org-id}/sensor-group/{sensor-org-id} URI to manipulate SensorGroups.
static String	SENSOR_GROUPS_URI /wattdepot/{org-id}/sensor-groups/ URI to get all defined SensorGroups.
static String	SENSOR_MEASUREMENT_SUMMARY_URI /wattdepot/{org-id}/depository/{depository-id}/value/ URI to get all the measured value.
static String	SENSOR_MODEL_PUT_URI /wattdepot/public/sensor-model/ URI for storing new SensorModels.
static String	SENSOR_MODEL_URI /wattdepot/public/sensor-model/{sensor-model-id} URI for SensorModel manipulation.
static String	SENSOR_MODELS_URI /wattdepot/public/sensor-models/ URI for getting all SensorModels.
static String	SENSOR_PUT_URI /wattdepot/{org-id}/sensor/ URI to store Sensors.
static String	SENSOR_STATUS_URI /wattdepot/{org-id}/depository/{depository-id}/sensor-status/ URI to get the latest status for a sensor or sensor group.
static String	SENSOR_URI /wattdepot/{org-id}/sensor/{sensor-id} URI to manipulate Sensors.
static String	SENSORS_URI /wattdepot/{org-id}/sensors/ URI to get all defined Sensors.
static String	USER_PASSWORD_URI /wattdepot/{org-id}/user-password/{user-id} URI for manipulating UserPasswords.
static String	USER_PUT_URI /wattdepot/{org-id}/user/ URI for putting UserInfos.
static String	USER_URI /wattdepot/{org-id}/user/{user-id} URI for manipulating UserInfos.
static String	USERS_URI /wattdepot/{org-id}/users/ URI for getting the UserInfos in the organization.
static String	VALUE_GVIZ_URI /wattdepot/{org-id}/depository/{depository-id}/value/gviz/ URI to get all the measured value.
static String	VALUE_URI /wattdepot/{org-id}/depository/{depository-id}/value/ URI to get all the measured value.
static String	VALUES_AVERAGE_GVIZ_URI /wattdepot/{org-id}/depository/{depository-id}/values/average/gviz/ URI to get all the average value for an interval of measurements.
static String	VALUES_AVERAGE_URI /wattdepot/{org-id}/depository/{depository-id}/values/average/ URI to get all the average value for an interval of measurements.
static String	VALUES_CSV_URI /wattdepot/{org-id}/depository/{depository-id}/values/csv/ URI to get all the measured value.
static String	VALUES_GVIZ_URI /wattdepot/{org-id}/depository/{depository-id}/values/gviz/ URI to get all the measured value.
static String	VALUES_LATEST_URI /wattdepot/{org-id}/depository/{depository-id}/values/latest/ URI to get the latest value(s) for a sensor or sensor group.
static String	VALUES_MAXIMUM_URI /wattdepot/{org-id}/depository/{depository-id}/values/maximum/ URI to get all the average value for an interval of measurements.
static String	VALUES_MINIMUM_URI /wattdepot/{org-id}/depository/{depository-id}/values/minimum/ URI to get all the average value for an interval of measurements.
static String	VALUES_URI /wattdepot/{org-id}/depository/{depository-id}/values/ URI to get all the measured value.

Constructor Summary

Constructors

Constructor and Description
API()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URI

public static final String BASE_URI

/wattdepot/ URI for seeing if the server is alive. Supports GET requests.

See Also:

Constant Field Values

ADMIN_URI

public static final String ADMIN_URI

/wattdepot/{org-id}/ URI for the group administration User Interface. Supports GET requests.

See Also:

Constant Field Values

COLLECTOR_PROCESS_DEFINITION_PUT_URI

public static final String COLLECTOR_PROCESS_DEFINITION_PUT_URI

/wattdepot/{org-id}/collector-process-definition/ URI for storing CollectorProcessDefinition. Use PUT requests.

See Also:

Constant Field Values

COLLECTOR_PROCESS_DEFINITION_URI

public static final String COLLECTOR_PROCESS_DEFINITION_URI

/wattdepot/{org-id}/collector-process-definition/{collector-process- definition-id} URI for manipulating CollectorProcessDefinition. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

COLLECTOR_PROCESS_DEFINITIONS_URI

public static final String COLLECTOR_PROCESS_DEFINITIONS_URI

/wattdepot/{org-id}/collector-process-definitions/ URI for getting all the defined CollectorProcessDefinition. Use GET requests.

See Also:

Constant Field Values

DEPOSITORIES_URI

public static final String DEPOSITORIES_URI

/wattdepot/{org-id}/depositories/ URI for getting all Depositories. Use GET requests.

See Also:

Constant Field Values

DEPOSITORY_PUT_URI

public static final String DEPOSITORY_PUT_URI

/wattdepot/{org-id}/depository/ URI for storing new Depositories. Use PUT requests.

See Also:

Constant Field Values

DEPOSITORY_SENSOR_SUMMARY_URI

public static final String DEPOSITORY_SENSOR_SUMMARY_URI

/wattdepot/{org-id}/depository/{depository-id}/summary/ URI for getting all the sensors that have stored measurements in the depository. Use GET requests.

See Also:

Constant Field Values

DEPOSITORY_SENSORS_URI

public static final String DEPOSITORY_SENSORS_URI

/wattdepot/{org-id}/depository/{depository-id}/sensors/ URI for getting all the sensors that have stored measurements in the depository. Use GET requests.

See Also:

Constant Field Values

DEPOSITORY_URI

public static final String DEPOSITORY_URI

/wattdepot/{org-id}/depository/{depository-id} URI for Depository manipulation. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

DAY_HOURLY_VALUES_URI

public static final String DAY_HOURLY_VALUES_URI

/wattdepot/{org-id}/depository/{depository-id}/day-hourly/values/ URI for getting a day's hourly samples. Use GET requests.

See Also:

Constant Field Values

DAILY_VALUES_URI

public static final String DAILY_VALUES_URI

/wattdepot/{org-id}/depository/{depository-id}/daily/values/ URI for getting daily samples. Use GET requests.

See Also:

Constant Field Values

HOURLY_VALUES_URI

public static final String HOURLY_VALUES_URI

/wattdepot/{org-id}/depository/{depository-id}/hourly/values/ URI for getting hourly samples. Use GET requests.

See Also:

Constant Field Values

MEASUREMENT_PRUNING_DEFINITION_PUT_URI

public static final String MEASUREMENT_PRUNING_DEFINITION_PUT_URI

/wattdepot/{org-id}/measurement-pruning-definition/ URI for putting a MeasurementPruningDefinition. Use PUT requests.

See Also:

Constant Field Values

MEASUREMENT_PRUNING_DEFINITION_URI

public static final String MEASUREMENT_PRUNING_DEFINITION_URI

/wattdepot/{org-id}/measurement-pruning-definition/{measurement-pruning- definition-id} URI for getting a MeasurementPruningDefinition. Use GET requests.

See Also:

Constant Field Values

MEASUREMENT_PRUNING_DEFINITIONS_URI

public static final String MEASUREMENT_PRUNING_DEFINITIONS_URI

/wattdepot/{org-id}/measurement-pruning-definitions/ URI for getting all defined MeasurementPruningDefinition. Use GET requests.

See Also:

Constant Field Values

MEASUREMENT_PUT_URI

public static final String MEASUREMENT_PUT_URI

/wattdepot/{org-id}/depository/{depository-id}/measurement/ URI for putting a measurement into the depository. Use PUT requests.

See Also:

Constant Field Values

MEASUREMENTS_PUT_URI

public static final String MEASUREMENTS_PUT_URI

/wattdepot/{org-id}/depository/{depository-id}/measurements/ URI for putting measurements into the depository. Use PUT requests.

See Also:

Constant Field Values

MEASUREMENT_TYPE_PUT_URI

public static final String MEASUREMENT_TYPE_PUT_URI

/wattdepot/public/measurement-type/ URI for storing new MeasurmentTypes. Use PUT requests.

See Also:

Constant Field Values

MEASUREMENT_TYPE_URI

public static final String MEASUREMENT_TYPE_URI

/wattdepot/public/measurement-type/{measurement-type-id} URI for MeasurmentType manipulation. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

MEASUREMENT_TYPES_URI

public static final String MEASUREMENT_TYPES_URI

/wattdepot/public/measurement-types/ URI for getting all MeasurmentTypes. Use GET requests.

See Also:

Constant Field Values

MEASUREMENT_URI

public static final String MEASUREMENT_URI

/wattdepot/{org-id}/depository/{depository-id}/measurement/{ measurement-id} URI for manipulating a measurement in the depsository. Supports GET and DELETE requests.

See Also:

Constant Field Values

MEASUREMENTS_GVIZ_URI

public static final String MEASUREMENTS_GVIZ_URI

/wattdepot/{org-id}/depository/{depository-id}/measurements/gviz/ URI to get all the measurements in the depsository. Use GET requests.

See Also:

Constant Field Values

MEASUREMENTS_URI

public static final String MEASUREMENTS_URI

/wattdepot/{org-id}/depository/{depository-id}/measurements/ URI to get all the measurements in the depsository. Use GET requests.

See Also:

Constant Field Values

ORGANIZATION_PUT_URI

public static final String ORGANIZATION_PUT_URI

/wattdepot/{org-id}/organization/ URI to store UserGroups. Use PUT requests.

See Also:

Constant Field Values

ORGANIZATION_SUMMARY_URI

public static final String ORGANIZATION_SUMMARY_URI

/wattdepot/{org-id}/summary/ URI for the Organization Summary User Interface. Supports GET requests.

See Also:

Constant Field Values

ORGANIZATION_URI

public static final String ORGANIZATION_URI

/wattdepot/{org-id}/user-group/{user-org-id} URI to manipulate SensorGroups. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

ORGANIZATION_VISUALIZE_URI

public static final String ORGANIZATION_VISUALIZE_URI

/wattdepot/{org-id}/visualize/ URI for the Organization Visualization User Interface. Supports GET requests.

See Also:

Constant Field Values

ORGANIZATIONS_URI

public static final String ORGANIZATIONS_URI

/wattdepot/{org-id}/user-groups/ URI to get all defined SensorGroups. Use GET requests.

See Also:

Constant Field Values

SENSOR_GROUP_PUT_URI

public static final String SENSOR_GROUP_PUT_URI

/wattdepot/{org-id}/sensor-group/ URI to store SensorGroups. Use PUT requests.

See Also:

Constant Field Values

SENSOR_GROUP_URI

public static final String SENSOR_GROUP_URI

/wattdepot/{org-id}/sensor-group/{sensor-org-id} URI to manipulate SensorGroups. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

SENSOR_GROUPS_URI

public static final String SENSOR_GROUPS_URI

/wattdepot/{org-id}/sensor-groups/ URI to get all defined SensorGroups. Use GET requests.

See Also:

Constant Field Values

SENSOR_MEASUREMENT_SUMMARY_URI

public static final String SENSOR_MEASUREMENT_SUMMARY_URI

/wattdepot/{org-id}/depository/{depository-id}/value/ URI to get all the measured value. Use GET requests.

See Also:

Constant Field Values

SENSOR_MODEL_PUT_URI

public static final String SENSOR_MODEL_PUT_URI

/wattdepot/public/sensor-model/ URI for storing new SensorModels. Use PUT requests.

See Also:

Constant Field Values

SENSOR_MODEL_URI

public static final String SENSOR_MODEL_URI

/wattdepot/public/sensor-model/{sensor-model-id} URI for SensorModel manipulation. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

SENSOR_MODELS_URI

public static final String SENSOR_MODELS_URI

/wattdepot/public/sensor-models/ URI for getting all SensorModels. Use GET reqeusts.

See Also:

Constant Field Values

SENSOR_PUT_URI

public static final String SENSOR_PUT_URI

/wattdepot/{org-id}/sensor/ URI to store Sensors. Use PUT requests.

See Also:

Constant Field Values

SENSOR_URI

public static final String SENSOR_URI

/wattdepot/{org-id}/sensor/{sensor-id} URI to manipulate Sensors. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

SENSORS_URI

public static final String SENSORS_URI

/wattdepot/{org-id}/sensors/ URI to get all defined Sensors. Use GET requests.

See Also:

Constant Field Values

USER_PASSWORD_URI

public static final String USER_PASSWORD_URI

/wattdepot/{org-id}/user-password/{user-id} URI for manipulating UserPasswords. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

USER_PUT_URI

public static final String USER_PUT_URI

/wattdepot/{org-id}/user/ URI for putting UserInfos. Supports PUT requests.

See Also:

Constant Field Values

USER_URI

public static final String USER_URI

/wattdepot/{org-id}/user/{user-id} URI for manipulating UserInfos. Supports GET, POST, and DELETE requests.

See Also:

Constant Field Values

USERS_URI

public static final String USERS_URI

/wattdepot/{org-id}/users/ URI for getting the UserInfos in the organization. Supports GET requests.

See Also:

Constant Field Values

VALUE_GVIZ_URI

public static final String VALUE_GVIZ_URI

/wattdepot/{org-id}/depository/{depository-id}/value/gviz/ URI to get all the measured value. Use GET requests.

See Also:

Constant Field Values

VALUE_URI

public static final String VALUE_URI

/wattdepot/{org-id}/depository/{depository-id}/value/ URI to get all the measured value. Use GET requests.

See Also:

Constant Field Values

VALUES_AVERAGE_GVIZ_URI

public static final String VALUES_AVERAGE_GVIZ_URI

/wattdepot/{org-id}/depository/{depository-id}/values/average/gviz/ URI to get all the average value for an interval of measurements. Use GET requests.

See Also:

Constant Field Values

VALUES_AVERAGE_URI

public static final String VALUES_AVERAGE_URI

/wattdepot/{org-id}/depository/{depository-id}/values/average/ URI to get all the average value for an interval of measurements. Use GET requests.

See Also:

Constant Field Values

VALUES_GVIZ_URI

public static final String VALUES_GVIZ_URI

/wattdepot/{org-id}/depository/{depository-id}/values/gviz/ URI to get all the measured value. Use GET requests.

See Also:

Constant Field Values

VALUES_CSV_URI

public static final String VALUES_CSV_URI

/wattdepot/{org-id}/depository/{depository-id}/values/csv/ URI to get all the measured value. Use GET requests.

See Also:

Constant Field Values

VALUES_MAXIMUM_URI

public static final String VALUES_MAXIMUM_URI

/wattdepot/{org-id}/depository/{depository-id}/values/maximum/ URI to get all the average value for an interval of measurements. Use GET requests.

See Also:

Constant Field Values

VALUES_MINIMUM_URI

public static final String VALUES_MINIMUM_URI

/wattdepot/{org-id}/depository/{depository-id}/values/minimum/ URI to get all the average value for an interval of measurements. Use GET requests.

See Also:

Constant Field Values

VALUES_URI

public static final String VALUES_URI

/wattdepot/{org-id}/depository/{depository-id}/values/ URI to get all the measured value. Use GET requests.

See Also:

Constant Field Values

VALUES_LATEST_URI

public static final String VALUES_LATEST_URI

/wattdepot/{org-id}/depository/{depository-id}/values/latest/ URI to get the latest value(s) for a sensor or sensor group. Use GET requests.

See Also:

Constant Field Values

SENSOR_STATUS_URI

public static final String SENSOR_STATUS_URI

/wattdepot/{org-id}/depository/{depository-id}/sensor-status/ URI to get the latest status for a sensor or sensor group. Use GET requests.

See Also:

Constant Field Values

LATEST_VALUE_URI

public static final String LATEST_VALUE_URI

/wattdepot/{org-id}/depository/{depository-id}/latest/value/ URI to get the latest value(s) for a sensor or sensor group. Use GET requests.

See Also:

Constant Field Values

DESCRIPTIVE_STATS_URI

public static final String DESCRIPTIVE_STATS_URI

/wattdepot/{org-id}/depository/{depository-id}/descriptive-stats/{hourly-daily}/ URI to get the historical values for a sensor or sensor group. Use GET requests.

See Also:

Constant Field Values

HISTORICAL_VALUES_URI

public static final String HISTORICAL_VALUES_URI

/wattdepot/{org-id}/depository/{depository-id}/historical-values/{hourly-daily}/ URI to get the historical values for a sensor or sensor group. Use GET requests.

See Also:

Constant Field Values

Constructor Detail

API

public API()