Package com.prosysopc.ua.pubsub

PubSub (Part 14 of the OPC UA Specification) related implementations.

See: Description

Interface Summary

Interface	Description
PubSubBiFunction<T,S,R>	Similar to BiFunction, but can throw a PubSubException on error.
PubSubBrokerConnectionConf<T extends PubSubReaderGroupConf<?>,S extends PubSubWriterGroupConf<?>>	Common settings for PubSub broker-based connection configuration.
PubSubBrokerConnectionConf.Builder<T extends PubSubBrokerConnectionConf.Builder<T>>	Builder for setting common parts of a pubsub broker-based connection conf.
PubSubBrokerCredentials	Internal interface.
PubSubBrokerCredentials.Builder<T extends PubSubBrokerCredentials.Builder<T>>	Internal interface.
PubSubBrokerTransportSettingsConf	An interface combining Broker-based TransportSettings.
PubSubBrokerTransportSettingsConf.Builder<T extends PubSubBrokerTransportSettingsConf.Builder<T>>	Builder for Broker-based TransportSettings.
PubSubConf	Super-interface for all PubSub configuration interfaces and objects.
PubSubConf.Builder<T extends PubSubConf.Builder<T>>	Super interface for all Builders of all PubSubConfs.
PubSubConnectionCommands	Contains PubSubSystemCommands related to connections.
PubSubConnectionConf<T extends PubSubReaderGroupConf<?>,S extends PubSubWriterGroupConf<?>>	Common settings for PubSub connection configuration.
PubSubConnectionConf.Builder<T extends PubSubConnectionConf.Builder<T>>	Builder for setting common parts of a pubsub connection conf.
PubSubDatagramChannelWrapper	A wrapper for DatagramChannel or anything that can be made to same abstraction.
PubSubDataSetConf	Common settings for DataSets.
PubSubDataSetConf.Builder<T extends PubSubDataSetConf.Builder<T>>	Builder for common settings of DataSets.
PubSubDataSetMessage	Interface grouping common values in all PubSub DataSetMessages.
PubSubDataSetMessage.Builder<T extends PubSubDataSetMessage.Builder<T>>	Builder for the common settings part.
PubSubDataSetMessageReceivedEvent	Common base for events when a DataSet Reader receives a message.
PubSubDataSetMessageReceivedEvent.Builder<T extends PubSubDataSetMessageReceivedEvent.Builder<T>>	Internal interface.
PubSubDataSetMetaDataMessage	Common parts of a PubSub DataSetMetaDataMessage.
PubSubDataSetMetaDataMessage.Builder<T extends PubSubDataSetMetaDataMessage.Builder<T>>	Builder for common parts of a PubSub DataSetMetaDataMessage.
PubSubDataSetMetaDataMessageReceivedEvent	Common interface for PubSubSystemEvents where a DataSetMetaData message has been received.
PubSubDataSetMetaDataMessageReceivedEvent.Builder<T extends PubSubDataSetMetaDataMessageReceivedEvent.Builder<T>>	Internal interface.
PubSubDataSetReaderConf	Common settings for DataSetReaders.
PubSubDataSetReaderConf.Builder<T extends PubSubDataSetReaderConf.Builder<T>>	Builder for common settings of DataSetReaders.
PubSubDataSetWriterConf	Common settings for DataSetWriters.
PubSubDataSetWriterConf.Builder<T extends PubSubDataSetWriterConf.Builder<T>>	Common builder for DataSetWriter settings.
PubSubFailureEvent	A common interface for error-related PubSubSystemEvents.
PubSubFailureEvent.Builder<T extends PubSubFailureEvent.Builder<T>>	Internal interface.
PubSubFunction<T,R>	Similar to Function, but can throw a PubSubException on error.
PubSubGroupConf	Common settings for PubSub Groups.
PubSubGroupConf.Builder<T extends PubSubGroupConf.Builder<T>>	Builder for common settings for PubSub Groups.
PubSubJsonDataSetReaderConf	Common settings for DataSetReaders that deal with JSON encoded messages.
PubSubJsonDataSetReaderConf.Builder<T extends PubSubJsonDataSetReaderConf.Builder<T>>	Builder for common settings of DataSetReaders.
PubSubJsonDataSetWriterConf	Common settings for DataSetWriters that deal with JSON encoded messages.
PubSubJsonDataSetWriterConf.Builder<T extends PubSubJsonDataSetWriterConf.Builder<T>>	Common builder for JSON DataSetWriter settings.
PubSubJsonEvents	Holds JSON related event types for a PubSubSystem as static constants, see class PubSubEvents for all event types.
PubSubJsonMessageContent	Defines common parts for json messages.
PubSubJsonMessageContent.Builder<T extends PubSubJsonMessageContent.Builder<T>>	Defines a builder for common parts of json messages.
PubSubJsonReaderGroupConf<T extends PubSubJsonDataSetReaderConf>	Common settings for PubSub ReaderGroups that deal with JSON message encodings.
PubSubJsonReaderGroupConf.Builder<T extends PubSubJsonReaderGroupConf.Builder<T>>	Builder for common settings for PubSub JSON ReaderGroups.
PubSubJsonWriterGroupConf<T extends PubSubJsonDataSetWriterConf>	Common settings for PubSub WriterGroups that deal with JSON message encodings.
PubSubJsonWriterGroupConf.Builder<T extends PubSubJsonWriterGroupConf.Builder<T>>	Builder for common settings for PubSub JSON WriterGroups.
PubSubMqttConnectionCommands	MQTT-connection specific PubSubSystemCommands.
PubSubMqttEvents	Holds MQTT related event types for a PubSubSystem as static constants, see class PubSubEvents for all event types.
PubSubNamedConf	A PubSub configuration object that has a name that is unique in some context.
PubSubNamedConf.Builder<T extends PubSubNamedConf.Builder<T>>	Builder for setting the name.
PubSubReaderGroupConf<T extends PubSubDataSetReaderConf>	Common settings for PubSub ReaderGroups.
PubSubReaderGroupConf.Builder<T extends PubSubReaderGroupConf.Builder<T>>	Builder for common settings for PubSub ReaderGroups.
PubSubStatusMessage	Interface grouping common values in all PubSub StatusMessages.
PubSubStatusMessage.Builder<T extends PubSubStatusMessage.Builder<T>>	Builder for the common part.
PubSubSystemCommand.Builder<T extends PubSubSystemCommand.Builder<T>>	Internal interface.
PubSubSystemEvent	Marker interface for all PubSub related events.
PubSubSystemEvent.Builder<T extends PubSubSystemEvent.Builder<T>>	Internal interface.
PubSubTriFunction<T,S,U,R>	Similar to PubSubBiFunction, but takes 3 parameters.
PubSubUadpDataSetReaderConf	Common settings for DataSetReaders that deal with UADP encoded messages.
PubSubUadpDataSetReaderConf.Builder<T extends PubSubUadpDataSetReaderConf.Builder<T>>	Builder for common settings of UADP DataSetReaders.
PubSubUadpDataSetWriterConf	Common settings for DataSetWriters that deal with UADP encoded messages.
PubSubUadpDataSetWriterConf.Builder<T extends PubSubUadpDataSetWriterConf.Builder<T>>	Common builder for UADP DataSetWriter settings.
PubSubUadpEvents	Holds UADP related event types for a PubSubSystem as static constants, see class PubSubEvents for all event types.
PubSubUadpMessageContent	Defines common parts for uadp messages.
PubSubUadpMessageContent.Builder<T extends PubSubUadpMessageContent.Builder<T>>	Defines a builder for common parts of uadp messages.
PubSubUadpReaderGroupConf<T extends PubSubUadpDataSetReaderConf>	Common settings for PubSub ReaderGroups that deal with UADP message encodings.
PubSubUadpReaderGroupConf.Builder<T extends PubSubUadpReaderGroupConf.Builder<T>>	Builder for common settings for PubSub UADP ReaderGroups.
PubSubUadpWriterGroupConf<T extends PubSubUadpDataSetWriterConf>	Common settings for PubSub WriterGroups that deal with UADP message encodings.
PubSubUadpWriterGroupConf.Builder<T extends PubSubUadpWriterGroupConf.Builder<T>>	Builder for common settings for PubSub UADP WriterGroups.
PubSubUdpEvents	Holds UDP related event types for a PubSubSystem as static constants, see class PubSubEvents for all event types.
PubSubWriterGroupConf<T extends PubSubDataSetWriterConf>	Common settings for PubSub WriterGroups.
PubSubWriterGroupConf.Builder<T extends PubSubWriterGroupConf.Builder<T>>	Builder for common settings for PubSub WriterGroups.

