com.prosysopc.ua.pubsub

Class PubSubMqttJsonConnectionConf

java.lang.Object

com.prosysopc.ua.pubsub.PubSubMqttJsonConnectionConf

All Implemented Interfaces:

PubSubBrokerConnectionConf<PubSubMqttJsonReaderGroupConf,PubSubMqttJsonWriterGroupConf>, PubSubConf, PubSubConnectionConf<PubSubMqttJsonReaderGroupConf,PubSubMqttJsonWriterGroupConf>, PubSubNamedConf

public final class PubSubMqttJsonConnectionConf
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubMqttJsonConnectionConf.Builder Builder for PubSubMqttJsonConnectionConf.
static class	PubSubMqttJsonConnectionConf.Fields

Nested classes/interfaces inherited from interface com.prosysopc.ua.pubsub.PubSubConf

PubSubConf.MapKind<T>

Field Summary

Fields

Modifier and Type	Field and Description
static PubSubConfSpecification	SPECIFICATION

Method Summary

Modifier and Type	Method and Description
static PubSubMqttJsonConnectionConf.Builder	builder() Returns a new PubSubMqttJsonConnectionConf.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
PubSubBrokerAuthConf	getAuthConf() A reference to a secret that will resolve to user credentials for the Broker connection.
String	getMqttTopicTreePrefix() Returns the Prefix to be used in MQTT-related Publishers (see https://reference.opcfoundation.org/Core/Part14/v105/docs/7.3.5.7).
String	getName() Get connection name.
String	getNetworkAddress() Will listen on this.
PublisherId	getPublisherId() The PublisherId for a publisher.
Map<String,PubSubMqttJsonReaderGroupConf>	getReaderGroups()
PubSubTransportProfile	getTransportProfile() Returns the TransportProfile (uri) of the connection.
Map<String,PubSubMqttJsonWriterGroupConf>	getWriterGroups()
int	hashCode()
Boolean	isDisableMqttRetain()
Boolean	isEnabled() Returns the enabled state.
Boolean	isEnableStatusMessage() If true, sends 'Status' message as defined in OPC UA 1.05 Part 14 7.3.5.7.
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubMqttJsonConnectionConf.Builder	toBuilder() Returns a new PubSubMqttJsonConnectionConf.Builder that is initialized with the state of this object.
String	toString()
PubSubMqttJsonConnectionConf	withGroupAddedOrReplaced(PubSubMqttJsonReaderGroupConf conf) Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubMqttJsonReaderGroupConf.getName().
PubSubMqttJsonConnectionConf	withGroupAddedOrReplaced(PubSubMqttJsonWriterGroupConf conf) Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubMqttJsonWriterGroupConf.getName().
PubSubMqttJsonConnectionConf	withGroupRemoved(String name) Removes Group from the conf if there is any with the given name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf

get, get, toMap

Field Detail

SPECIFICATION

public static final PubSubConfSpecification SPECIFICATION

Method Detail

specification

public PubSubConfSpecification specification()

Description copied from interface: PubSubConf

Returns the specification of this object. Can be used to dynamically display the fields of the PubSubConf object.

getName

public String getName()

Get connection name. Shall be unique within a PubSubConfiguration.

getPublisherId

public PublisherId getPublisherId()

The PublisherId for a publisher.

isEnabled

public Boolean isEnabled()

Returns the enabled state.

getAuthConf

public PubSubBrokerAuthConf getAuthConf()

A reference to a secret that will resolve to user credentials for the Broker connection.

getMqttTopicTreePrefix

public String getMqttTopicTreePrefix()

Returns the Prefix to be used in MQTT-related Publishers (see https://reference.opcfoundation.org/Core/Part14/v105/docs/7.3.5.7). If not set/null, uses PubSubSystemConf.getMqttTopicTreePrefix().

getNetworkAddress

public String getNetworkAddress()

Will listen on this.

isDisableMqttRetain

public Boolean isDisableMqttRetain()

isEnableStatusMessage

public Boolean isEnableStatusMessage()

If true, sends 'Status' message as defined in OPC UA 1.05 Part 14 7.3.5.7. Default is false.

getReaderGroups

public Map<String,PubSubMqttJsonReaderGroupConf> getReaderGroups()

getWriterGroups

public Map<String,PubSubMqttJsonWriterGroupConf> getWriterGroups()

withGroupRemoved

public PubSubMqttJsonConnectionConf withGroupRemoved(String name)

Removes Group from the conf if there is any with the given name.

withGroupAddedOrReplaced

public PubSubMqttJsonConnectionConf withGroupAddedOrReplaced(PubSubMqttJsonReaderGroupConf conf)

Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubMqttJsonReaderGroupConf.getName().

withGroupAddedOrReplaced

public PubSubMqttJsonConnectionConf withGroupAddedOrReplaced(PubSubMqttJsonWriterGroupConf conf)

Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubMqttJsonWriterGroupConf.getName().

builder

public static PubSubMqttJsonConnectionConf.Builder builder()

Returns a new PubSubMqttJsonConnectionConf.Builder that can be used to construct instances of this class

toBuilder

public PubSubMqttJsonConnectionConf.Builder toBuilder()

Returns a new PubSubMqttJsonConnectionConf.Builder that is initialized with the state of this object.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getTransportProfile

public final PubSubTransportProfile getTransportProfile()

Description copied from interface: PubSubConnectionConf

Returns the TransportProfile (uri) of the connection. This defines both the transport and encoding of the connection.

Specified by:

getTransportProfile in interface PubSubConnectionConf<PubSubMqttJsonReaderGroupConf,PubSubMqttJsonWriterGroupConf>