ModifiablePUBLISH (HiveMQ SPI 3.4.2 API)

```
public interface ModifiablePUBLISH
```
This interface allows the safe modification of a MQTT PUBLISH message, in the BeforePublishSendCallback.

Since:

3.3

Author:

Georg Held, Christoph Schaebel

Method Summary

Methods
Modifier and Type	Method and Description
`PUBLISH`	`copy()`
`byte[]`	`getPayload()`
`QoS`	`getQoS()`
`String`	`getTopic()`
`boolean`	`isDuplicateDelivery()`
`boolean`	`isRetain()`
`void`	`setPayload(byte[] payload)` By using this setter the payload of this `PUBLISH` can be modified before it is sent to a client Changes made to the payload here are only visible to the specific client to which this `ModifiablePUBLISH` is sent.
`void`	`setTopic(String topic)` By using this setter the topic of this `PUBLISH` can be modified before it is sent to a client.

- Method Detail
  - getPayload
```
byte[] getPayload()
```
    Returns:
    the payload of the message. Do not modify the returned byte[] directly, as the resulting behavior is undefined and can have far reaching consequences, use setPayload() method instead.
  - setPayload
```
void setPayload(byte[] payload)
```
    By using this setter the payload of this PUBLISH can be modified before it is sent to a client
    Changes made to the payload here are only visible to the specific client to which this ModifiablePUBLISH is sent.
    These changes will have no effect on message routing or authorization.
    The modified payload will not be visible in any other callbacks other than BeforePublishSendCallback and OnPublishSend.
    
    Parameters:
    payload - a byte[] containing the modified payload
  - getTopic
```
String getTopic()
```
    Returns:
    the topic of the message
  - setTopic
```
void setTopic(String topic)
```
    By using this setter the topic of this PUBLISH can be modified before it is sent to a client.
    Changes made to the topic here are only visible to the specific client to which this ModifiablePUBLISH is sent.
    These changes will have no effect on message routing or authorization.
    The modified topic will not be visible in any other callbacks other than BeforePublishSendCallback and OnPublishSend.
    
    Parameters:
    topic - the modified topic
  - isDuplicateDelivery
```
boolean isDuplicateDelivery()
```
    Returns:
    true if the message is a duplicate message
  - isRetain
```
boolean isRetain()
```
    Returns:
    if the message should be retained
  - getQoS
```
QoS getQoS()
```
    Returns:
    the QoS level of the message
  - copy
```
PUBLISH copy()
```
    Returns:
    returns a deep copy of the PUBLISH

Interface ModifiablePUBLISH

Method Summary

Method Detail

getPayload

setPayload

getTopic

setTopic

isDuplicateDelivery

isRetain

getQoS

copy