Class Summary

Class	Description
PublisherId	Defines an OPC UA PubSub PublisherId.
PubSubBrokerAuthConf
PubSubBrokerAuthConf.Builder	Builder for PubSubBrokerAuthConf.
PubSubBrokerAuthConf.Fields
PubSubConf.MapKind<T>	Different kinds of Maps the configuration can be converted into.
PubSubConfFieldSpecification<T>	Models an individual field (or a "part of a field", such as single key of a Map) in PubSub configurations.
PubSubConfListFieldSpecification<T>	PubSub configuration field that is a List.Note that all instances are designed to be only created by the SDK internally.
PubSubConfMapFieldSpecification<K,V>	PubSub configuration field that is a Map.
PubSubConfScalarFieldSpecification<T>	Models a PubSub configuration field that is scalar (i.e.
PubSubConfSetFieldSpecification<T>	PubSub configuration field that is a Set.
PubSubConfSpecification
PubSubConfSpecification.Builder	Builder for PubSubConfSpecification.
PubSubDataSetMetaDataConf
PubSubDataSetMetaDataConf.Builder	Builder for PubSubDataSetMetaDataConf.
PubSubDataSetMetaDataConf.Fields
PubSubDataValue
PubSubDataValue.Builder	Builder for PubSubDataValue.
PubSubEventDataSetConf
PubSubEventDataSetConf.Builder	Builder for PubSubEventDataSetConf.
PubSubEventDataSetConf.Fields
PubSubEventType<E extends PubSubSystemEvent>	Defines events types for a PubSubSystem.
PubSubFieldMetaDataConf
PubSubFieldMetaDataConf.Builder	Builder for PubSubFieldMetaDataConf.
PubSubFieldMetaDataConf.Fields
PubSubFieldTargetConf
PubSubFieldTargetConf.Builder	Builder for PubSubFieldTargetConf.
PubSubFieldTargetConf.Fields
PubSubJsonApplicationDescriptionMessage
PubSubJsonApplicationDescriptionMessage.Builder	Builder for PubSubJsonApplicationDescriptionMessage.
PubSubJsonConnectionMessage
PubSubJsonConnectionMessage.Builder	Builder for PubSubJsonConnectionMessage.
PubSubJsonDataSetMessage
PubSubJsonDataSetMessage.Builder	Builder for PubSubJsonDataSetMessage.
PubSubJsonDataSetMessageReceivedEvent
PubSubJsonDataSetMetaDataMessage
PubSubJsonDataSetMetaDataMessage.Builder	Builder for PubSubJsonDataSetMetaDataMessage.
PubSubJsonDataSetMetaDataMessageReceivedEvent
PubSubJsonDataSetMetaDataMissingEvent
PubSubJsonNetworkMessage
PubSubJsonNetworkMessage.Builder	Builder for PubSubJsonNetworkMessage.
PubSubJsonServerEndpointsMessage
PubSubJsonServerEndpointsMessage.Builder	Builder for PubSubJsonServerEndpointsMessage.
PubSubJsonStatusMessage
PubSubJsonStatusMessage.Builder	Builder for PubSubJsonStatusMessage.
PubSubMqttConnectionStateChangedEvent
PubSubMqttConnectionStateChangedEvent.Builder	Builder for PubSubMqttConnectionStateChangedEvent.
PubSubMqttJsonConnectionConf
PubSubMqttJsonConnectionConf.Builder	Builder for PubSubMqttJsonConnectionConf.
PubSubMqttJsonConnectionConf.Fields
PubSubMqttJsonConnectionNetworkMessageReceivedEvent
PubSubMqttJsonConnectionNetworkMessageReceivedEvent.Builder	Builder for PubSubMqttJsonConnectionNetworkMessageReceivedEvent.
PubSubMqttJsonConnectionNetworkMessageReceivedFailureEvent
PubSubMqttJsonConnectionNetworkMessageReceivedFailureEvent.Builder	Builder for PubSubMqttJsonConnectionNetworkMessageReceivedFailureEvent.
PubSubMqttJsonConnectionNetworkMessageSentEvent
PubSubMqttJsonConnectionNetworkMessageSentEvent.Builder	Builder for PubSubMqttJsonConnectionNetworkMessageSentEvent.
PubSubMqttJsonConnectionSendMessageCommand
PubSubMqttJsonConnectionSendMessageCommand.Builder	Builder for PubSubMqttJsonConnectionSendMessageCommand.
PubSubMqttJsonDataSetReaderConf
PubSubMqttJsonDataSetReaderConf.Builder	Builder for PubSubMqttJsonDataSetReaderConf.
PubSubMqttJsonDataSetReaderConf.Fields
PubSubMqttJsonDataSetWriterConf
PubSubMqttJsonDataSetWriterConf.Builder	Builder for PubSubMqttJsonDataSetWriterConf.
PubSubMqttJsonDataSetWriterConf.Fields
PubSubMqttJsonReaderGroupConf
PubSubMqttJsonReaderGroupConf.Builder	Builder for PubSubMqttJsonReaderGroupConf.
PubSubMqttJsonReaderGroupConf.Fields
PubSubMqttJsonWriterGroupConf
PubSubMqttJsonWriterGroupConf.Builder	Builder for PubSubMqttJsonWriterGroupConf.
PubSubMqttJsonWriterGroupConf.Fields
PubSubMqttProviderConf
PubSubMqttProviderConf.Builder	Builder for PubSubMqttProviderConf.
PubSubMqttProviderConf.Fields
PubSubMqttRawMessageReceivedEvent
PubSubMqttRawMessageReceivedEvent.Builder	Builder for PubSubMqttRawMessageReceivedEvent.
PubSubMqttUadpConnectionConf
PubSubMqttUadpConnectionConf.Builder	Builder for PubSubMqttUadpConnectionConf.
PubSubMqttUadpConnectionConf.Fields
PubSubMqttUadpConnectionNetworkMessageReceivedEvent
PubSubMqttUadpConnectionNetworkMessageReceivedEvent.Builder	Builder for PubSubMqttUadpConnectionNetworkMessageReceivedEvent.
PubSubMqttUadpConnectionNetworkMessageReceivedFailureEvent
PubSubMqttUadpConnectionNetworkMessageReceivedFailureEvent.Builder	Builder for PubSubMqttUadpConnectionNetworkMessageReceivedFailureEvent.
PubSubMqttUadpConnectionNetworkMessageSentEvent
PubSubMqttUadpConnectionNetworkMessageSentEvent.Builder	Builder for PubSubMqttUadpConnectionNetworkMessageSentEvent.
PubSubMqttUadpDataSetReaderConf
PubSubMqttUadpDataSetReaderConf.Builder	Builder for PubSubMqttUadpDataSetReaderConf.
PubSubMqttUadpDataSetReaderConf.Fields
PubSubMqttUadpDataSetWriterConf
PubSubMqttUadpDataSetWriterConf.Builder	Builder for PubSubMqttUadpDataSetWriterConf.
PubSubMqttUadpDataSetWriterConf.Fields
PubSubMqttUadpReaderGroupConf
PubSubMqttUadpReaderGroupConf.Builder	Builder for PubSubMqttUadpReaderGroupConf.
PubSubMqttUadpReaderGroupConf.Fields
PubSubMqttUadpWriterGroupConf
PubSubMqttUadpWriterGroupConf.Builder	Builder for PubSubMqttUadpWriterGroupConf.
PubSubMqttUadpWriterGroupConf.Fields
PubSubPublishedVariableConf
PubSubPublishedVariableConf.Builder	Builder for PubSubPublishedVariableConf.
PubSubPublishedVariableConf.Fields
PubSubPublishingOffsets	Publishing offsets.
PubSubRestartConnectionCommand
PubSubRestartConnectionCommand.Builder	Builder for PubSubRestartConnectionCommand.
PubSubSecurityConf
PubSubSecurityConf.Builder	Builder for PubSubSecurityConf.
PubSubSecurityConf.Fields
PubSubSecurityKeys
PubSubSendDataSetFieldsCommand
PubSubSendDataSetFieldsCommand.Builder	Builder for PubSubSendDataSetFieldsCommand.
PubSubSendKeyframeCommand
PubSubSendKeyframeCommand.Builder	Builder for PubSubSendKeyframeCommand.
PubSubSystem	Models a PubSub system.
PubSubSystemCommand<R>	Marker interface for all PubSubSystem related commands.
PubSubSystemCommands	Holds all command types for a PubSubSystem as static constants, and contains methods to execute those commands.
PubSubSystemCommandType<A extends PubSubSystemCommand<R>,R>	Defines command types for a PubSubSystem.
PubSubSystemConf
PubSubSystemConf.Builder	Builder for PubSubSystemConf.
PubSubSystemConf.Fields
PubSubSystemConfigurationUpdatedEvent
PubSubSystemConfigurationUpdatedEvent.Builder	Builder for PubSubSystemConfigurationUpdatedEvent.
PubSubSystemConfToUaBinaryFileCommand
PubSubSystemConfToUaBinaryFileCommand.Builder	Builder for PubSubSystemConfToUaBinaryFileCommand.
PubSubSystemEvents	Holds all event types for a PubSubSystem as static constants.
PubSubSystemOverrides
PubSubSystemOverrides.Builder	Builder for PubSubSystemOverrides.
PubSubSystemShutdownEvent
PubSubSystemShutdownEvent.Builder	Builder for PubSubSystemShutdownEvent.
PubSubSystemStartedEvent
PubSubSystemStartedEvent.Builder	Builder for PubSubSystemStartedEvent.
PubSubTargetVariablesConf
PubSubTargetVariablesConf.Builder	Builder for PubSubTargetVariablesConf.
PubSubTargetVariablesConf.Fields
PubSubUadpDataSetMessage
PubSubUadpDataSetMessage.Builder	Builder for PubSubUadpDataSetMessage.
PubSubUadpDataSetMessageReceivedEvent
PubSubUadpDataSetMetaDataMessage
PubSubUadpDataSetMetaDataMessage.Builder	Builder for PubSubUadpDataSetMetaDataMessage.
PubSubUadpDataSetMetaDataMessageReceivedEvent
PubSubUadpDataSetMetaDataMissingEvent
PubSubUadpNetworkMessage
PubSubUadpNetworkMessage.Builder	Builder for PubSubUadpNetworkMessage.
PubSubUadpStatusMessage
PubSubUadpStatusMessage.Builder	Builder for PubSubUadpStatusMessage.
PubSubUdpConnectionStateChangedEvent
PubSubUdpConnectionStateChangedEvent.Builder	Builder for PubSubUdpConnectionStateChangedEvent.
PubSubUdpRawMessageReceivedEvent
PubSubUdpUadpConnectionConf
PubSubUdpUadpConnectionConf.Builder	Builder for PubSubUdpUadpConnectionConf.
PubSubUdpUadpConnectionConf.Fields
PubSubUdpUadpConnectionNetworkMessageReceivedEvent
PubSubUdpUadpConnectionNetworkMessageReceivedFailureEvent
PubSubUdpUadpConnectionNetworkMessageSentEvent
PubSubUdpUadpDataSetReaderConf
PubSubUdpUadpDataSetReaderConf.Builder	Builder for PubSubUdpUadpDataSetReaderConf.
PubSubUdpUadpDataSetReaderConf.Fields
PubSubUdpUadpDataSetWriterConf
PubSubUdpUadpDataSetWriterConf.Builder	Builder for PubSubUdpUadpDataSetWriterConf.
PubSubUdpUadpDataSetWriterConf.Fields
PubSubUdpUadpReaderGroupConf
PubSubUdpUadpReaderGroupConf.Builder	Builder for PubSubUdpUadpReaderGroupConf.
PubSubUdpUadpReaderGroupConf.Fields
PubSubUdpUadpWriterGroupConf
PubSubUdpUadpWriterGroupConf.Builder	Builder for PubSubUdpUadpWriterGroupConf.
PubSubUdpUadpWriterGroupConf.Fields
PubSubUsernamePasswordBrokerCredentials
PubSubUsernamePasswordBrokerCredentials.Builder	Builder for PubSubUsernamePasswordBrokerCredentials.
PubSubVariableDataSetConf
PubSubVariableDataSetConf.Builder	Builder for PubSubVariableDataSetConf.
PubSubVariableDataSetConf.Fields
PubSubVariableDataSetConfFactory	A Factory or a Template that produces PubSubVariableDataSetConf for "well known" (via the DataSetClassId) DataSets (or their templates, i.e.

Enum Summary

Enum	Description
PublisherId.Type	Enum defining different types of PublisherIds.
PubSubDataSetKind	Defines different types of PubSubDataSetConf.
PubSubDataSetMessageType	Classifies the kind of Message a PubSubDataSetMessage is.
PubSubEncodingMimeType	Defines different MIME types for PubSub data encoding.
PubSubFieldEncodingType	Defines how the data is/was encoded in UADP DataSetMessage Header.
PubSubMessageEncoding	Enum defining PubSub Message encoding types.
PubSubMqttMessageType	Internal representation of different PubSub MessageTypes for MQTT https://reference.opcfoundation.org/Core/Part14/v105/docs/7.2.5.2.
PubSubNetworkMessageType	Defines the kind of a PubSub network message.
PubSubTransportProfile	Enum defining Transport Profiles for a PubSub Connection.
PubSubTransportProtocol	Enum defining different PubSub transport protocols.
PubSubUDPSocketKind	Enum defining different types of UDP sockets needed in PubSub UDP UADP connections.

Exception Summary

Exception	Description
PubSubException	Super Exception type for PubSub-related operations.

Package com.prosysopc.ua.pubsub Description

PubSub (Part 14 of the OPC UA Specification) related implementations. The most important class is PubSubSystem. It encapsulates the entire system and keeps the configuration in a central location.