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

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

All Implemented Interfaces:

PubSubConf.Builder<PubSubUdpUadpConnectionConf.Builder>, PubSubConnectionConf.Builder<PubSubUdpUadpConnectionConf.Builder>, PubSubNamedConf.Builder<PubSubUdpUadpConnectionConf.Builder>

Enclosing class:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected InetSocketAddress`	`discoveryNetworkAddress`
`protected Map<SocketOption<?>,Object>`	`discoverySocketOptions`
`protected Boolean`	`enabled`
`protected String`	`name`
`protected InetSocketAddress`	`networkAddress`
`protected PublisherId`	`publisherId`
`protected Map<String,PubSubUdpUadpReaderGroupConf>`	`readerGroups`
`protected Map<SocketOption<?>,Object>`	`socketOptions`
`protected Map<String,PubSubUdpUadpWriterGroupConf>`	`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
`PubSubUdpUadpConnectionConf.Builder`	`addOrReplaceGroup(PubSubGroupConf value)` Adds the given group to this connection.
`PubSubUdpUadpConnectionConf.Builder`	`addOrReplaceGroup(PubSubUdpUadpReaderGroupConf value)` Adds a Group to the conf or replaces any existing Group one with the same `PubSubUdpUadpReaderGroupConf.getName()`.
`PubSubUdpUadpConnectionConf.Builder`	`addOrReplaceGroup(PubSubUdpUadpWriterGroupConf value)` Adds a Group to the conf or replaces any existing Group one with the same `PubSubUdpUadpWriterGroupConf.getName()`.
`PubSubUdpUadpConnectionConf`	`build()` Returns an instance of `PubSubUdpUadpConnectionConf` with the values given to this builder.
`InetSocketAddress`	`getDiscoveryNetworkAddress()`
`Map<SocketOption<?>,Object>`	`getDiscoverySocketOptions()`
`String`	`getName()`
`InetSocketAddress`	`getNetworkAddress()`
`PublisherId`	`getPublisherId()`
`Map<String,PubSubUdpUadpReaderGroupConf>`	`getReaderGroups()`
`Map<SocketOption<?>,Object>`	`getSocketOptions()`
`PubSubTransportProfile`	`getTransportProfile()` Returns the TransportProfile (uri) of the (to be built) connection.
`Map<String,PubSubUdpUadpWriterGroupConf>`	`getWriterGroups()`
`Boolean`	`isEnabled()`
`<T> PubSubUdpUadpConnectionConf.Builder`	`putDiscoverySocketOptions(SocketOption<T> key, T value)` Puts the key-value pair for `PubSubUdpUadpConnectionConf.getDiscoverySocketOptions()`.
`<T> PubSubUdpUadpConnectionConf.Builder`	`putSocketOptions(SocketOption<T> key, T value)` Puts the key-value pair for `PubSubUdpUadpConnectionConf.getSocketOptions()`.
`PubSubUdpUadpConnectionConf.Builder`	`removeGroup(String name)` Removes group that has the given name, if one exist in this connection.
`PubSubUdpUadpConnectionConf.Builder`	`setDiscoveryNetworkAddress(InetSocketAddress discoveryNetworkAddress)` Set the value for `PubSubUdpUadpConnectionConf.getDiscoveryNetworkAddress()`.
`PubSubUdpUadpConnectionConf.Builder`	`setEnabled(Boolean enabled)` Set the value for `PubSubUdpUadpConnectionConf#getEnabled()`.
`PubSubUdpUadpConnectionConf.Builder`	`setName(String name)` Set the value for `PubSubUdpUadpConnectionConf.getName()`.
`PubSubUdpUadpConnectionConf.Builder`	`setNetworkAddress(InetSocketAddress networkAddress)` Set the value for `PubSubUdpUadpConnectionConf.getNetworkAddress()`.
`PubSubUdpUadpConnectionConf.Builder`	`setNetworkInterface(NetworkInterface networkInterface)` Convenience method for calling `#putSocketOptions(StandardSocketOptions.IP_MULTICAST_IF, networkInterface)`.
`PubSubUdpUadpConnectionConf.Builder`	`setNetworkInterface(String interfaceName)` Convenience method for calling `setNetworkInterface(NetworkInterface)`, throws `IllegalArgumentException` if it cannot be resolved.
`PubSubUdpUadpConnectionConf.Builder`	`setPublisherId(PublisherId publisherId)` Set the value for `PubSubUdpUadpConnectionConf.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
```
  - discoveryNetworkAddress
```
protected InetSocketAddress discoveryNetworkAddress
```
  - discoverySocketOptions
```
protected Map<SocketOption<?>,Object> discoverySocketOptions
```
  - networkAddress
```
protected InetSocketAddress networkAddress
```
  - socketOptions
```
protected Map<SocketOption<?>,Object> socketOptions
```
  - readerGroups
```
protected Map<String,PubSubUdpUadpReaderGroupConf> readerGroups
```
  - writerGroups
```
protected Map<String,PubSubUdpUadpWriterGroupConf> writerGroups
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - addOrReplaceGroup
```
public PubSubUdpUadpConnectionConf.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.
  - setNetworkInterface
```
public PubSubUdpUadpConnectionConf.Builder setNetworkInterface(NetworkInterface networkInterface)
```
    Convenience method for calling #putSocketOptions(StandardSocketOptions.IP_MULTICAST_IF, networkInterface).
  - setNetworkInterface
