Interface ModifiablePubcompPacket
-
- All Superinterfaces:
PubcompPacket
@DoNotImplement public interface ModifiablePubcompPacket extends PubcompPacket
APubcompPacket
that can be modified before it is sent to the client (forPubcompOutboundInterceptor
) or to the server (forPubcompInboundInterceptor
).- Since:
- 4.3.0, CE 2020.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull ModifiableUserProperties
getUserProperties()
Get the modifiableUserProperties
of the PUBCOMP packet.void
setReasonString(@Nullable String reasonString)
Set the reason string.-
Methods inherited from interface com.hivemq.extension.sdk.api.packets.pubcomp.PubcompPacket
getPacketIdentifier, getReasonCode, getReasonString
-
-
-
-
Method Detail
-
setReasonString
void setReasonString(@Nullable String reasonString)
Set the reason string.A reason must not be set for a successful publish.
For an
PubcompOutboundInterceptor
this setting is only respected for MQTT 5 clients and ignored for MQTT 3.x clients when the PUBCOMP is sent to the client (as MQTT 3.x clients don't know this property).For an
PubcompInboundInterceptor
this setting is respected for MQTT 5 and MQTT 3.x clients when the PUBCOMP is sent to HiveMQ, this allows to enrich MQTT 3.x PUBCOMPs with this MQTT 5 property.- Parameters:
reasonString
- The reason string to set.- Throws:
IllegalArgumentException
- If the reason string is not a valid UTF-8 string.IllegalArgumentException
- If the reason string exceeds the UTF-8 string length limit.- Since:
- 4.3.0, CE 2020.1
-
getUserProperties
@NotNull ModifiableUserProperties getUserProperties()
Get the modifiableUserProperties
of the PUBCOMP packet.For an
PubcompOutboundInterceptor
this setting is only respected for MQTT 5 clients and ignored for MQTT 3.x clients when the PUBCOMP is sent to the client (as MQTT 3.x clients don't know this property).For an
PubcompInboundInterceptor
this setting is respected for MQTT 5 and MQTT 3.x clients when the PUBCOMP is sent to HiveMQ, this allows to enrich MQTT 3.x PUBCOMPs with this MQTT 5 property.- Specified by:
getUserProperties
in interfacePubcompPacket
- Returns:
- Modifiable user properties.
- Since:
- 4.3.0, CE 2020.1
-
-