Package energy.eddie.aiida.models.datasource.mqtt.inbound

Class InboundDataSource

java.lang.Object

energy.eddie.aiida.models.datasource.DataSource

energy.eddie.aiida.models.datasource.mqtt.MqttDataSource

energy.eddie.aiida.models.datasource.mqtt.inbound.InboundDataSource

@Entity
public class InboundDataSource
extends MqttDataSource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InboundDataSource.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accessCode
protected Permission	permission
protected static final String	TABLE_NAME

Fields inherited from class energy.eddie.aiida.models.datasource.mqtt.MqttDataSource

accessControlEntry, mqttConnection, TOPIC_PREFIX

Fields inherited from class energy.eddie.aiida.models.datasource.DataSource

asset, countryCode, enabled, icon, id, image, meterId, name, operatorId, permissions, type, userId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InboundDataSource()
	InboundDataSource(InboundDataSourceDto dto, UUID userId, Permission permission)
	InboundDataSource(InboundDataSourceDto dto, UUID userId, Permission permission, String accessCode)

Method Summary

Modifier and Type	Method	Description
String	accessCode()
String	acknowledgementTopic()
void	changeInboundProvisioningType(InboundProvisioningType inboundProvisioningType)	Changes the inbound provisioning type.
protected void	createAccessControlEntry()	This method creates the Access Control Entry for a MQTT data source using the ID of the data source.
protected void	createMqttUser()
MqttProvisioningConnectionDto	establishClientModeConnection(String host, String username, String password, String topic)	Configures MQTT client-mode provisioning with externally supplied broker credentials and activates that mode.
MqttProvisioningConnectionDto	establishServerModeConnection(MqttConfiguration mqttConfig, org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder encoder, String plaintextPassword)	Configures MQTT server-mode provisioning using the local broker configuration and activates that mode.
InboundProvisioningType	inboundProvisioningType()
Permission	permission()
protected void	postPersist()
MqttConnection	provisioningConnection()
String	provisioningTopic()
MqttProvisioningConnectionDto	resetServerModePassword(org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder encoder, String plaintextPassword)
Set<AiidaSchema>	schemas()
void	updateAccessCode(String accessCode)

Methods inherited from class energy.eddie.aiida.models.datasource.mqtt.MqttDataSource

configure, internalHost, password, topic, topicFormattedForUi, updatePassword, updatePassword, username

Methods inherited from class energy.eddie.aiida.models.datasource.DataSource

asset, countryCode, createFromDto, enabled, icon, id, image, meterId, name, operatorId, permissions, setEnabled, setImage, type, update, userId

Methods inherited from class java.lang.Object

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

Field Details

TABLE_NAME

protected static final String TABLE_NAME

See Also:

• Constant Field Values

accessCode

protected String accessCode

permission

protected Permission permission

Constructor Details

InboundDataSource

protected InboundDataSource()

InboundDataSource

public InboundDataSource(InboundDataSourceDto dto,
 UUID userId,
 Permission permission)
                  throws MissingMqttStreamingConfigException

Throws:

MissingMqttStreamingConfigException

InboundDataSource

public InboundDataSource(InboundDataSourceDto dto,
 UUID userId,
 Permission permission,
 String accessCode)
                  throws MissingMqttStreamingConfigException

Throws:

MissingMqttStreamingConfigException

Method Details

establishServerModeConnection

public MqttProvisioningConnectionDto establishServerModeConnection(MqttConfiguration mqttConfig,
 org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder encoder,
 String plaintextPassword)

Configures MQTT server-mode provisioning using the local broker configuration and activates that mode. A unique username is created and the supplied plaintext password is encoded before it is stored.

Parameters:

mqttConfig - Local MQTT broker configuration.

encoder - Encoder used to protect the generated credential before storage.

plaintextPassword - Plaintext password generated for the provisioning connection.

Returns:

The connection details stored for server-mode provisioning.

accessCode

public String accessCode()

updateAccessCode

public void updateAccessCode(String accessCode)

permission

public Permission permission()

schemas

public Set<AiidaSchema> schemas()

acknowledgementTopic

@Nullable
public String acknowledgementTopic()

inboundProvisioningType

public InboundProvisioningType inboundProvisioningType()

provisioningConnection

public MqttConnection provisioningConnection()
                                      throws ProvisioningConfigurationException

Throws:

ProvisioningConfigurationException

provisioningTopic

public String provisioningTopic()
                         throws ProvisioningConfigurationException

Throws:

ProvisioningConfigurationException

changeInboundProvisioningType

public void changeInboundProvisioningType(InboundProvisioningType inboundProvisioningType)

Changes the inbound provisioning type. Switching to a REST type also removes any stored MQTT provisioning connection and access-control entry.

establishClientModeConnection

public MqttProvisioningConnectionDto establishClientModeConnection(String host,
 String username,
 String password,
 String topic)

Configures MQTT client-mode provisioning with externally supplied broker credentials and activates that mode.

Returns:

The connection details stored for client-mode provisioning.

resetServerModePassword

public MqttProvisioningConnectionDto resetServerModePassword(org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder encoder,
 String plaintextPassword)
                                                      throws ProvisioningConfigurationException

Throws:

ProvisioningConfigurationException

postPersist

protected void postPersist()
                    throws MissingMqttStreamingConfigException

Overrides:

postPersist in class MqttDataSource

Throws:

MissingMqttStreamingConfigException

createMqttUser

protected void createMqttUser()
                       throws MissingMqttStreamingConfigException

Overrides:

createMqttUser in class MqttDataSource

Throws:

MissingMqttStreamingConfigException

createAccessControlEntry

protected void createAccessControlEntry()
                                 throws MissingMqttStreamingConfigException

Description copied from class: MqttDataSource

This method creates the Access Control Entry for a MQTT data source using the ID of the data source. This is the default behaviour of a MQTT data source.

Overrides:

createAccessControlEntry in class MqttDataSource

Throws:

MissingMqttStreamingConfigException