Package com.inductiveautomation.historian.gateway.api.storage.realtime

Class ErroredNodeSession

java.lang.Object

com.inductiveautomation.historian.gateway.api.storage.realtime.ErroredNodeSession

All Implemented Interfaces:

DataNodeSession, Diagnosable

public class ErroredNodeSession
extends Object
implements DataNodeSession, Diagnosable

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.historian.gateway.api.storage.realtime.DataNodeSession

DataNodeSession.AvailabilityStatus

Constructor Summary

Constructors

Constructor	Description
ErroredNodeSession(QualityCode errorCode)
ErroredNodeSession(String message)

Method Summary

Modifier and Type	Method	Description
boolean	attachObserver(NodeSessionObserver observer)	Attaches a NodeSessionObserver to the node session.
boolean	detachObserver(NodeSessionObserver observer)	Detaches a NodeSessionObserver from the node session.
DataNodeSession.AvailabilityStatus	getAvailabilityStatus()	Gets the current availability status of the node.
CompletionStage<QualityCode>	processDataChange(DataPoint<?> dataPoint)	Processes a data change for the node.
CompletionStage<QualityCode>	processMetadataChange(MetadataPoint metadata)	Processes a metadata change for the node.
CompletionStage<QualityCode>	processSourceChange(SourceChangePoint sourceChange)	Processes a change in the source configuration or state for the node.
void	release()	Closes the session, releasing any resources associated with it.
CompletionStage<QualityCode>	reset()	Resets the current session for the node to its initial state.
CompletionStage<QualityCode>	retireNode()	Retires the node, indicating no further data changes are expected.
void	sampleDiagnostics(DiagnosticsSample sample)	Provides the sample upon which the object can set diagnostics information.

Methods inherited from class java.lang.Object

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

Constructor Details

ErroredNodeSession

public ErroredNodeSession(QualityCode errorCode)

ErroredNodeSession

public ErroredNodeSession(String message)

Method Details

getAvailabilityStatus

public DataNodeSession.AvailabilityStatus getAvailabilityStatus()

Description copied from interface: DataNodeSession

Gets the current availability status of the node.

Specified by:

getAvailabilityStatus in interface DataNodeSession

Returns:

The current DataNodeSession.AvailabilityStatus of the node.

processDataChange

public CompletionStage<QualityCode> processDataChange(DataPoint<?> dataPoint)

Description copied from interface: DataNodeSession

Processes a data change for the node.

Specified by:

processDataChange in interface DataNodeSession

Parameters:

dataPoint - The new DataPoint containing the data change for the node.

Returns:

A CompletionStage that, when completed, provides the QualityCode of the operation. If the node's availability status is UNSUPPORTED, this will complete with QualityCode.Bad_Unsupported.

processSourceChange

public CompletionStage<QualityCode> processSourceChange(SourceChangePoint sourceChange)

Description copied from interface: DataNodeSession

Processes a change in the source configuration or state for the node.

Specified by:

processSourceChange in interface DataNodeSession

Parameters:

sourceChange - The SourceChangePoint representing the source change to process.

Returns:

A CompletionStage that, when completed, provides the QualityCode of the operation. If the node's availability status is UNSUPPORTED, this will complete with QualityCode.Bad_Unsupported.

processMetadataChange

public CompletionStage<QualityCode> processMetadataChange(MetadataPoint metadata)

Description copied from interface: DataNodeSession

Processes a metadata change for the node.

Specified by:

processMetadataChange in interface DataNodeSession

Parameters:

metadata - The MetadataPoint containing the metadata change to process.

Returns:

A CompletionStage that, when completed, provides the QualityCode of the operation. If the node's availability status is UNSUPPORTED, this will complete with QualityCode.Bad_Unsupported.

reset

public CompletionStage<QualityCode> reset()

Description copied from interface: DataNodeSession

Resets the current session for the node to its initial state. This operation may involve clearing any cached data.

Specified by:

reset in interface DataNodeSession

Returns:

A CompletionStage that, when completed, provides the QualityCode indicating the result of the reset operation. If the node's availability status is UNSUPPORTED, this will complete with QualityCode.Bad_Unsupported.

retireNode

public CompletionStage<QualityCode> retireNode()

Description copied from interface: DataNodeSession

Retires the node, indicating no further data changes are expected. After calling this method, it is expected that release() will be called subsequently to properly clean up resources.

Specified by:

retireNode in interface DataNodeSession

Returns:

A CompletionStage that, when completed, provides the QualityCode of the operation. If the node's availability status is UNSUPPORTED, this will complete with QualityCode.Bad_Unsupported.

See Also:

• DataNodeSession.release()

release

public void release()

Description copied from interface: DataNodeSession

Closes the session, releasing any resources associated with it.

This method ensures that any resources allocated during the session's lifecycle are properly released. It should be called after retireNode() to complete the cleanup process and prevent resource leaks.

Specified by:

release in interface DataNodeSession

attachObserver

public boolean attachObserver(NodeSessionObserver observer)

Description copied from interface: DataNodeSession

Attaches a NodeSessionObserver to the node session. This allows the observer to receive updates about the session's state and events.

Specified by:

attachObserver in interface DataNodeSession

Parameters:

observer - The NodeSessionObserver to attach.

Returns:

true if the observer was successfully attached, false if already attached or if attachment failed.

detachObserver

public boolean detachObserver(NodeSessionObserver observer)

Description copied from interface: DataNodeSession

Detaches a NodeSessionObserver from the node session. This stops the observer from receiving further updates about the session's state and events.

Specified by:

detachObserver in interface DataNodeSession

Parameters:

observer - The NodeSessionObserver to detach.

Returns:

true if the observer was successfully detached, false if not attached or if detachment failed.

sampleDiagnostics

public void sampleDiagnostics(DiagnosticsSample sample)

Description copied from interface: Diagnosable

Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first call getSubSample() in order to specify a useful identifier for this object's data.

Specified by:

sampleDiagnostics in interface Diagnosable