it.wldt.adapter.mqtt.physical.MqttPhysicalAdapterConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mqtt-physical-adapter Show documentation
Physical adapter to connect with the MQTT protocol
The newest version!
package it.wldt.adapter.mqtt.physical;

import it.wldt.adapter.physical.PhysicalAssetAction;
import it.wldt.adapter.physical.PhysicalAssetDescription;
import it.wldt.adapter.physical.PhysicalAssetEvent;
import it.wldt.adapter.physical.PhysicalAssetProperty;
import it.wldt.adapter.mqtt.physical.exception.MqttPhysicalAdapterConfigurationException;
import it.wldt.adapter.mqtt.physical.topic.incoming.DigitalTwinIncomingTopic;
import it.wldt.adapter.mqtt.physical.topic.outgoing.DigitalTwinOutgoingTopic;
import org.eclipse.paho.client.mqttv3.MqttClientPersistence;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;

import java.util.*;

/**
 * Configuration class for the MqttPhysicalAdapter, providing settings for connecting to an MQTT broker,
 * defining incoming and outgoing topics, and specifying the physical asset description.
 *
 * To create an instance of this configuration, use the provided builder {@link MqttPhysicalAdapterConfigurationBuilder}.
 *
 * @see MqttPhysicalAdapter
 * @see MqttPhysicalAdapterConfigurationBuilder
 *
 * @author Marco Picone, Ph.D. - [email protected], Marta Spadoni University of Bologna
 */
public class MqttPhysicalAdapterConfiguration {

    /** The address of the MQTT broker. */
    private final String brokerAddress;

    /** The port of the MQTT broker. */
    private final Integer brokerPort;

    /** The optional username for connecting to the MQTT broker. */
    private String username;

    /** The optional password for connecting to the MQTT broker. */
    private String password;

    /** The client ID used when connecting to the MQTT broker. */
    private String clientId;

    /** Flag indicating whether to use a clean session when connecting to the MQTT broker. */
    private boolean cleanSessionFlag = true;

    /** The connection timeout (in seconds) when connecting to the MQTT broker. */
    private Integer connectionTimeout = 10;

    /** The persistence mechanism used by the MQTT client. */
    private MqttClientPersistence persistence = new MemoryPersistence();

    /** Flag indicating whether automatic reconnection to the MQTT broker is enabled. */
    private boolean automaticReconnectFlag = true;

    /** The description of the physical asset, including actions, properties, and events. */
    private PhysicalAssetDescription physicalAssetDescription;

    /** List of incoming topics to which the PhysicalAdapter must subscribe. */
    private final List incomingTopics = new ArrayList<>();

    /** Map of outgoing topics on which the PhysicalAdapter must publish, indexed by action key. */
    private final Map outgoingTopics = new HashMap<>();

    /**
     * Constructs a new MqttPhysicalAdapterConfiguration with the specified broker address, broker port,
     * and client ID.
     *
     * @param brokerAddress The address of the MQTT broker.
     * @param brokerPort    The port of the MQTT broker.
     * @param clientId      The client ID used for connecting to the MQTT broker.
     */
    protected MqttPhysicalAdapterConfiguration(String brokerAddress, Integer brokerPort, String clientId) {
        this.brokerAddress = brokerAddress;
        this.brokerPort = brokerPort;
        this.clientId = clientId;
    }

    /**
     * Constructs a new MqttPhysicalAdapterConfiguration with the specified broker address, broker port,
     * and default client ID.
     *
     * @param brokerAddress The address of the MQTT broker.
     * @param brokerPort    The port of the MQTT broker.
     */
    protected MqttPhysicalAdapterConfiguration(String brokerAddress, Integer brokerPort){
        this(brokerAddress, brokerPort, "wldt.mqtt.client."+new Random(System.currentTimeMillis()).nextInt());
    }

    /**
     * Creates a new MqttPhysicalAdapterConfigurationBuilder for building MqttPhysicalAdapterConfiguration instances.
     *
     * @param brokerAddress The address of the MQTT broker.
     * @param brokerPort    The port of the MQTT broker.
     * @param clientId      The client ID used for connecting to the MQTT broker.
     * @return The MqttPhysicalAdapterConfigurationBuilder instance.
     * @throws MqttPhysicalAdapterConfigurationException If there is an issue creating the builder.
     * @see MqttPhysicalAdapterConfigurationBuilder
     */
    public static MqttPhysicalAdapterConfigurationBuilder builder(String brokerAddress, Integer brokerPort, String clientId) throws MqttPhysicalAdapterConfigurationException {
        return new MqttPhysicalAdapterConfigurationBuilder(brokerAddress, brokerPort, clientId);
    }

    /**
     * Creates a new MqttPhysicalAdapterConfigurationBuilder for building MqttPhysicalAdapterConfiguration instances
     * with the specified broker address and port, using a default client ID.
     *
     * @param brokerAddress The address of the MQTT broker.
     * @param brokerPort    The port of the MQTT broker.
     * @return The MqttPhysicalAdapterConfigurationBuilder instance.
     * @throws MqttPhysicalAdapterConfigurationException If there is an issue creating the builder.
     * @see MqttPhysicalAdapterConfigurationBuilder
     */
    public static MqttPhysicalAdapterConfigurationBuilder builder(String brokerAddress, Integer brokerPort) throws MqttPhysicalAdapterConfigurationException {
        return new MqttPhysicalAdapterConfigurationBuilder(brokerAddress, brokerPort);
    }

