Package com.storedobject.iot

Class MQTT

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.iot.MQTT

All Implemented Interfaces:

Displayable, StringFiller, HasId

public class MQTT
extends StoredObject

Definition of MQTT connector.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MQTT.Listener

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
MQTT()

Method Summary

Modifier and Type	Method	Description
void	addListener(MQTT.Listener listener)
void	collect(TransactionManager tm)
void	collect(Consumer<List<Data>> dataConsumer)
static void	columns(Columns columns)
void	connect()
void	debug()
void	disconnect()
String	dumpConfiguration()
void	ensureConnection()
static MQTT	get()
static MQTT	get(String name)
int	getConnectionTimeout()
int	getConnectionType()
String	getConnectionTypeValue()
static String	getConnectionTypeValue(int value)
static String[]	getConnectionTypeValues()
static Data	getData(Block block, Class<?> dataClass)
Data	getData(ValueDefinition<?> valueDefinition, Id unitId)
static Set<Class<?>>	getDataClasses()
static long	getErrorMessageCount()
static long	getIgnoredMessageCount()
int	getKeepAliveInterval()
StreamData	getKeyStoreFile()
Id	getKeyStoreFileId()
String	getKeyStorePassword()
static int	getLastProcessingTime()
static int	getMaxProcessingTime()
static long	getMessageCount()
static int	getMinProcessingTime()
int	getMQTTVersion()
String	getMQTTVersionValue()
static String	getMQTTVersionValue(int value)
static String[]	getMQTTVersionValues()
String	getName()
static int	getPendingMessageCount()
int	getPort()
static long	getPurgedMessageCount()
String	getServer()
static long	getTotalProcessingTime()
TransactionManager	getTransactionManager()
String	getUniqueCondition()	Gets the unique index condition of this object.
String	getUserName()
String	getUserPassword()
boolean	getVerifyCA()
static int	hints()
static void	indices(Indices indices)
boolean	isConnected()
static ObjectIterator<MQTT>	list(String name)
void	publish(Command command)
void	removeAllListeners()
void	removeListener(MQTT.Listener listener)
static void	reportDuplicateErrors()
void	setConnectionTimeout(int connectionTimeout)
void	setConnectionType(int connectionType)
void	setKeepAliveInterval(int keepAliveInterval)
void	setKeyStoreFile(Id keyStoreFileId)
void	setKeyStoreFile(StreamData keyStoreFile)
void	setKeyStoreFile(BigDecimal idValue)
void	setKeyStorePassword(String keyStorePassword)
void	setMQTTVersion(int mQTTVersion)
void	setName(String name)
void	setPort(int port)
void	setServer(String server)
void	setTransactionManager(TransactionManager tm)
void	setUserName(String userName)
void	setUserPassword(String userPassword)
void	setVerifyCA(boolean verifyCA)
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

MQTT

public MQTT()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

get

public static MQTT get(String name)

list

public static ObjectIterator<MQTT> list(String name)

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

hints

public static int hints()

setName

public void setName(String name)

getName

@Column(order=100)
public String getName()

setServer

public void setServer(String server)

getServer

@Column(order=200)
public String getServer()

setPort

public void setPort(int port)

getPort

@Column(order=300)
public int getPort()

setConnectionType

public void setConnectionType(int connectionType)

getConnectionType

@Column(order=400)
public int getConnectionType()

getConnectionTypeValues

public static String[] getConnectionTypeValues()

getConnectionTypeValue

public static String getConnectionTypeValue(int value)

getConnectionTypeValue

public String getConnectionTypeValue()

setKeyStoreFile

public void setKeyStoreFile(Id keyStoreFileId)

setKeyStoreFile

public void setKeyStoreFile(BigDecimal idValue)

setKeyStoreFile

public void setKeyStoreFile(StreamData keyStoreFile)

getKeyStoreFileId

@Column(style="(FILE)",
        required=false,
        caption="PKCS12 Key Store File",
        order=500)
public Id getKeyStoreFileId()

getKeyStoreFile

public StreamData getKeyStoreFile()

setVerifyCA

public void setVerifyCA(boolean verifyCA)

getVerifyCA

@Column(order=600)
public boolean getVerifyCA()

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

getKeyStorePassword

@Column(style="(secret)",
        required=false,
        order=700)
public String getKeyStorePassword()

setUserName

public void setUserName(String userName)

getUserName

@Column(required=false,
        order=800,
        caption="Username")
public String getUserName()

setUserPassword

public void setUserPassword(String userPassword)

getUserPassword

@Column(style="(secret)",
        required=false,
        order=900)
public String getUserPassword()

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

getConnectionTimeout

@Column(required=false,
        order=1000)
public int getConnectionTimeout()

setKeepAliveInterval

public void setKeepAliveInterval(int keepAliveInterval)

getKeepAliveInterval

@Column(required=false,
        order=1100)
public int getKeepAliveInterval()

setMQTTVersion

public void setMQTTVersion(int mQTTVersion)

getMQTTVersion

@Column(order=1200)
public int getMQTTVersion()

getMQTTVersionValues

public static String[] getMQTTVersionValues()

getMQTTVersionValue

public static String getMQTTVersionValue(int value)

getMQTTVersionValue

public String getMQTTVersionValue()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

removeAllListeners

public void removeAllListeners()

addListener

public void addListener(MQTT.Listener listener)

removeListener

public void removeListener(MQTT.Listener listener)

ensureConnection

public void ensureConnection()
                      throws Exception

Throws:

Exception

connect

public void connect()
             throws Exception

Throws:

Exception

dumpConfiguration

public String dumpConfiguration()
                         throws Exception

Throws:

Exception

disconnect

public void disconnect()

collect

public void collect(TransactionManager tm)
             throws Exception

Throws:

Exception

collect

public void collect(Consumer<List<Data>> dataConsumer)
             throws Exception

Throws:

Exception

setTransactionManager

public void setTransactionManager(TransactionManager tm)

getTransactionManager

public TransactionManager getTransactionManager()

publish

public void publish(Command command)
             throws Exception

Throws:

Exception

getData

public Data getData(ValueDefinition<?> valueDefinition,
 Id unitId)

isConnected

public boolean isConnected()

debug

public void debug()

getData

public static Data getData(Block block,
 Class<?> dataClass)

getDataClasses

public static Set<Class<?>> getDataClasses()

getMessageCount

public static long getMessageCount()

getErrorMessageCount

public static long getErrorMessageCount()

getIgnoredMessageCount

public static long getIgnoredMessageCount()

getPurgedMessageCount

public static long getPurgedMessageCount()

getTotalProcessingTime

public static long getTotalProcessingTime()

getMinProcessingTime

public static int getMinProcessingTime()

getLastProcessingTime

public static int getLastProcessingTime()

getMaxProcessingTime

public static int getMaxProcessingTime()

getPendingMessageCount

public static int getPendingMessageCount()

get

public static MQTT get()

reportDuplicateErrors

public static void reportDuplicateErrors()