com.prosysopc.ua.pubsub

Class PubSubMqttJsonDataSetReaderConf

java.lang.Object

com.prosysopc.ua.pubsub.PubSubMqttJsonDataSetReaderConf

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf, PubSubConf, PubSubDataSetReaderConf, PubSubJsonDataSetReaderConf, PubSubNamedConf

public final class PubSubMqttJsonDataSetReaderConf
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubMqttJsonDataSetReaderConf.Builder Builder for PubSubMqttJsonDataSetReaderConf.
static class	PubSubMqttJsonDataSetReaderConf.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 PubSubMqttJsonDataSetReaderConf.Builder	builder() Returns a new PubSubMqttJsonDataSetReaderConf.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
UUID	getDataSetClassId()
UnsignedShort	getDataSetWriterId()
DataSetFieldContentMask	getFieldContentMask()
JsonDataSetMessageContentMask	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 PubSub component.
PublisherId	getPublisherId()
String	getQueueName() Defines the Broker's queuename for the data.
BrokerTransportQualityOfService	getRequestedDeliveryGuarantee()
PubSubSecurityConf	getSecurityConf()
PubSubTargetVariablesConf	getSubscribedDataSet()
PubSubTransportProfile	getTransportProfile() Returns the TransportProfile (uri) of the reader group where this reader is or is to be added.
UnsignedShort	getWriterGroupId()
int	hashCode()
Boolean	isEnabled()
Boolean	isIgnoreMissingMetaData() If true (the default) and if the DataSetMetaData for the dataset this reader is reading is missing: the JSON message is taken as-is for the fields of the message.
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubMqttJsonDataSetReaderConf.Builder	toBuilder() Returns a new PubSubMqttJsonDataSetReaderConf.Builder that is initialized with the state of this object.
String	toString()
PubSubMqttJsonDataSetReaderConf	withDataSetClassId(UUID dataSetClassId)
PubSubMqttJsonDataSetReaderConf	withDataSetWriterId(UnsignedShort dataSetWriterId)
PubSubMqttJsonDataSetReaderConf	withEnabled(Boolean enabled)
PubSubMqttJsonDataSetReaderConf	withFieldContentMask(DataSetFieldContentMask fieldContentMask)
PubSubMqttJsonDataSetReaderConf	withIgnoreMissingMetaData(Boolean ignoreMissingMetaData)
PubSubMqttJsonDataSetReaderConf	withMessageContentMask(JsonDataSetMessageContentMask messageContentMask)
PubSubMqttJsonDataSetReaderConf	withMetaDataQueueName(String metaDataQueueName)
PubSubMqttJsonDataSetReaderConf	withMetaDataUpdateTime(Duration metaDataUpdateTime)
PubSubMqttJsonDataSetReaderConf	withName(String name) Convenience method for doing PubSubConf.toBuilder() + PubSubNamedConf.Builder.setName(String) + PubSubConf.Builder.build().
PubSubMqttJsonDataSetReaderConf	withPublisherId(PublisherId publisherId)
PubSubMqttJsonDataSetReaderConf	withQueueName(String queueName)
PubSubMqttJsonDataSetReaderConf	withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)
PubSubMqttJsonDataSetReaderConf	withSecurityConf(PubSubSecurityConf securityConf)
PubSubMqttJsonDataSetReaderConf	withSubscribedDataSet(PubSubTargetVariablesConf subscribedDataSet)
PubSubMqttJsonDataSetReaderConf	withWriterGroupId(UnsignedShort writerGroupId)

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.

getName

public String getName()

Returns the name of the PubSub component. This name is unique within some context.

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()

getDataSetClassId

public UUID getDataSetClassId()

getDataSetWriterId

public UnsignedShort getDataSetWriterId()

getPublisherId

public PublisherId getPublisherId()

getSecurityConf

public PubSubSecurityConf getSecurityConf()

getSubscribedDataSet

public PubSubTargetVariablesConf getSubscribedDataSet()

getWriterGroupId

public UnsignedShort getWriterGroupId()

isEnabled

public Boolean isEnabled()

getFieldContentMask

public DataSetFieldContentMask getFieldContentMask()

getMessageContentMask

public JsonDataSetMessageContentMask getMessageContentMask()

isIgnoreMissingMetaData

public Boolean isIgnoreMissingMetaData()

If true (the default) and if the DataSetMetaData for the dataset this reader is reading is missing: the JSON message is taken as-is for the fields of the message. If the metadata exists only the fields defined in that are taken from the message. If false, the reader wont process the message if the metadata is missing.

withName

public PubSubMqttJsonDataSetReaderConf withName(String name)

Description copied from interface: PubSubNamedConf

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

withMetaDataQueueName

public PubSubMqttJsonDataSetReaderConf withMetaDataQueueName(String metaDataQueueName)

withMetaDataUpdateTime

public PubSubMqttJsonDataSetReaderConf withMetaDataUpdateTime(Duration metaDataUpdateTime)

withQueueName

public PubSubMqttJsonDataSetReaderConf withQueueName(String queueName)

withRequestedDeliveryGuarantee

public PubSubMqttJsonDataSetReaderConf withRequestedDeliveryGuarantee(BrokerTransportQualityOfService requestedDeliveryGuarantee)

withDataSetClassId

public PubSubMqttJsonDataSetReaderConf withDataSetClassId(UUID dataSetClassId)

withDataSetWriterId

public PubSubMqttJsonDataSetReaderConf withDataSetWriterId(UnsignedShort dataSetWriterId)

withPublisherId

public PubSubMqttJsonDataSetReaderConf withPublisherId(PublisherId publisherId)

withSecurityConf

public PubSubMqttJsonDataSetReaderConf withSecurityConf(PubSubSecurityConf securityConf)

withSubscribedDataSet

public PubSubMqttJsonDataSetReaderConf withSubscribedDataSet(PubSubTargetVariablesConf subscribedDataSet)

withWriterGroupId

public PubSubMqttJsonDataSetReaderConf withWriterGroupId(UnsignedShort writerGroupId)

withEnabled

public PubSubMqttJsonDataSetReaderConf withEnabled(Boolean enabled)

withFieldContentMask

public PubSubMqttJsonDataSetReaderConf withFieldContentMask(DataSetFieldContentMask fieldContentMask)

withMessageContentMask

public PubSubMqttJsonDataSetReaderConf withMessageContentMask(JsonDataSetMessageContentMask messageContentMask)

withIgnoreMissingMetaData

public PubSubMqttJsonDataSetReaderConf withIgnoreMissingMetaData(Boolean ignoreMissingMetaData)

builder

public static PubSubMqttJsonDataSetReaderConf.Builder builder()

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

toBuilder

public PubSubMqttJsonDataSetReaderConf.Builder toBuilder()

Returns a new PubSubMqttJsonDataSetReaderConf.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: PubSubDataSetReaderConf

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

Specified by:

getTransportProfile in interface PubSubDataSetReaderConf