com.prosysopc.ua.pubsub

Class PubSubMqttUadpWriterGroupConf

java.lang.Object

com.prosysopc.ua.pubsub.PubSubMqttUadpWriterGroupConf

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf, PubSubConf, PubSubGroupConf, PubSubNamedConf, PubSubUadpWriterGroupConf<PubSubMqttUadpDataSetWriterConf>, PubSubWriterGroupConf<PubSubMqttUadpDataSetWriterConf>

public final class PubSubMqttUadpWriterGroupConf
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubMqttUadpWriterGroupConf.Builder Builder for PubSubMqttUadpWriterGroupConf.
static class	PubSubMqttUadpWriterGroupConf.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 PubSubMqttUadpWriterGroupConf.Builder	builder() Returns a new PubSubMqttUadpWriterGroupConf.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
DataSetOrderingType	getDataSetOrdering()
UnsignedInteger	getGroupVersion()
Duration	getKeepAliveTime()
List<String>	getLocaleIds()
UnsignedInteger	getMaxNetworkMessageSize()
UadpNetworkMessageContentMask	getMessageContentMask()
String	getMetaDataQueueName() Defines the Broker's queuename for the metadata.
Duration	getMetaDataUpdateTime() Configures how often the Metadata is updated to the getMetaDataQueueName().
String	getName() Returns the name of the PubSubGroup.
UnsignedByte	getPriority()
Duration	getPublishingInterval()
PubSubPublishingOffsets	getPublishingOffset()
String	getQueueName() Defines the Broker's queuename for the data.
BrokerTransportQualityOfService	getRequestedDeliveryGuarantee()
Duration	getSamplingOffset()
PubSubSecurityConf	getSecurityConf() Returns configuration related to message security.
PubSubTransportProfile	getTransportProfile() Returns the TransportProfile (uri) of the connection where this group is or is to be added.
UnsignedShort	getWriterGroupId()
Map<String,PubSubMqttUadpDataSetWriterConf>	getWriters()
int	hashCode()
Boolean	isEnabled() Returns the enabled state of the PubSubGroup.
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubMqttUadpWriterGroupConf.Builder	toBuilder() Returns a new PubSubMqttUadpWriterGroupConf.Builder that is initialized with the state of this object.
String	toString()
PubSubMqttUadpWriterGroupConf	withDataSetOrdering(DataSetOrderingType dataSetOrdering)
PubSubMqttUadpWriterGroupConf	withEnabled(Boolean enabled)
PubSubMqttUadpWriterGroupConf	withGroupVersion(UnsignedInteger groupVersion)
PubSubMqttUadpWriterGroupConf	withKeepAliveTime(Duration keepAliveTime)
PubSubMqttUadpWriterGroupConf	withMaxNetworkMessageSize(UnsignedInteger maxNetworkMessageSize)
PubSubMqttUadpWriterGroupConf	withMessageContentMask(UadpNetworkMessageContentMask messageContentMask)
PubSubMqttUadpWriterGroupConf	withMetaDataQueueName(String metaDataQueueName)
PubSubMqttUadpWriterGroupConf	withMetaDataUpdateTime(Duration metaDataUpdateTime)
PubSubMqttUadpWriterGroupConf	withName(String name) Convenience method for doing PubSubConf.toBuilder() + PubSubNamedConf.Builder.setName(String) + PubSubConf.Builder.build().
PubSubMqttUadpWriterGroupConf	withPriority(UnsignedByte priority)
PubSubMqttUadpWriterGroupConf	withPublishingInterval(Duration publishingInterval)
PubSubMqttUadpWriterGroupConf	withPublishingOffset(PubSubPublishingOffsets publishingOffset)
PubSubMqttUadpWriterGroupConf	withQueueName(String queueName)
PubSubMqttUadpWriterGroupConf	withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)
PubSubMqttUadpWriterGroupConf	withSamplingOffset(Duration samplingOffset)
PubSubMqttUadpWriterGroupConf	withSecurityConf(PubSubSecurityConf securityConf)
PubSubMqttUadpWriterGroupConf	withWriterAddedOrReplaced(PubSubMqttUadpDataSetWriterConf conf) Returns an instance similar to this, but with the Writer given as parameter added or replaced if any existing one had the PubSubMqttUadpDataSetWriterConf.getName().
PubSubMqttUadpWriterGroupConf	withWriterGroupId(UnsignedShort writerGroupId)
PubSubMqttUadpWriterGroupConf	withWriterRemoved(String name) Removes Writer 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, with, with, withAll

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.

getMetaDataQueueName

public String getMetaDataQueueName()

Defines the Broker's queuename for the metadata. IMPORTANT! For the Publisher i.e. Writer side this shall not be a wildcard. Can be a wildcard for the Subscriber i.e. Reader side.

