com.inductiveautomation.xopc.driver.common.nodemap

Class NodeMapDriver

java.lang.Object

com.inductiveautomation.xopc.driver.api.AbstractDriver<java.lang.Integer>

com.inductiveautomation.xopc.driver.common.nodemap.NodeMapDriver

All Implemented Interfaces:

Driver, DriverTagManager

public abstract class NodeMapDriver
extends AbstractDriver<java.lang.Integer>

The NodeMapDriver does not actually make any outgoing requests. Requests immediately return from sendMessage() and then turn to the internal node map to fulfill the request.

Implementations simply need to update the node map whenever they deem it appropriate and subsequent requests will reflect those updates.

Field Summary

Fields inherited from class com.inductiveautomation.xopc.driver.api.AbstractDriver

builderFactory, diagnosticsContext, executor, log, nodeManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeMapDriver(DriverContext driverContext)

Method Summary

Modifier and Type	Method and Description
void	buildNode(java.lang.String address, NodeId nodeId) For the given address, build an appropriate Node and at it to the UA address space.
protected void	connect() A chance for implementations to do anything that is needed before moving into DriverState.Connected.
protected Request<java.lang.Integer>	createBrowseRequest(BrowseOperation browseOp) Create a browse Request for the given BrowseOperation.
protected Request<java.lang.Integer>	createReadRequest(java.util.List<? extends ReadItem> items) Create a read Request with the given items.
protected Request<java.lang.Integer>	createWriteRequest(java.util.List<? extends WriteItem> items) Create a write Request with the given items.
protected void	disconnect() A chance for implementations to do anything that is needed before moving into DriverState.Disconnected.
java.util.Map<java.lang.String,BrowseNode>	getNodeMap()
java.util.concurrent.locks.ReadWriteLock	getNodeMapLock()
protected java.lang.Integer	getRequestKey(java.lang.Integer message) Gets the request key for a given message.
FolderNode	getRootNode()
java.util.concurrent.ScheduledExecutorService	getScheduledExecutor()
Sequence	getTransactionSequence()
protected abstract void	initialize() Gives implementations a chance to initialize.
protected boolean	isBrowsingSupported()
protected boolean	isOfflineBrowsingSupported()
void	messageDone(java.lang.Integer message)
protected java.util.List<java.util.List<? extends ReadItem>>	optimizeRead(java.util.List<? extends ReadItem> items) Optimize the given list of items into sub-lists, where each sub-list is expected to fit into a single Request when AbstractDriver.createReadRequest(List) is called.
void	shutdown() Called when a driver should cease all activities and shutdown any open connections.

Methods inherited from class com.inductiveautomation.xopc.driver.api.AbstractDriver

addDriverTag, browse, createSubscribeRequest, currentGuid, findTag, getConcurrentRequests, getDiagnostics, getDriverContext, getDriverMetrics, getDriverState, getDriverStatus, getDriverTagAddressPrefix, getLogger, getName, getRequestDiagnostics, messageArrived, nextGuid, notifyConnectFailed, notifyConnectionLost, notifyConnectSucceeded, notifyDisconnectDone, optimizeSubscribe, optimizeWrite, postRequest, readItems, removeDriverTag, reschedule, setConcurrentRequests, setState, writeItems

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.xopc.driver.api.Driver

getDriverStatusJSLibName, getDriverStatusJSUrl

Constructor Detail

NodeMapDriver

protected NodeMapDriver(DriverContext driverContext)

Method Detail

initialize

protected abstract void initialize()

Gives implementations a chance to initialize. The nodes map will have been created at this point, so this may be an ideal time to add any BrowseNodes.

getTransactionSequence

public Sequence getTransactionSequence()

messageDone

public void messageDone(java.lang.Integer message)

getNodeMapLock

public java.util.concurrent.locks.ReadWriteLock getNodeMapLock()

getNodeMap

public java.util.Map<java.lang.String,BrowseNode> getNodeMap()

getRootNode

public FolderNode getRootNode()

connect

protected void connect()

Description copied from class: AbstractDriver

A chance for implementations to do anything that is needed before moving into DriverState.Connected. When done, AbstractDriver.notifyConnectSucceeded() or AbstractDriver.notifyConnectFailed(Exception) must be called.

Specified by:

connect in class AbstractDriver<java.lang.Integer>

disconnect

protected void disconnect()

Description copied from class: AbstractDriver

