org.eclipse.scada.da.master

Class AbstractConfigurableMasterHandlerImpl

java.lang.Object

org.eclipse.scada.da.master.AbstractMasterHandlerImpl

org.eclipse.scada.da.master.AbstractConfigurableMasterHandlerImpl

All Implemented Interfaces:

MasterItemHandler

Direct Known Subclasses:

AbstractCommonHandlerImpl, MultiMasterHandler

public abstract class AbstractConfigurableMasterHandlerImpl
extends AbstractMasterHandlerImpl

Field Summary

Fields inherited from class org.eclipse.scada.da.master.AbstractMasterHandlerImpl

eventAttributes

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurableMasterHandlerImpl(String configurationId, ObjectPoolTracker<MasterItem> poolTracker, int priority, org.osgi.util.tracker.ServiceTracker<ConfigurationAdministrator,ConfigurationAdministrator> caTracker, String prefix, String factoryId)

Method Summary

Modifier and Type	Method and Description
protected String	getPrefixed(String id, com.google.common.collect.Interner<String> stringInterner)
protected abstract WriteAttributeResults	handleUpdate(Map<String,Variant> attributes, OperationParameters operationParameters) This method will be called on write request that have attributes which match our prefix.
WriteRequestResult	processWrite(WriteRequest request) Process the write request
protected WriteAttributeResults	updateConfiguration(Map<String,String> data, Map<String,Variant> attributes, boolean fullSet, OperationParameters operationParameters) Process a CA update using the write attributes
protected WriteAttributeResults	updateConfiguration(Map<String,String> data, Map<String,Variant> attributes, boolean fullSet, OperationParameters operationParameters, WriteAttributeResults result) Process a CA update using the write attributes

Methods inherited from class org.eclipse.scada.da.master.AbstractMasterHandlerImpl

addItem, createTrackers, dataUpdate, dispose, getMasterItems, removeItem, reprocess, update

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfigurableMasterHandlerImpl

public AbstractConfigurableMasterHandlerImpl(String configurationId,
                                             ObjectPoolTracker<MasterItem> poolTracker,
                                             int priority,
                                             org.osgi.util.tracker.ServiceTracker<ConfigurationAdministrator,ConfigurationAdministrator> caTracker,
                                             String prefix,
                                             String factoryId)

Method Detail

getPrefixed

protected String getPrefixed(String id,
                             com.google.common.collect.Interner<String> stringInterner)

processWrite

public WriteRequestResult processWrite(WriteRequest request)

Description copied from class: AbstractMasterHandlerImpl

Process the write request

This implementation does nothing and can be overridden by derived implementations.

Specified by:

processWrite in interface MasterItemHandler

Overrides:

processWrite in class AbstractMasterHandlerImpl

Parameters:

request - the write request to handle

Returns:

the resulting write request

handleUpdate

protected abstract WriteAttributeResults handleUpdate(Map<String,Variant> attributes,
                                                      OperationParameters operationParameters)
                                               throws Exception

This method will be called on write request that have attributes which match our prefix.

All attributes that are processed must be returned in the result

Parameters:

writeInformation - the write information of the write request

attributes - the filtered attributes that match our prefix

Returns:

the attribute result of the written attributes

Throws:

Exception - if anything goes wrong

updateConfiguration

protected WriteAttributeResults updateConfiguration(Map<String,String> data,
                                                    Map<String,Variant> attributes,
                                                    boolean fullSet,
                                                    OperationParameters operationParameters)
                                             throws OperationException

Process a CA update using the write attributes

Actually calls updateConfiguration(Map, Map, boolean, OperationParameters, WriteAttributeResults) with null as result parameter.

Throws:

OperationException

updateConfiguration

protected WriteAttributeResults updateConfiguration(Map<String,String> data,
                                                    Map<String,Variant> attributes,
                                                    boolean fullSet,
                                                    OperationParameters operationParameters,
                                                    WriteAttributeResults result)
                                             throws OperationException

Process a CA update using the write attributes

Write attribute results will automatically be generated for attributes that match an entry in the data map.

The result parameter may provide an already filled set with results for attributes that cannot be automatically filled. Note that the the attribute named must not be prefixed!

Throws:

OperationException