    /**
     * Gets the address of the MQTT broker.
     *
     * @return The address of the MQTT broker.
     */
    public String getBrokerAddress() {
        return brokerAddress;
    }

    /**
     * Gets the port of the MQTT broker.
     *
     * @return The port of the MQTT broker.
     */
    public Integer getBrokerPort() {
        return brokerPort;
    }

    /**
     * Gets the username used for connecting to the MQTT broker.
     *
     * @return The username for connecting to the MQTT broker.
     */
    public String getUsername() {
        return username;
    }

    /**
     * Gets the password used for connecting to the MQTT broker.
     *
     * @return The password for connecting to the MQTT broker.
     */
    public String getPassword() {
        return password;
    }

    /**
     * Gets the client ID used for connecting to the MQTT broker.
     *
     * @return The client ID for connecting to the MQTT broker.
     */
    public String getClientId() {
        return clientId;
    }

    /**
     * Gets the MQTT broker connection string.
     *
     * @return The MQTT broker connection string.
     */
    public String getBrokerConnectionString(){
        return String.format("tcp://%s:%d", brokerAddress, brokerPort);
    }

    /**
     * Gets the persistence mechanism used by the MQTT client.
     *
     * @return The MQTT client persistence mechanism.
     */
    public MqttClientPersistence getPersistence() {
        return persistence;
    }

    /**
     * Gets the connection options for connecting to the MQTT broker.
     *
     * @return The MQTT connection options.
     */
    public MqttConnectOptions getConnectOptions(){
        MqttConnectOptions options = new MqttConnectOptions();
        options.setAutomaticReconnect(automaticReconnectFlag);
        options.setCleanSession(cleanSessionFlag);
        options.setConnectionTimeout(connectionTimeout);
        if(username != null && !username.isEmpty() && password != null && !password.isEmpty()){
            options.setUserName(username);
            options.setPassword(password.toCharArray());
        }
        return options;
    }

    /**
     * Gets the list of incoming topics to which the PhysicalAdapter must subscribe.
     *
     * @return The list of incoming topics.
     */
    public List getIncomingTopics() {
        return incomingTopics;
    }

    /**
     * Gets the map of outgoing topics on which the PhysicalAdapter must publish, indexed by action key.
     *
     * @return The map of outgoing topics.
     */
    public Map getOutgoingTopics() {
        return outgoingTopics;
    }

    /**
     * Gets the outgoing topic for a specific action key, if present.
     *
     * @param key The action key.
     * @return An {@link Optional} containing the outgoing topic, or an empty {@link Optional} if not present.
     */
    public Optional getOutgoingTopicByActionKey(String key){
        return outgoingTopics.containsKey(key) ? Optional.of(outgoingTopics.get(key)) : Optional.empty();
    }

    /**
     * Gets the description of the physical asset, including actions, properties, and events.
     *
     * @return The physical asset description.
     */
    public PhysicalAssetDescription getPhysicalAssetDescription() {
        return physicalAssetDescription;
    }

    /**
     * Adds an incoming topic to the configuration.
     *
     * @param topic The incoming topic to add.
     */
    protected void addIncomingTopic(DigitalTwinIncomingTopic topic){
        this.incomingTopics.add(topic);
    }

    /**
     * Adds an outgoing topic to the configuration.
     *
     * @param actionKey The action key associated with the outgoing topic.
     * @param topic     The outgoing topic to add.
     */
    protected void addOutgoingTopic(String actionKey, DigitalTwinOutgoingTopic topic){
        this.outgoingTopics.put(actionKey,topic);
    }

    /**
     * Sets the description of the physical asset, including actions, properties, and events.
     *
     * @param actions    The list of physical asset actions.
     * @param properties The list of physical asset properties.
     * @param events     The list of physical asset events.
     */
    protected void setPhysicalAssetDescription(List actions,
                                            List> properties,
                                            List events){
        this.physicalAssetDescription = new PhysicalAssetDescription(actions, properties, events);
    }

    /**
     * Sets the connection timeout value.
     *
     * @param connectionTimeout The connection timeout value.
     */
    protected void setConnectionTimeout(Integer connectionTimeout) {
        this.connectionTimeout = connectionTimeout;
    }

    /**
     * Sets the clean session flag.
     *
     * @param cleanSession The clean session flag.
     */
    protected void setCleanSessionFlag(boolean cleanSession) {
        this.cleanSessionFlag = cleanSession;
    }

    /**
     * Sets the automatic reconnect flag.
     *
     * @param automaticReconnect The automatic reconnect flag.
     */
    protected void setAutomaticReconnectFlag(boolean automaticReconnect){
        this.automaticReconnectFlag = automaticReconnect;
    }

    /**
     * Sets the MQTT client persistence mechanism.
     *
     * @param persistence The MQTT client persistence mechanism.
     */
    protected void setMqttClientPersistence(MqttClientPersistence persistence) {
        this.persistence = persistence;
    }

}