com.prosysopc.ua.pubsub

Interface PubSubBrokerConnectionConf<T extends PubSubReaderGroupConf<?>,S extends PubSubWriterGroupConf<?>>

All Superinterfaces:

PubSubConf, PubSubConnectionConf<T,S>, PubSubNamedConf

All Known Implementing Classes:

PubSubMqttJsonConnectionConf, PubSubMqttUadpConnectionConf

public interface PubSubBrokerConnectionConf<T extends PubSubReaderGroupConf<?>,S extends PubSubWriterGroupConf<?>>
extends PubSubConnectionConf<T,S>

Common settings for PubSub broker-based connection configuration. NOTE! This interface should be considered as sealed, i.e. only implementations within the SDK are supported. All implementations are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PubSubBrokerConnectionConf.Builder<T extends PubSubBrokerConnectionConf.Builder<T>> Builder for setting common parts of a pubsub broker-based connection conf.

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

PubSubConf.MapKind<T>

Method Summary

Modifier and Type	Method and Description
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	getNetworkAddress() Will listen on this.
Boolean	isDisableMqttRetain()
Boolean	isEnableStatusMessage() If true, sends 'Status' message as defined in OPC UA 1.05 Part 14 7.3.5.7.
PubSubBrokerConnectionConf<T,S>	withAuthConf(PubSubBrokerAuthConf authConf)
PubSubBrokerConnectionConf<T,S>	withDisableMqttRetain(Boolean disableMqttRetain)
PubSubBrokerConnectionConf<T,S>	withEnableStatusMessage(Boolean enableStatusMessage)
PubSubBrokerConnectionConf<T,S>	withNetworkAddress(String networkAddress)

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

getName, getPublisherId, getReaderGroups, getTransportProfile, getWriterGroups, isEnabled, withEnabled, withPublisherId

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

withName

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

get, get, specification, toBuilder, toMap, with, with, withAll

Method Detail

getAuthConf

PubSubBrokerAuthConf getAuthConf()

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

getMqttTopicTreePrefix

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

String getNetworkAddress()

Will listen on this.

isDisableMqttRetain

Boolean isDisableMqttRetain()

isEnableStatusMessage

Boolean isEnableStatusMessage()

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

withAuthConf

PubSubBrokerConnectionConf<T,S> withAuthConf(PubSubBrokerAuthConf authConf)

withDisableMqttRetain

PubSubBrokerConnectionConf<T,S> withDisableMqttRetain(Boolean disableMqttRetain)

withEnableStatusMessage

PubSubBrokerConnectionConf<T,S> withEnableStatusMessage(Boolean enableStatusMessage)

withNetworkAddress

PubSubBrokerConnectionConf<T,S> withNetworkAddress(String networkAddress)