getMetaDataUpdateTime

public Duration getMetaDataUpdateTime()

Configures how often the Metadata is updated to the getMetaDataQueueName().

getQueueName

public String getQueueName()

Defines the Broker's queuename for the data. IMPORTANT! For the Publisher i.e. Writer side this shall not be a wildcard. Can be a wildcard for the Subscriber i.e. Reader side.

getRequestedDeliveryGuarantee

public BrokerTransportQualityOfService getRequestedDeliveryGuarantee()

getMaxNetworkMessageSize

public UnsignedInteger getMaxNetworkMessageSize()

getName

public String getName()

Returns the name of the PubSubGroup. The name shall be unique across all reader and writer groups of a PubSubConnection.

getSecurityConf

public PubSubSecurityConf getSecurityConf()

Returns configuration related to message security.

isEnabled

public Boolean isEnabled()

Returns the enabled state of the PubSubGroup.

getKeepAliveTime

public Duration getKeepAliveTime()

getLocaleIds

public List<String> getLocaleIds()

getPriority

public UnsignedByte getPriority()

getPublishingInterval

public Duration getPublishingInterval()

getWriterGroupId

public UnsignedShort getWriterGroupId()

getDataSetOrdering

public DataSetOrderingType getDataSetOrdering()

getGroupVersion

public UnsignedInteger getGroupVersion()

getMessageContentMask

public UadpNetworkMessageContentMask getMessageContentMask()

getPublishingOffset

public PubSubPublishingOffsets getPublishingOffset()

getSamplingOffset

public Duration getSamplingOffset()

getWriters

public Map<String,PubSubMqttUadpDataSetWriterConf> getWriters()

withWriterRemoved

public PubSubMqttUadpWriterGroupConf withWriterRemoved(String name)

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

withWriterAddedOrReplaced

public PubSubMqttUadpWriterGroupConf withWriterAddedOrReplaced(PubSubMqttUadpDataSetWriterConf conf)

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

withMetaDataQueueName

public PubSubMqttUadpWriterGroupConf withMetaDataQueueName(String metaDataQueueName)

withMetaDataUpdateTime

public PubSubMqttUadpWriterGroupConf withMetaDataUpdateTime(Duration metaDataUpdateTime)

withQueueName

public PubSubMqttUadpWriterGroupConf withQueueName(String queueName)

withRequestedDeliveryGuarantee

public PubSubMqttUadpWriterGroupConf withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)

withMaxNetworkMessageSize

public PubSubMqttUadpWriterGroupConf withMaxNetworkMessageSize(UnsignedInteger maxNetworkMessageSize)

withName

public PubSubMqttUadpWriterGroupConf withName(String name)

Description copied from interface: PubSubNamedConf

Convenience method for doing PubSubConf.toBuilder() + PubSubNamedConf.Builder.setName(String) + PubSubConf.Builder.build().

withSecurityConf

public PubSubMqttUadpWriterGroupConf withSecurityConf(PubSubSecurityConf securityConf)

withEnabled

public PubSubMqttUadpWriterGroupConf withEnabled(Boolean enabled)

withKeepAliveTime

public PubSubMqttUadpWriterGroupConf withKeepAliveTime(Duration keepAliveTime)

withPriority

public PubSubMqttUadpWriterGroupConf withPriority(UnsignedByte priority)

withPublishingInterval

public PubSubMqttUadpWriterGroupConf withPublishingInterval(Duration publishingInterval)

withWriterGroupId

public PubSubMqttUadpWriterGroupConf withWriterGroupId(UnsignedShort writerGroupId)

withDataSetOrdering

public PubSubMqttUadpWriterGroupConf withDataSetOrdering(DataSetOrderingType dataSetOrdering)

withGroupVersion

public PubSubMqttUadpWriterGroupConf withGroupVersion(UnsignedInteger groupVersion)

withMessageContentMask

public PubSubMqttUadpWriterGroupConf withMessageContentMask(UadpNetworkMessageContentMask messageContentMask)

withPublishingOffset

public PubSubMqttUadpWriterGroupConf withPublishingOffset(PubSubPublishingOffsets publishingOffset)

withSamplingOffset

public PubSubMqttUadpWriterGroupConf withSamplingOffset(Duration samplingOffset)

builder

public static PubSubMqttUadpWriterGroupConf.Builder builder()

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

toBuilder

public PubSubMqttUadpWriterGroupConf.Builder toBuilder()

Returns a new PubSubMqttUadpWriterGroupConf.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: PubSubGroupConf

Returns the TransportProfile (uri) of the connection where this group is or is to be added. This defines both the transport and encoding of the group.

Specified by:

getTransportProfile in interface PubSubGroupConf