DeviceCommunicationModel (SiteWhere Web Components 1.5.0 API)

java.lang.Object
- com.sitewhere.web.configuration.model.ConfigurationNode
- - com.sitewhere.web.configuration.model.XmlNode
  - - com.sitewhere.web.configuration.model.ElementNode
    - - com.sitewhere.web.configuration.model.ConfigurationModel
      - com.sitewhere.web.configuration.DeviceCommunicationModel

public class DeviceCommunicationModel
extends ConfigurationModel

Configuration model for device communication elements.

Author:: Derek

Nested Class Summary
- Nested classes/interfaces inherited from class com.sitewhere.web.configuration.model.ElementNode
  ElementNode.Builder

Constructor Summary

Constructors
Constructor and Description

DeviceCommunicationModel()

Constructors
Constructor and Description
`DeviceCommunicationModel()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addCommandDestinationAttributes(ElementNode.Builder builder)` Add attributes common to all command destinations.
`static void`	`addEventSourceAttributes(ElementNode.Builder builder)` Add common event source attributes.
`static void`	`addMqttConnectivityAttributes(ElementNode.Builder builder)` Adds common MQTT connectivity attributes.
`protected ElementNode`	`createActiveMQEventSourceElement()` Create element configuration for ActiveMQ event source.
`protected ElementNode`	`createAzureEventHubEventSourceElement()` Create element configuration for Azure EventHub event source.
`protected ElementNode`	`createBatchOperationManagerElement()` Create element configuration for batch operation manager.
`protected ElementNode`	`createBatchOperationsElement()` Create element configuration for batch operations.
`protected ElementNode`	`createCommandDestinationsElement()` Create element configuration for command routing.
`protected ElementNode`	`createCommandRoutingElement()` Create element configuration for command routing.
`protected ElementNode`	`createDefaultRegistrationManagerElement()` Create element configuration for default registration manager.
`protected ElementNode`	`createDeviceCommunication()` Create the container for device communication information.
`protected ElementNode`	`createDeviceServicesElement()` Create element configuration for device registration.
`protected ElementNode`	`createEchoStringEventDecoderElement()` Create element configuration for echo string event decoder.
`protected ElementNode`	`createEventSourcesElement()` Create element configuration for event sources.
`protected ElementNode`	`createGroovyEventDecoderElement()` Create element configuration for Groovy event decoder.
`protected ElementNode`	`createGroovyStringEventDecoderElement()` Create element configuration for Groovy string event decoder.
`protected ElementNode`	`createHardwareIdParameterExtractorElement()` Create element configuration for hardware id parameter extractor.
`protected ElementNode`	`createHazelcastQueueEventSourceElement()` Create element configuration for Hazelcast queue event source.
`protected ElementNode`	`createJsonCommandEncoderElement()` Create element configuration for JSON command encoder.
`protected ElementNode`	`createJsonEventDecoderElement()` Create element configuration for JSON event decoder.
`protected ElementNode`	`createMqttCommandDestinationElement()` Create element configuration for MQTT command destination.
`protected ElementNode`	`createMqttEventSourceElement()` Create element configuration for MQTT event source.
`protected ElementNode`	`createProtobufCommandEncoderElement()` Create element configuration for GPB command encoder.
`protected ElementNode`	`createProtobufEventDecoderElement()` Create element configuration for protobuf event decoder.
`protected ElementNode`	`createProtobufHybridCommandEncoderElement()` Create element configuration for Java/protobuf hybrid command encoder.
`protected ElementNode`	`createQRCodeSymbolGeneratorElement()` Create element configuration for default registration manager.
`protected ElementNode`	`createRabbitMqEventSourceElement()` Create element configuration for MQTT event source.
`protected ElementNode`	`createReadAllSocketInteractionHandlerElement()` Create read-all socket interaction handler factory.
`protected ElementNode`	`createSocketEventSourceElement()` Create element configuration for socket event source.
`protected ElementNode`	`createSpecificationMappingRouterElement()` Create element configuration for specification mapping command router.
`protected ElementNode`	`createSpecificationMappingRouterMappingElement()` Create element configuration for specification mapping command router.
`protected ElementNode`	`createSymbolGeneratorManagerElement()` Create element configuration for device registration.
`protected ElementNode`	`createTwilioCommandDestinationElement()` Create element configuration for Twilio command destination.
`protected ElementNode`	`createWebSocketEventSourceElement()` Create element configuration for WebSocket event source.
`protected ElementNode`	`createWebSocketHeaderElement()` Create element configuration for WebSocket header.

