Package energy.eddie.aiida.dtos.provisioning

Record Class ProvisioningConnectionDto

java.lang.Object

java.lang.Record

energy.eddie.aiida.dtos.provisioning.ProvisioningConnectionDto

Record Components:

host - MQTT broker host exposed to the provisioning client.

username - MQTT username used for publishing.

password - MQTT password used for publishing.

topic - Topic to which inbound records are published.

public record ProvisioningConnectionDto(String host, String username, String password, String topic)
extends Record

Connection details returned after MQTT provisioning is configured.

Constructor Summary

Constructors

Constructor	Description
ProvisioningConnectionDto(String host, String username, String password, String topic)	Creates an instance of a ProvisioningConnectionDto record class.

Method Summary

Modifier and Type	Method	Description
static ProvisioningConnectionDto	empty()	Creates a connection DTO with empty values for provisioning types that do not require connection details such as the REST options.
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	host()	Returns the value of the host record component.
String	password()	Returns the value of the password record component.
String	topic()	Returns the value of the topic record component.
final String	toString()	Returns a string representation of this record class.
String	username()	Returns the value of the username record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ProvisioningConnectionDto

public ProvisioningConnectionDto(String host,
 String username,
 String password,
 String topic)

Creates an instance of a ProvisioningConnectionDto record class.

Parameters:

host - the value for the host record component

username - the value for the username record component

password - the value for the password record component

topic - the value for the topic record component

Method Details

empty

public static ProvisioningConnectionDto empty()

Creates a connection DTO with empty values for provisioning types that do not require connection details such as the REST options.

Returns:

A provisioning connection DTO whose fields are empty strings.

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.

host

public String host()

Returns the value of the host record component.

Returns:

the value of the host record component

username

public String username()

Returns the value of the username record component.

Returns:

the value of the username record component

password

public String password()

Returns the value of the password record component.

Returns:

the value of the password record component

topic

public String topic()

Returns the value of the topic record component.

Returns:

the value of the topic record component