UploadService

All Known Subinterfaces:: BulkUploadService

public interface UploadService

API for posting local SolarNode data to a remote server.

Version:: 1.2
Author:: matt.magoffin

Field Summary

Fields

Modifier and Type

Field

Description

static final String

EVENT_TOPIC_DATUM_UPLOADED

An event topic for when a NodeDatum has been uploaded.
Method Summary

Modifier and Type

Method

Description

String

getKey()

Get a unique key for this service.

String

uploadDatum(NodeDatum data)

Upload Datum data.

Field Details
- EVENT_TOPIC_DATUM_UPLOADED
  
  static final String EVENT_TOPIC_DATUM_UPLOADED
  
  An event topic for when a NodeDatum has been uploaded.
  The properties of the event shall be Datum.asSimpleMap().
  Since:
  
  1.2
  
  See Also:
  
  Constant Field Values
Method Details
- getKey
  
  String getKey()
  
  Get a unique key for this service.
  This key can be used as the destination value for NodeDatum objects. It need be unique across other UploadService implementations only.
  
  Returns:
  
  unique key
- uploadDatum
  
  String uploadDatum(NodeDatum data)
  
  Upload Datum data.
  The returned primary key can be used as the trackingId value for NodeDatum objects.
  
  If the supplied Datum object is not supported by an implementation this method will throw an IllegalArgumentException.
  
  Parameters:
  
  data - the data to upload
  
  Returns:
  
  the remote primary key