Methods inherited from class com.sitewhere.web.configuration.model.ConfigurationModel
addElement, getElementsByRole, setElementsByRole

Methods inherited from class com.sitewhere.web.configuration.model.ElementNode
getAttributeGroups, getAttributes, getIndexAttribute, getOnDeleteWarning, getRole, getSpecializes, setAttributeGroups, setAttributes, setOnDeleteWarning, setRole, setSpecializes

Methods inherited from class com.sitewhere.web.configuration.model.XmlNode
getLocalName, getNamespace, setLocalName, setNamespace

Methods inherited from class com.sitewhere.web.configuration.model.ConfigurationNode
getDescription, getIcon, getName, getNodeType, setDescription, setIcon, setName, setNodeType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DeviceCommunicationModel
```
public DeviceCommunicationModel()
```
- Method Detail
  - createDeviceCommunication
```
protected ElementNode createDeviceCommunication()
```
    Create the container for device communication information.
    
    Returns:
  - createEventSourcesElement
```
protected ElementNode createEventSourcesElement()
```
    Create element configuration for event sources.
    
    Returns:
  - createMqttEventSourceElement
```
protected ElementNode createMqttEventSourceElement()
```
    Create element configuration for MQTT event source.
    
    Returns:
  - createRabbitMqEventSourceElement
```
protected ElementNode createRabbitMqEventSourceElement()
```
    Create element configuration for MQTT event source.
    
    Returns:
  - addEventSourceAttributes
```
public static void addEventSourceAttributes(ElementNode.Builder builder)
```
    Add common event source attributes.
    
    Parameters:
    builder -
  - addMqttConnectivityAttributes
```
public static void addMqttConnectivityAttributes(ElementNode.Builder builder)
```
    Adds common MQTT connectivity attributes.
    
    Parameters:
    builder -
  - createAzureEventHubEventSourceElement
```
protected ElementNode createAzureEventHubEventSourceElement()
```
    Create element configuration for Azure EventHub event source.
    
    Returns:
  - createActiveMQEventSourceElement
```
protected ElementNode createActiveMQEventSourceElement()
```
    Create element configuration for ActiveMQ event source.
    
    Returns:
  - createReadAllSocketInteractionHandlerElement
```
protected ElementNode createReadAllSocketInteractionHandlerElement()
```
    Create read-all socket interaction handler factory.
    
    Returns:
  - createSocketEventSourceElement
```
protected ElementNode createSocketEventSourceElement()
```
    Create element configuration for socket event source.
    
    Returns:
  - createWebSocketHeaderElement
```
protected ElementNode createWebSocketHeaderElement()
```
    Create element configuration for WebSocket header.
    
    Returns:
  - createWebSocketEventSourceElement
```
protected ElementNode createWebSocketEventSourceElement()
```
    Create element configuration for WebSocket event source.
    
    Returns:
  - createHazelcastQueueEventSourceElement
```
protected ElementNode createHazelcastQueueEventSourceElement()
```
    Create element configuration for Hazelcast queue event source.
    
    Returns:
  - createProtobufEventDecoderElement
```
protected ElementNode createProtobufEventDecoderElement()
```
    Create element configuration for protobuf event decoder.
    
    Returns:
  - createJsonEventDecoderElement
```
protected ElementNode createJsonEventDecoderElement()
```
    Create element configuration for JSON event decoder.
    
    Returns:
  - createGroovyEventDecoderElement
```
protected ElementNode createGroovyEventDecoderElement()
```
    Create element configuration for Groovy event decoder.
    
    Returns:
  - createGroovyStringEventDecoderElement
```
protected ElementNode createGroovyStringEventDecoderElement()
```
    Create element configuration for Groovy string event decoder.
    
    Returns:
  - createEchoStringEventDecoderElement
```
protected ElementNode createEchoStringEventDecoderElement()
```
    Create element configuration for echo string event decoder.
    
    Returns:
  - createDeviceServicesElement
```
protected ElementNode createDeviceServicesElement()
```
    Create element configuration for device registration.
    
    Returns:
  - createDefaultRegistrationManagerElement
```
protected ElementNode createDefaultRegistrationManagerElement()
```
    Create element configuration for default registration manager.
    
    Returns:
  - createSymbolGeneratorManagerElement
