com.mulesoft.connectors.mqtt3.api.clientId

Class ClientIDCustomExpressionGenerator

java.lang.Object

com.mulesoft.connectors.mqtt3.api.clientId.ClientIDCustomExpressionGenerator

All Implemented Interfaces:

ClientIDGenerator

@Summary(value="Generates a client id from a static prefix and a dynamic suffix")
public class ClientIDCustomExpressionGenerator
extends Object
implements ClientIDGenerator

A ClientIDGenerator implementation that allows the user to specify an client id and a custom expression to be added to the client id as a suffix. Both are optional, but at least one of these fields must be specified in order to successfully generate a client ID.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	clientId Client id used to identify the connection to the MQTT broker.
protected String	customClientIdSuffix Custom client id suffix used to identify the connection to the MQTT broker.

Constructor Summary

Constructors

Constructor and Description
ClientIDCustomExpressionGenerator()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	generateClientID()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientId

@Parameter
 @DisplayName(value="Client ID")
 @Optional(defaultValue="")
 @Expression(value=NOT_SUPPORTED)
 @ClientId
 @Summary(value="A static client id to identify the connection to the broker")
protected String clientId

Client id used to identify the connection to the MQTT broker.

customClientIdSuffix

@Parameter
 @DisplayName(value="Custom Client ID Suffix")
 @Expression(value=SUPPORTED)
 @Optional(defaultValue="")
 @Summary(value="A dynamic client id suffix")
protected String customClientIdSuffix

Custom client id suffix used to identify the connection to the MQTT broker.

Constructor Detail

ClientIDCustomExpressionGenerator

public ClientIDCustomExpressionGenerator()

Method Detail

generateClientID

public String generateClientID()

Specified by:

generateClientID in interface ClientIDGenerator

Returns:

the client ID that results from concatenating the clientId and customClientIdSuffix parameters.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object