Package com.plccom.mqtt.broker

Public PLCcom MQTT broker lifecycle API.

Interface Summary

Interface	Description
MqttBrokerAdmin	Read-oriented administration facade for an embedded PLCcom MQTT broker.
MqttBrokerApplicationOperations	Optional support interface for broker implementations that can execute the high-level in-process application publish/listen API.
MqttBrokerListenerHandle	Lifecycle handle for one in-process broker listener registration.
MqttBrokerMessageListener	Callback for messages delivered to an in-process broker listener.
PlccomMqttBroker	Lifecycle handle for a PLCcom MQTT broker instance.
PlccomMqttBrokerAccessValidator	Validates broker access for connection and topic operations.
PlccomMqttBrokerEnhancedAuthenticator	Optional broker-side hook for MQTT 5 enhanced authentication.
PlccomMqttBrokerStore	Optional persistent state store for the PLCcom MQTT broker.

Class Summary

Class	Description
MqttBrokerAdminCounters	Immutable diagnostic counter snapshot for broker administration.
MqttBrokerAdminSnapshot	Immutable read-only administration snapshot of a broker instance.
MqttBrokerBatchPublishBuilder	High-level builder for publishing several in-process messages to a broker.
MqttBrokerBatchPublishResult	Result of an in-process broker batch publish operation.
MqttBrokerListenBuilder	High-level builder for one in-process broker listener registration.
MqttBrokerMessage	High-level view of a message delivered to an in-process broker listener.
MqttBrokerPublishBuilder	High-level builder for one in-process broker publish operation.
MqttBrokerPublishItem	Immutable topic/payload pair for an in-process broker batch publish.
MqttBrokerPublishMetadata	Immutable MQTT 5 metadata for an in-process broker publish.
MqttBrokerPublishMetadata.Builder	Builder for immutable broker publish metadata.
MqttBrokerPublishResult	Result of one in-process broker publish operation.
MqttBrokerStatistics	Immutable snapshot of high-level broker statistics.
MqttBrokerUserProperty	Immutable MQTT 5 User Property used by broker high-level publish APIs.
PlccomMqttBrokerAccessDecision	Result returned by a broker access validator.
PlccomMqttBrokerBoundListener	Snapshot of one broker listener after it was bound.
PlccomMqttBrokerBuilder	High-level builder for creating and optionally starting PlccomMqttBroker instances.
PlccomMqttBrokerConnectContext	Context for validating an MQTT CONNECT request.
PlccomMqttBrokerEnhancedAuthContext	Immutable context supplied to a broker-side MQTT 5 enhanced authentication callback.
PlccomMqttBrokerEnhancedAuthResult	Result returned by a broker-side MQTT 5 enhanced authentication callback.
PlccomMqttBrokerFactory	Factory for PLCcom MQTT broker instances.
PlccomMqttBrokerInMemoryStore	Thread-safe in-memory implementation of PlccomMqttBrokerStore.
PlccomMqttBrokerListenerOptions	Immutable broker listener configuration.
PlccomMqttBrokerOptions	Immutable options for the PLCcom MQTT broker MVP.
PlccomMqttBrokerOptions.Builder	Builder for PlccomMqttBrokerOptions.
PlccomMqttBrokerPublishContext	Immutable context for validating an inbound MQTT PUBLISH.
PlccomMqttBrokerQueuedMessageState	Immutable queued-message snapshot used by PlccomMqttBrokerStore.
PlccomMqttBrokerRetainedMessage	Immutable retained-message snapshot used by PlccomMqttBrokerStore.
PlccomMqttBrokerSessionState	Immutable persistent client-session snapshot used by PlccomMqttBrokerStore.
PlccomMqttBrokerSubscriptionContext	Immutable context for validating one MQTT SUBSCRIBE or UNSUBSCRIBE filter.
PlccomMqttBrokerSubscriptionState	Immutable subscription snapshot used by PlccomMqttBrokerStore.
PlccomMqttBrokerTlsOptions	Server-side TLS options for MQTT broker listeners.
PlccomMqttBrokerTlsOptions.Builder	Builder for PlccomMqttBrokerTlsOptions.

Enum Summary

Enum	Description
PlccomMqttBrokerAccessDeniedReason	Reason why a broker access validator denied an operation.
PlccomMqttBrokerClientCertificateMode	Client-certificate policy for a TLS broker listener.
PlccomMqttBrokerEnhancedAuthResult.Action	Outcome of a broker-side enhanced authentication step.
PlccomMqttBrokerListenerType	Transport type of a broker network listener.
PlccomMqttBrokerProtocolVersion	MQTT protocol versions exposed by broker validation callbacks.
PlccomMqttBrokerQualityOfService	MQTT Quality of Service levels exposed by broker validation callbacks.

Exception Summary

Exception	Description
PlccomMqttBrokerException	Exception raised by broker lifecycle operations.
PlccomMqttBrokerLicenseException	Runtime exception thrown when a licensed high-level MQTT broker operation is used without valid PLCcom license information.