public interface HistoryManager
Modifier and Type | Method and Description |
---|---|
boolean |
canAccept(java.lang.String dataStore,
HistoryFlavor flavor)
Returns true if the data store will accept the type of data.
|
void |
deleteQuarantinedData(java.lang.String dataStore,
java.util.List<java.lang.Long> quarantinedDataIds)
Deletes the quarantined data associated with the
QuarantinedDataInfo id. |
void |
exportQuarantinedToXML(java.lang.String dataStore,
java.util.List<java.lang.Long> quarantinedDataIds,
java.io.Writer writer) |
java.util.List<QuarantinedDataInfo> |
getQuarantinedDataInfo(java.lang.String dataStore)
Returns information describing the data quarantined in the given store.
|
java.util.List<DataSinkInformation> |
getStatusInfo(java.lang.String dataStore)
Returns the hierarchy of status information for the given store, flattened into a list.
|
java.util.List<java.lang.String> |
getStores(HistoryFlavor historyType)
Returns a list of data stores that can accept the specified type of data.
|
void |
importQuarantinedFromXML(java.lang.String dataStore,
java.io.InputStream is) |
void |
registerHistoryFlavor(HistoryFlavor flavor)
Registers a history flavor with the system.
|
void |
registerSink(DataSink sink)
Sets up a custom history sink.
|
void |
registerSinkInPipline(DataSink sink)
Similar to registerSink, except that it will not create a new store and forward pipeline if the name doesn't
exist.
|
void |
storeHistory(java.lang.String dataStore,
HistoricalData values)
Stores the data to the given history store.
|
void |
unquarantineData(java.lang.String dataStore,
java.util.List<java.lang.Long> quarantinedDataIds)
Unquaratines the given
QuarantinedDataInfo ids, which will cause the data to enter the forward cycle
again. |
void |
unregisterHistoryFlavor(HistoryFlavor flavor) |
void |
unregisterSink(DataSink sink,
boolean allowDataDeletion)
Removes the given sink from the specified pipeline.
|
void registerSink(DataSink sink)
DataSink.getPipelineName()
void registerSinkInPipline(DataSink sink)
void unregisterSink(DataSink sink, boolean allowDataDeletion)
void storeHistory(java.lang.String dataStore, HistoricalData values) throws java.lang.IllegalArgumentException, java.lang.Exception
dataStore
- values
- java.lang.Exception
java.lang.IllegalArgumentException
boolean canAccept(java.lang.String dataStore, HistoryFlavor flavor)
dataStore
- flavor
- @Nonnull java.util.List<java.lang.String> getStores(HistoryFlavor historyType)
historyType
- java.util.List<DataSinkInformation> getStatusInfo(java.lang.String dataStore)
dataStore
- java.lang.IllegalArgumentException
- if the given dataStore name doesn't exist.@Nonnull java.util.List<QuarantinedDataInfo> getQuarantinedDataInfo(java.lang.String dataStore)
dataStore
- void unquarantineData(java.lang.String dataStore, @Nonnull java.util.List<java.lang.Long> quarantinedDataIds)
QuarantinedDataInfo
ids, which will cause the data to enter the forward cycle
again.quarantinedDataIds
- void deleteQuarantinedData(java.lang.String dataStore, java.util.List<java.lang.Long> quarantinedDataIds)
QuarantinedDataInfo
id.quarantinedDataIds
- void exportQuarantinedToXML(java.lang.String dataStore, java.util.List<java.lang.Long> quarantinedDataIds, java.io.Writer writer) throws java.io.IOException
java.io.IOException
void importQuarantinedFromXML(java.lang.String dataStore, java.io.InputStream is) throws java.io.IOException
java.io.IOException
void registerHistoryFlavor(HistoryFlavor flavor)
flavor
- void unregisterHistoryFlavor(HistoryFlavor flavor)