Package energy.eddie.api.agnostic

Record Class ConnectionStatusMessage

java.lang.Object

java.lang.Record

energy.eddie.api.agnostic.ConnectionStatusMessage

Record Components:

connectionId - id of the connection (a connectionId can be associated with multiple permissions)

permissionId - unique id of the permission

dataNeedId - id of the data need associated with the permission

dataSourceInformation - information about the datasource

timestamp - timestamp of the message

status - status of the message

message - contains additional information about the status

additionalInformation - this field can be used to provide additional information about the status via a JSON object

All Implemented Interfaces:

MessageWithHeaders

public record ConnectionStatusMessage(String connectionId, String permissionId, String dataNeedId, DataSourceInformation dataSourceInformation, ZonedDateTime timestamp, PermissionProcessStatus status, String message, @Nullable com.fasterxml.jackson.databind.JsonNode additionalInformation)
extends Record
implements MessageWithHeaders

Represents a generic status message for a permission

Constructor Summary

Constructors

Constructor	Description
ConnectionStatusMessage(PermissionRequest pr)
ConnectionStatusMessage(String connectionId, String permissionId, String dataNeedId, DataSourceInformation dataSourceInformation, PermissionProcessStatus status)
ConnectionStatusMessage(String connectionId, String permissionId, String dataNeedId, DataSourceInformation dataSourceInformation, PermissionProcessStatus status, String message)
ConnectionStatusMessage(String connectionId, String permissionId, String dataNeedId, DataSourceInformation dataSourceInformation, PermissionProcessStatus status, String message, com.fasterxml.jackson.databind.JsonNode additionalInformation)
ConnectionStatusMessage(String connectionId, String permissionId, String dataNeedId, DataSourceInformation dataSourceInformation, ZonedDateTime timestamp, PermissionProcessStatus status, String message, com.fasterxml.jackson.databind.JsonNode additionalInformation)	Creates an instance of a ConnectionStatusMessage record class.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	additionalInformation()	Returns the value of the additionalInformation record component.
String	connectionId()	Returns the value of the connectionId record component.
String	dataNeedId()	Returns the value of the dataNeedId record component.
DataSourceInformation	dataSourceInformation()	Returns the value of the dataSourceInformation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message record component.
String	permissionId()	Returns the value of the permissionId record component.
PermissionProcessStatus	status()	Returns the value of the status record component.
ZonedDateTime	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConnectionStatusMessage

public ConnectionStatusMessage(PermissionRequest pr)

ConnectionStatusMessage

public ConnectionStatusMessage(String connectionId,
 String permissionId,
 String dataNeedId,
 DataSourceInformation dataSourceInformation,
 PermissionProcessStatus status)

ConnectionStatusMessage

public ConnectionStatusMessage(String connectionId,
 String permissionId,
 String dataNeedId,
 DataSourceInformation dataSourceInformation,
 PermissionProcessStatus status,
 String message)

ConnectionStatusMessage

public ConnectionStatusMessage(String connectionId,
 String permissionId,
 String dataNeedId,
 DataSourceInformation dataSourceInformation,
 PermissionProcessStatus status,
 String message,
 com.fasterxml.jackson.databind.JsonNode additionalInformation)

ConnectionStatusMessage

public ConnectionStatusMessage(String connectionId,
 String permissionId,
 String dataNeedId,
 DataSourceInformation dataSourceInformation,
 ZonedDateTime timestamp,
 PermissionProcessStatus status,
 String message,
 @Nullable
 com.fasterxml.jackson.databind.JsonNode additionalInformation)

Creates an instance of a ConnectionStatusMessage record class.

Parameters:

connectionId - the value for the connectionId record component

permissionId - the value for the permissionId record component

dataNeedId - the value for the dataNeedId record component

dataSourceInformation - the value for the dataSourceInformation record component

timestamp - the value for the timestamp record component

status - the value for the status record component

message - the value for the message record component

additionalInformation - the value for the additionalInformation record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

connectionId

public String connectionId()

Returns the value of the connectionId record component.

Specified by:

connectionId in interface MessageWithHeaders

Returns:

the value of the connectionId record component

permissionId

public String permissionId()

Returns the value of the permissionId record component.

Specified by:

permissionId in interface MessageWithHeaders

Returns:

the value of the permissionId record component

dataNeedId

public String dataNeedId()

Returns the value of the dataNeedId record component.

Specified by:

dataNeedId in interface MessageWithHeaders

Returns:

the value of the dataNeedId record component

dataSourceInformation

public DataSourceInformation dataSourceInformation()

Returns the value of the dataSourceInformation record component.

Returns:

the value of the dataSourceInformation record component

timestamp

public ZonedDateTime timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component

status

public PermissionProcessStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

additionalInformation

@Nullable
public com.fasterxml.jackson.databind.JsonNode additionalInformation()

Returns the value of the additionalInformation record component.

Returns:

the value of the additionalInformation record component