A chance for implementations to do anything that is needed before moving into DriverState.Disconnected. When done, AbstractDriver.notifyDisconnectDone() must be called.

Specified by:

disconnect in class AbstractDriver<java.lang.Integer>

createBrowseRequest

protected Request<java.lang.Integer> createBrowseRequest(BrowseOperation browseOp)

Description copied from class: AbstractDriver

Create a browse Request for the given BrowseOperation.

If the implementation does not actually need to post a Request to complete the browse then BrowseOperation.browseDone(StatusCode, List, Guid) can be called whenever browsing is complete and a null value can be returned.

Specified by:

createBrowseRequest in class AbstractDriver<java.lang.Integer>

Parameters:

browseOp - The BrowseOperation for this Request.

Returns:

A browse Request for the given BrowseOperation, or null if no Request is necessary to complete the browse.

createReadRequest

protected Request<java.lang.Integer> createReadRequest(java.util.List<? extends ReadItem> items)

Description copied from class: AbstractDriver

Create a read Request with the given items. These items are guaranteed to be a sub-list previously generated by a call to AbstractDriver.optimizeRead(List) and should therefore fit into single Request.

Specified by:

createReadRequest in class AbstractDriver<java.lang.Integer>

Parameters:

items - The items that make up this Request.

Returns:

A Request for the given items.

createWriteRequest

protected Request<java.lang.Integer> createWriteRequest(java.util.List<? extends WriteItem> items)

Description copied from class: AbstractDriver

Create a write Request with the given items. These items are guaranteed to be a sub-list previously generated by a call to AbstractDriver.optimizeWrite(List) and should therefore fit into a single Request.

Specified by:

createWriteRequest in class AbstractDriver<java.lang.Integer>

Parameters:

items - The items that make up this write Request.

Returns:

A write Request for the given items.

getRequestKey

protected java.lang.Integer getRequestKey(java.lang.Integer message)

Gets the request key for a given message. In the case of the NodeMapDriver all of its Request implementations use the request key as the message as well (since there isn't actually anything outgoing), so we can simply return it.

Specified by:

getRequestKey in class AbstractDriver<java.lang.Integer>

Parameters:

message - The message to extract a key from.

Returns:

A key for this message.

isBrowsingSupported

protected boolean isBrowsingSupported()

Specified by:

isBrowsingSupported in class AbstractDriver<java.lang.Integer>

Returns:

True if this driver supports browsing.

isOfflineBrowsingSupported

protected boolean isOfflineBrowsingSupported()

Specified by:

isOfflineBrowsingSupported in class AbstractDriver<java.lang.Integer>

Returns:

True if this driver supports offline browsing (browsing regardless of connection state).

optimizeRead

protected java.util.List<java.util.List<? extends ReadItem>> optimizeRead(java.util.List<? extends ReadItem> items)

Description copied from class: AbstractDriver

Optimize the given list of items into sub-lists, where each sub-list is expected to fit into a single Request when AbstractDriver.createReadRequest(List) is called.

Things to take into consideration when optimizing might be:

• Type of item being read
• Address/location of item being read
• Limitations on the number of items that can be read at once
• Limitations on the size of a request packet
• Limitations on the size of the response packet this request may generate
• The speed at which a device responds to reading items based on how they are grouped

These and any other limitations are, obviously, highly implementation specific.

Specified by:

optimizeRead in class AbstractDriver<java.lang.Integer>

Parameters:

items - The items to optimize.

Returns:

A list of lists, where each sub-list is expected to fit into a single Request.

buildNode

public void buildNode(java.lang.String address,
                      NodeId nodeId)
               throws AddressNotFoundException

Description copied from interface: Driver

For the given address, build an appropriate Node and at it to the UA address space. See DriverContext.getNodeManager() and DriverContext.getNodeBuilderFactory() for more information.

If for any reason the node cannot be built AddressNotFoundException should be thrown.

Parameters:

address - Address of the node that is to be built.

nodeId - The NodeId to use when building the Node for this address.

Throws:

AddressNotFoundException

getScheduledExecutor

public java.util.concurrent.ScheduledExecutorService getScheduledExecutor()

shutdown

public void shutdown()

Description copied from interface: Driver

Called when a driver should cease all activities and shutdown any open connections. No further value updates should be processed.

Once a driver instance has been shutdown it will never be started/used again; a new instance will be created and used if needed.

Specified by:

shutdown in interface Driver

Overrides:

shutdown in class AbstractDriver<java.lang.Integer>