org.eclipse.scada.da.master.common.manual

Class ManualHandlerImpl

java.lang.Object

org.eclipse.scada.da.master.AbstractMasterHandlerImpl

org.eclipse.scada.da.master.AbstractConfigurableMasterHandlerImpl

org.eclipse.scada.da.master.common.AbstractCommonHandlerImpl

org.eclipse.scada.da.master.common.manual.ManualHandlerImpl

All Implemented Interfaces:

MasterItemHandler

public class ManualHandlerImpl
extends AbstractCommonHandlerImpl

Provide a handler for manual override values

This processor allows manually overriding a value. All processors further in the chain will received the overridden information if this handler is active.

Behavior

If a manual override is active the following things will happen in the value chain:

• The manual value will override the current value
• The subscription state will be SubscriptionState.CONNECTED and there will be no subscription error
• The error attributes will be reset to ok and the original attributs will be renamed
• The timestamp of the manual value request will be used as timestamp

When the manul override is removed the following things will happen in the value chain:

• The value, subscription state and error reported from the source will be used, the manual override not be applied anymore
• The timestamp will be the time of the removal of the manual override if it is after the timestamp of the source value

Timestamp

The idea of the timestamp handling is that manual overrides advance the timestamp as well and indicate a newer value, but also do go back in history once the value is cleared.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManualHandlerImpl.ManualStateData

Nested classes/interfaces inherited from class org.eclipse.scada.da.master.common.AbstractCommonHandlerImpl

AbstractCommonHandlerImpl.AbstractConfiguration

Field Summary

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

eventAttributes

Constructor Summary

Constructors

Constructor and Description
ManualHandlerImpl(String configurationId, EventProcessor eventProcessor, ObjectPoolTracker<MasterItem> poolTracker, int priority, org.osgi.util.tracker.ServiceTracker<ConfigurationAdministrator,ConfigurationAdministrator> caTracker)

Method Summary

Modifier and Type	Method and Description
protected WriteAttributeResults	handleUpdate(Map<String,Variant> attributes, OperationParameters operationParameters) This method will be called on write request that have attributes which match our prefix.
protected void	injectAttributes(DataItemValue.Builder builder)
protected void	processDataUpdate(Map<String,Object> context, DataItemValue.Builder builder)
void	update(UserInformation userInformation, Map<String,String> parameters)

Methods inherited from class org.eclipse.scada.da.master.common.AbstractCommonHandlerImpl

createEventBuilder, dataUpdate, injectEventAttributes

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

getPrefixed, processWrite, updateConfiguration, updateConfiguration

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

addItem, createTrackers, dispose, getMasterItems, removeItem, reprocess

Methods inherited from class java.lang.Object

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

Constructor Detail

ManualHandlerImpl

public ManualHandlerImpl(String configurationId,
                         EventProcessor eventProcessor,
                         ObjectPoolTracker<MasterItem> poolTracker,
                         int priority,
                         org.osgi.util.tracker.ServiceTracker<ConfigurationAdministrator,ConfigurationAdministrator> caTracker)

Method Detail

processDataUpdate

protected void processDataUpdate(Map<String,Object> context,
                                 DataItemValue.Builder builder)
                          throws Exception

Specified by:

processDataUpdate in class AbstractCommonHandlerImpl

Throws:

Exception

update

public void update(UserInformation userInformation,
                   Map<String,String> parameters)
            throws Exception

Overrides:

update in class AbstractMasterHandlerImpl

Throws:

Exception

injectAttributes

protected void injectAttributes(DataItemValue.Builder builder)

handleUpdate

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

Description copied from class: AbstractConfigurableMasterHandlerImpl

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

Specified by:

handleUpdate in class AbstractConfigurableMasterHandlerImpl

Parameters:

attributes - the filtered attributes that match our prefix

Returns:

the attribute result of the written attributes

Throws:

Exception - if anything goes wrong