```
public PubSubUdpUadpConnectionConf.Builder setNetworkInterface(String interfaceName)
```
    Convenience method for calling setNetworkInterface(NetworkInterface), throws IllegalArgumentException if it cannot be resolved.
  - 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<PubSubUdpUadpConnectionConf.Builder>
  - getName
```
public String getName()
```
  - getPublisherId
```
public PublisherId getPublisherId()
```
  - isEnabled
```
public Boolean isEnabled()
```
  - getDiscoveryNetworkAddress
```
public InetSocketAddress getDiscoveryNetworkAddress()
```
  - getDiscoverySocketOptions
```
public Map<SocketOption<?>,Object> getDiscoverySocketOptions()
```
  - getNetworkAddress
```
public InetSocketAddress getNetworkAddress()
```
  - getSocketOptions
```
public Map<SocketOption<?>,Object> getSocketOptions()
```
  - getReaderGroups
```
public Map<String,PubSubUdpUadpReaderGroupConf> getReaderGroups()
```
  - getWriterGroups
```
public Map<String,PubSubUdpUadpWriterGroupConf> getWriterGroups()
```
  - setName
```
public PubSubUdpUadpConnectionConf.Builder setName(String name)
```
    Set the value for PubSubUdpUadpConnectionConf.getName(). Returns itself for method chaining.
    
    Specified by:
    
    setName in interface PubSubNamedConf.Builder<PubSubUdpUadpConnectionConf.Builder>
  - setPublisherId
```
public PubSubUdpUadpConnectionConf.Builder setPublisherId(PublisherId publisherId)
```
    Set the value for PubSubUdpUadpConnectionConf.getPublisherId(). Returns itself for method chaining.
    
    Specified by:
    
    setPublisherId in interface PubSubConnectionConf.Builder<PubSubUdpUadpConnectionConf.Builder>
  - setEnabled
```
public PubSubUdpUadpConnectionConf.Builder setEnabled(Boolean enabled)
```
    Set the value for PubSubUdpUadpConnectionConf#getEnabled(). Returns itself for method chaining.
    
    Specified by:
    
    setEnabled in interface PubSubConnectionConf.Builder<PubSubUdpUadpConnectionConf.Builder>
  - setDiscoveryNetworkAddress
```
public PubSubUdpUadpConnectionConf.Builder setDiscoveryNetworkAddress(InetSocketAddress discoveryNetworkAddress)
```
    Set the value for PubSubUdpUadpConnectionConf.getDiscoveryNetworkAddress(). Returns itself for method chaining.
  - putDiscoverySocketOptions
```
public <T> PubSubUdpUadpConnectionConf.Builder putDiscoverySocketOptions(SocketOption<T> key,
                                                                         T value)
```
    Puts the key-value pair for PubSubUdpUadpConnectionConf.getDiscoverySocketOptions(). Returns itself for method chaining.
  - setNetworkAddress
```
public PubSubUdpUadpConnectionConf.Builder setNetworkAddress(InetSocketAddress networkAddress)
```
    Set the value for PubSubUdpUadpConnectionConf.getNetworkAddress(). Returns itself for method chaining.
  - putSocketOptions
```
public <T> PubSubUdpUadpConnectionConf.Builder putSocketOptions(SocketOption<T> key,
                                                                T value)
```
    Puts the key-value pair for PubSubUdpUadpConnectionConf.getSocketOptions(). Returns itself for method chaining.
  - addOrReplaceGroup
```
public PubSubUdpUadpConnectionConf.Builder addOrReplaceGroup(PubSubUdpUadpReaderGroupConf value)
```
    Adds a Group to the conf or replaces any existing Group one with the same PubSubUdpUadpReaderGroupConf.getName().
  - addOrReplaceGroup
```
public PubSubUdpUadpConnectionConf.Builder addOrReplaceGroup(PubSubUdpUadpWriterGroupConf value)
```
    Adds a Group to the conf or replaces any existing Group one with the same PubSubUdpUadpWriterGroupConf.getName().
  - build
```
public PubSubUdpUadpConnectionConf build()
```
    Returns an instance of PubSubUdpUadpConnectionConf with the values given to this builder.
    
    Specified by:
    
    build in interface PubSubConf.Builder<PubSubUdpUadpConnectionConf.Builder>
    
    Specified by:
    
    build in interface PubSubConnectionConf.Builder<PubSubUdpUadpConnectionConf.Builder>
  - removeGroup
```
public PubSubUdpUadpConnectionConf.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<PubSubUdpUadpConnectionConf.Builder>

Class PubSubUdpUadpConnectionConf.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

discoveryNetworkAddress

discoverySocketOptions

networkAddress

socketOptions

readerGroups

writerGroups

Constructor Detail

Builder

Method Detail

addOrReplaceGroup

getTransportProfile

setNetworkInterface

setNetworkInterface

specification

getName

getPublisherId

isEnabled

getDiscoveryNetworkAddress

getDiscoverySocketOptions

getNetworkAddress

getSocketOptions

getReaderGroups

getWriterGroups

setName

setPublisherId

setEnabled

setDiscoveryNetworkAddress

putDiscoverySocketOptions

setNetworkAddress

putSocketOptions

addOrReplaceGroup

addOrReplaceGroup

build

removeGroup