```
protected ElementNode createSymbolGeneratorManagerElement()
```
    Create element configuration for device registration.
    
    Returns:
  - createQRCodeSymbolGeneratorElement
```
protected ElementNode createQRCodeSymbolGeneratorElement()
```
    Create element configuration for default registration manager.
    
    Returns:
  - createBatchOperationsElement
```
protected ElementNode createBatchOperationsElement()
```
    Create element configuration for batch operations.
    
    Returns:
  - createBatchOperationManagerElement
```
protected ElementNode createBatchOperationManagerElement()
```
    Create element configuration for batch operation manager.
    
    Returns:
  - createCommandRoutingElement
```
protected ElementNode createCommandRoutingElement()
```
    Create element configuration for command routing.
    
    Returns:
  - createSpecificationMappingRouterElement
```
protected ElementNode createSpecificationMappingRouterElement()
```
    Create element configuration for specification mapping command router.
    
    Returns:
  - createSpecificationMappingRouterMappingElement
```
protected ElementNode createSpecificationMappingRouterMappingElement()
```
    Create element configuration for specification mapping command router.
    
    Returns:
  - createCommandDestinationsElement
```
protected ElementNode createCommandDestinationsElement()
```
    Create element configuration for command routing.
    
    Returns:
  - addCommandDestinationAttributes
```
protected void addCommandDestinationAttributes(ElementNode.Builder builder)
```
    Add attributes common to all command destinations.
    
    Parameters:
    builder -
  - createMqttCommandDestinationElement
```
protected ElementNode createMqttCommandDestinationElement()
```
    Create element configuration for MQTT command destination.
    
    Returns:
  - createTwilioCommandDestinationElement
```
protected ElementNode createTwilioCommandDestinationElement()
```
    Create element configuration for Twilio command destination.
    
    Returns:
  - createProtobufCommandEncoderElement
```
protected ElementNode createProtobufCommandEncoderElement()
```
    Create element configuration for GPB command encoder.
    
    Returns:
  - createProtobufHybridCommandEncoderElement
```
protected ElementNode createProtobufHybridCommandEncoderElement()
```
    Create element configuration for Java/protobuf hybrid command encoder.
    
    Returns:
  - createJsonCommandEncoderElement
```
protected ElementNode createJsonCommandEncoderElement()
```
    Create element configuration for JSON command encoder.
    
    Returns:
  - createHardwareIdParameterExtractorElement
```
protected ElementNode createHardwareIdParameterExtractorElement()
```
    Create element configuration for hardware id parameter extractor.
    
    Returns:

Class DeviceCommunicationModel

Nested Class Summary

Nested classes/interfaces inherited from class com.sitewhere.web.configuration.model.ElementNode

Constructor Summary

Method Summary

Methods inherited from class com.sitewhere.web.configuration.model.ConfigurationModel

Methods inherited from class com.sitewhere.web.configuration.model.ElementNode

Methods inherited from class com.sitewhere.web.configuration.model.XmlNode

Methods inherited from class com.sitewhere.web.configuration.model.ConfigurationNode

Methods inherited from class java.lang.Object

Constructor Detail

DeviceCommunicationModel

Method Detail

createDeviceCommunication

createEventSourcesElement

createMqttEventSourceElement

createRabbitMqEventSourceElement

addEventSourceAttributes

addMqttConnectivityAttributes

createAzureEventHubEventSourceElement

createActiveMQEventSourceElement

createReadAllSocketInteractionHandlerElement

createSocketEventSourceElement

createWebSocketHeaderElement

createWebSocketEventSourceElement

createHazelcastQueueEventSourceElement

createProtobufEventDecoderElement

createJsonEventDecoderElement

createGroovyEventDecoderElement

createGroovyStringEventDecoderElement

createEchoStringEventDecoderElement

createDeviceServicesElement

createDefaultRegistrationManagerElement

createSymbolGeneratorManagerElement

createQRCodeSymbolGeneratorElement

createBatchOperationsElement

createBatchOperationManagerElement

createCommandRoutingElement

createSpecificationMappingRouterElement

createSpecificationMappingRouterMappingElement

createCommandDestinationsElement

addCommandDestinationAttributes

createMqttCommandDestinationElement

createTwilioCommandDestinationElement

createProtobufCommandEncoderElement

createProtobufHybridCommandEncoderElement

createJsonCommandEncoderElement

createHardwareIdParameterExtractorElement