PubSubMqttUadpConnectionConf.Builder (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.pubsub.PubSubMqttUadpConnectionConf.Builder

All Implemented Interfaces:

PubSubBrokerConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>, PubSubConf.Builder<PubSubMqttUadpConnectionConf.Builder>, PubSubConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>, PubSubNamedConf.Builder<PubSubMqttUadpConnectionConf.Builder>

Enclosing class:

PubSubMqttUadpConnectionConf
```
public static final class PubSubMqttUadpConnectionConf.Builder
extends Object
```
Builder for PubSubMqttUadpConnectionConf.

Field Summary

Fields
Modifier and Type	Field and Description
`protected PubSubBrokerAuthConf`	`authConf`
`protected Boolean`	`disableMqttRetain`
`protected Boolean`	`enabled`
`protected Boolean`	`enableStatusMessage`
`protected String`	`mqttTopicTreePrefix`
`protected String`	`name`
`protected String`	`networkAddress`
`protected PublisherId`	`publisherId`
`protected Map<String,PubSubMqttUadpReaderGroupConf>`	`readerGroups`
`protected Map<String,PubSubMqttUadpWriterGroupConf>`	`writerGroups`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Builder()

Constructors
Modifier	Constructor and Description
`protected`	`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PubSubMqttUadpConnectionConf.Builder`	`addOrReplaceGroup(PubSubGroupConf value)` Adds the given group to this connection.
`PubSubMqttUadpConnectionConf.Builder`	`addOrReplaceGroup(PubSubMqttUadpReaderGroupConf value)` Adds a Group to the conf or replaces any existing Group one with the same `PubSubMqttUadpReaderGroupConf.getName()`.
`PubSubMqttUadpConnectionConf.Builder`	`addOrReplaceGroup(PubSubMqttUadpWriterGroupConf value)` Adds a Group to the conf or replaces any existing Group one with the same `PubSubMqttUadpWriterGroupConf.getName()`.
`PubSubMqttUadpConnectionConf`	`build()` Returns an instance of `PubSubMqttUadpConnectionConf` with the values given to this builder.
`PubSubBrokerAuthConf`	`getAuthConf()`
`String`	`getMqttTopicTreePrefix()`
`String`	`getName()`
`String`	`getNetworkAddress()`
`PublisherId`	`getPublisherId()`
`Map<String,PubSubMqttUadpReaderGroupConf>`	`getReaderGroups()`
`PubSubTransportProfile`	`getTransportProfile()` Returns the TransportProfile (uri) of the (to be built) connection.
`Map<String,PubSubMqttUadpWriterGroupConf>`	`getWriterGroups()`
`Boolean`	`isDisableMqttRetain()`
`Boolean`	`isEnabled()`
`Boolean`	`isEnableStatusMessage()`
`PubSubMqttUadpConnectionConf.Builder`	`removeGroup(String name)` Removes group that has the given name, if one exist in this connection.
`PubSubMqttUadpConnectionConf.Builder`	`setAuthConf(PubSubBrokerAuthConf authConf)` Set the value for `PubSubMqttUadpConnectionConf.getAuthConf()`.
`PubSubMqttUadpConnectionConf.Builder`	`setDisableMqttRetain(Boolean disableMqttRetain)` Set the value for `PubSubMqttUadpConnectionConf#getDisableMqttRetain()`.
`PubSubMqttUadpConnectionConf.Builder`	`setEnabled(Boolean enabled)` Set the value for `PubSubMqttUadpConnectionConf#getEnabled()`.
`PubSubMqttUadpConnectionConf.Builder`	`setEnableStatusMessage(Boolean enableStatusMessage)` Set the value for `PubSubMqttUadpConnectionConf#getEnableStatusMessage()`.
`PubSubMqttUadpConnectionConf.Builder`	`setMqttTopicTreePrefix(String mqttTopicTreePrefix)` Set the value for `PubSubMqttUadpConnectionConf.getMqttTopicTreePrefix()`.
`PubSubMqttUadpConnectionConf.Builder`	`setName(String name)` Set the value for `PubSubMqttUadpConnectionConf.getName()`.
`PubSubMqttUadpConnectionConf.Builder`	`setNetworkAddress(String networkAddress)` Set the value for `PubSubMqttUadpConnectionConf.getNetworkAddress()`.
`PubSubMqttUadpConnectionConf.Builder`	`setPublisherId(PublisherId publisherId)` Set the value for `PubSubMqttUadpConnectionConf.getPublisherId()`.
`PubSubConfSpecification`	`specification()` Returns the specification of this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf.Builder
get, get, set, set, setAll

- Field Detail
  - name
```
protected String name
```
  - publisherId
```
protected PublisherId publisherId
```
  - enabled
```
protected Boolean enabled
```
  - authConf
```
protected PubSubBrokerAuthConf authConf
```
  - mqttTopicTreePrefix
```
protected String mqttTopicTreePrefix
```
  - networkAddress
```
protected String networkAddress
```
  - disableMqttRetain
```
protected Boolean disableMqttRetain
```
  - enableStatusMessage
```
protected Boolean enableStatusMessage
```
  - readerGroups
```
protected Map<String,PubSubMqttUadpReaderGroupConf> readerGroups
```
  - writerGroups
```
protected Map<String,PubSubMqttUadpWriterGroupConf> writerGroups
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - addOrReplaceGroup
```
public PubSubMqttUadpConnectionConf.Builder addOrReplaceGroup(PubSubGroupConf value)
```
    Description copied from interface: PubSubConnectionConf.Builder
    
    Adds the given group to this connection. Important! The given group must be of equal PubSubTransportProfile implementation as this connection (e.g. UDP-UADP WriterGroup for UDP-UADP Connection), otherwise throws IllegalArgumentException. Replaces any existing Group with the same name as the given one.
  - getTransportProfile
```
public final PubSubTransportProfile getTransportProfile()
```
    Description copied from interface: PubSubConnectionConf.Builder
    
    Returns the TransportProfile (uri) of the (to be built) connection. This defines both the transport and encoding of the connection.
  - specification
```
public PubSubConfSpecification specification()
```
    Description copied from interface: PubSubConf.Builder
    
    Returns the specification of this object. Can be used to dynamically set the fields of the PubSubConf object.
    
    Specified by:
    
    specification in interface PubSubConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - getName
```
public String getName()
```
  - getPublisherId
```
public PublisherId getPublisherId()
```
  - isEnabled
```
public Boolean isEnabled()
```
  - getAuthConf
```
public PubSubBrokerAuthConf getAuthConf()
```
  - getMqttTopicTreePrefix
```
public String getMqttTopicTreePrefix()
```
  - getNetworkAddress
```
public String getNetworkAddress()
```
  - isDisableMqttRetain
```
public Boolean isDisableMqttRetain()
```
  - isEnableStatusMessage
```
public Boolean isEnableStatusMessage()
```
  - getReaderGroups
```
public Map<String,PubSubMqttUadpReaderGroupConf> getReaderGroups()
```
  - getWriterGroups
```
public Map<String,PubSubMqttUadpWriterGroupConf> getWriterGroups()
```
  - setName
```
public PubSubMqttUadpConnectionConf.Builder setName(String name)
```
    Set the value for PubSubMqttUadpConnectionConf.getName(). Returns itself for method chaining.
    
    Specified by:
    
    setName in interface PubSubNamedConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - setPublisherId
```
public PubSubMqttUadpConnectionConf.Builder setPublisherId(PublisherId publisherId)
```
    Set the value for PubSubMqttUadpConnectionConf.getPublisherId(). Returns itself for method chaining.
    
    Specified by:
    
    setPublisherId in interface PubSubConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - setEnabled
```
public PubSubMqttUadpConnectionConf.Builder setEnabled(Boolean enabled)
```
    Set the value for PubSubMqttUadpConnectionConf#getEnabled(). Returns itself for method chaining.
    
    Specified by:
    
    setEnabled in interface PubSubConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - setAuthConf
```
public PubSubMqttUadpConnectionConf.Builder setAuthConf(PubSubBrokerAuthConf authConf)
```
    Set the value for PubSubMqttUadpConnectionConf.getAuthConf(). Returns itself for method chaining.
    
    Specified by:
    
    setAuthConf in interface PubSubBrokerConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - setMqttTopicTreePrefix
```
public PubSubMqttUadpConnectionConf.Builder setMqttTopicTreePrefix(String mqttTopicTreePrefix)
```
    Set the value for PubSubMqttUadpConnectionConf.getMqttTopicTreePrefix(). Returns itself for method chaining.
  - setNetworkAddress
```
public PubSubMqttUadpConnectionConf.Builder setNetworkAddress(String networkAddress)
```
    Set the value for PubSubMqttUadpConnectionConf.getNetworkAddress(). Returns itself for method chaining.
    
    Specified by:
    
    setNetworkAddress in interface PubSubBrokerConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - setDisableMqttRetain
```
public PubSubMqttUadpConnectionConf.Builder setDisableMqttRetain(Boolean disableMqttRetain)
```
    Set the value for PubSubMqttUadpConnectionConf#getDisableMqttRetain(). Returns itself for method chaining.
    
    Specified by:
    
    setDisableMqttRetain in interface PubSubBrokerConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - setEnableStatusMessage
```
public PubSubMqttUadpConnectionConf.Builder setEnableStatusMessage(Boolean enableStatusMessage)
```
    Set the value for PubSubMqttUadpConnectionConf#getEnableStatusMessage(). Returns itself for method chaining.
    
    Specified by:
    
    setEnableStatusMessage in interface PubSubBrokerConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - addOrReplaceGroup
```
public PubSubMqttUadpConnectionConf.Builder addOrReplaceGroup(PubSubMqttUadpReaderGroupConf value)
```
    Adds a Group to the conf or replaces any existing Group one with the same PubSubMqttUadpReaderGroupConf.getName().
  - addOrReplaceGroup
```
public PubSubMqttUadpConnectionConf.Builder addOrReplaceGroup(PubSubMqttUadpWriterGroupConf value)
```
    Adds a Group to the conf or replaces any existing Group one with the same PubSubMqttUadpWriterGroupConf.getName().
  - build
```
public PubSubMqttUadpConnectionConf build()
```
    Returns an instance of PubSubMqttUadpConnectionConf with the values given to this builder.
    
    Specified by:
    
    build in interface PubSubConf.Builder<PubSubMqttUadpConnectionConf.Builder>
    
    Specified by:
    
    build in interface PubSubConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>
  - removeGroup
```
public PubSubMqttUadpConnectionConf.Builder removeGroup(String name)
```
    Description copied from interface: PubSubConnectionConf.Builder
    
    Removes group that has the given name, if one exist in this connection.
    
    Specified by:
    
    removeGroup in interface PubSubConnectionConf.Builder<PubSubMqttUadpConnectionConf.Builder>

Class PubSubMqttUadpConnectionConf.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

name

publisherId

enabled

authConf

mqttTopicTreePrefix

networkAddress

disableMqttRetain

enableStatusMessage

readerGroups

writerGroups

Constructor Detail

Builder

Method Detail

addOrReplaceGroup

getTransportProfile

specification

getName

getPublisherId

isEnabled

getAuthConf

getMqttTopicTreePrefix

getNetworkAddress

isDisableMqttRetain

isEnableStatusMessage

getReaderGroups

getWriterGroups

setName

setPublisherId

setEnabled

setAuthConf

setMqttTopicTreePrefix

setNetworkAddress

setDisableMqttRetain

setEnableStatusMessage

addOrReplaceGroup

addOrReplaceGroup

build

removeGroup