com.ergotech.vib.servers.mqttwrapper

Class MqttWrapper

java.lang.Object

com.ergotech.vib.servers.mqttwrapper.MqttWrapper

public class MqttWrapper
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MqttWrapper.SecsFormat00PayloadDecoder Decode a JSON SecsFormat00 input.
static class	MqttWrapper.TriggerPayloadDecoder Decode a (potentially) JSON trigger input.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	PUBLISH_ONLY_TAG_NAMES The array of classes that need to be published but not subscribed.
static java.lang.String[]	UPDATE_CLASSNAMES The array of classes that need to be periodically updated.

Constructor Summary

Constructors

Constructor and Description
MqttWrapper() Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canReload() This server responds false to indicate that the OPC Server cannot be reloaded without a MIX restart.
java.lang.String	containsCaseInsensitive(java.lang.String portName, java.util.List<java.lang.String> ports) Check to see if the list contains the string regardless of case.
void	destroy() Destroy the server.
MqttDeviceServer	getMqttDeviceServer() Return the device server.
static MqttWrapper	getWrapper() Return the wrapper creating as necessary.
static MqttWrapper	getWrapper(PersistenceInterface persistence) Return the wrapper creating as necessary.
void	init() Create the server.
void	populateServer() Add all existing tags to the wrapper.
void	populateServer(java.lang.Object dataSourceContainer) Recursively add all existing tags in the given container to the wrapper.
void	populateServer(java.lang.Object dataSourceContainer, java.lang.String pathToServer) Iterate through the instance in the container and sub-containers and fill the OPC Server.
void	start() After creating the server, tags should be added to the server.
void	stop() Stop the server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PUBLISH_ONLY_TAG_NAMES

public static final java.lang.String[] PUBLISH_ONLY_TAG_NAMES

The array of classes that need to be published but not subscribed.

UPDATE_CLASSNAMES

public static final java.lang.String[] UPDATE_CLASSNAMES

The array of classes that need to be periodically updated. *

Constructor Detail

MqttWrapper

public MqttWrapper()

Default constructor.

Method Detail

canReload

public boolean canReload()

This server responds false to indicate that the OPC Server cannot be reloaded without a MIX restart.

Returns:

false

containsCaseInsensitive

public java.lang.String containsCaseInsensitive(java.lang.String portName,
                                                java.util.List<java.lang.String> ports)

Check to see if the list contains the string regardless of case.

Parameters:

portName - the string to check

ports - the list of port names

Returns:

the matching string from the list if the string appears in the list regardless of the case of the string or null if the string is not in the list.

destroy

public void destroy()
             throws BadParameterException

Destroy the server. After this there will be no access to this server.

Throws:

BadParameterException

getMqttDeviceServer

public MqttDeviceServer getMqttDeviceServer()

Return the device server.

Returns:

the device server

getWrapper

public static MqttWrapper getWrapper()

Return the wrapper creating as necessary.

getWrapper

public static MqttWrapper getWrapper(PersistenceInterface persistence)

Return the wrapper creating as necessary.

init

public void init()
          throws BadParameterException

Create the server. After the server is created tags should be added to it before it is started.

Throws:

BadParameterException - thrown if the server cannot be created

populateServer

public void populateServer()

Add all existing tags to the wrapper.

populateServer

public void populateServer(java.lang.Object dataSourceContainer)

Recursively add all existing tags in the given container to the wrapper.

populateServer

public void populateServer(java.lang.Object dataSourceContainer,
                           java.lang.String pathToServer)

Iterate through the instance in the container and sub-containers and fill the OPC Server.

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

After creating the server, tags should be added to the server. After that, the server should be started.

Throws:

VIBUpdateFailedException

BadParameterException

stop

public void stop()
          throws BadParameterException

Stop the server. This currently has no effect.

Throws:

BadParameterException