org.eclipse.scada.ae.monitor.datasource

Class AbstractMonitorFactory

java.lang.Object

org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory<DataItemMonitor>

org.eclipse.scada.ae.monitor.datasource.AbstractMonitorFactory

All Implemented Interfaces:

AknHandler, ConfigurationFactory

Direct Known Subclasses:

BitMonitorFactory, LevelMonitorFactory, ListMonitorFactory, RemoteAttributeMonitorFactoryImpl, RemoteValueMonitorFactoryImpl

public abstract class AbstractMonitorFactory
extends AbstractServiceConfigurationFactory<DataItemMonitor>
implements AknHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory

AbstractServiceConfigurationFactory.Entry<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected BundleContext	context
protected EventProcessor	eventProcessor

Constructor Summary

Constructors

Constructor and Description
AbstractMonitorFactory(BundleContext context, servicePool, EventProcessor eventProcessor)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acknowledge(java.lang.String monitorId, OperationParameters operationParameters, java.util.Date aknTimestamp) Perform acknowledge of monitor
protected abstract DataItemMonitor	createInstance(java.lang.String configurationId, EventProcessor eventProcessor)
protected AbstractServiceConfigurationFactory.Entry<DataItemMonitor>	createService(UserInformation userInformation, java.lang.String configurationId, BundleContext context, java.util.Map<java.lang.String,java.lang.String> parameters) Create a new service instance
protected void	disposeService(UserInformation userInformation, java.lang.String id, DataItemMonitor service) Dispose a service
protected AbstractServiceConfigurationFactory.Entry<DataItemMonitor>	updateService(UserInformation userInformation, java.lang.String configurationId, AbstractServiceConfigurationFactory.Entry<DataItemMonitor> entry, java.util.Map<java.lang.String,java.lang.String> parameters) Update a service configuration

Methods inherited from class org.eclipse.scada.ca.common.factory.AbstractServiceConfigurationFactory

delete, dispose, getService, unregisterService, update

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final BundleContext context

eventProcessor

protected final EventProcessor eventProcessor

Constructor Detail

AbstractMonitorFactory

public AbstractMonitorFactory(BundleContext context,
                       servicePool,
                      EventProcessor eventProcessor)

Method Detail

createInstance

protected abstract DataItemMonitor createInstance(java.lang.String configurationId,
                             EventProcessor eventProcessor)

createService

protected AbstractServiceConfigurationFactory.Entry<DataItemMonitor> createService(UserInformation userInformation,
                                                                       java.lang.String configurationId,
                                                                       BundleContext context,
                                                                       java.util.Map<java.lang.String,java.lang.String> parameters)
                                                                            throws java.lang.Exception

Description copied from class: AbstractServiceConfigurationFactory

Create a new service instance

The method must also register the service with the OSGi bundle context if needed. The service registration must then be placed into the result that is returned. This is an optional step. There is no need to register the created service.

Specified by:

createService in class AbstractServiceConfigurationFactory<DataItemMonitor>

configurationId - the configuration id for which the service should be created

context - the bundle context

parameters - the initial parameters

Returns:

a new entry instance which holds the service. This method must never return null

Throws:

java.lang.Exception - if anything goes wrong

disposeService

protected void disposeService(UserInformation userInformation,
                  java.lang.String id,
                  DataItemMonitor service)

Description copied from class: AbstractServiceConfigurationFactory

Dispose a service

If the service entry contains a service handle, the service is automatically unregistered.

Specified by:

disposeService in class AbstractServiceConfigurationFactory<DataItemMonitor>

updateService

protected AbstractServiceConfigurationFactory.Entry<DataItemMonitor> updateService(UserInformation userInformation,
                                                                       java.lang.String configurationId,
                                                                       AbstractServiceConfigurationFactory.Entry<DataItemMonitor> entry,
                                                                       java.util.Map<java.lang.String,java.lang.String> parameters)
                                                                            throws java.lang.Exception

Description copied from class: AbstractServiceConfigurationFactory

Update a service configuration

If a new service entry is returned the old one will get disposed after the call returns

Specified by:

updateService in class AbstractServiceConfigurationFactory<DataItemMonitor>

configurationId - the configuration to update

entry - the original service entry

parameters - the new parameters

Returns:

the new service entry or null if the entry did not change

Throws:

java.lang.Exception - if anything goes wrong

acknowledge

public boolean acknowledge(java.lang.String monitorId,
                  OperationParameters operationParameters,
                  java.util.Date aknTimestamp)

Description copied from interface: AknHandler

Perform acknowledge of monitor

Specified by:

acknowledge in interface AknHandler

Parameters:

monitorId - the monitor to acknowledge

operationParameters - the effective operation parameters

aknTimestamp - the timestamp until which the state is acknowledged

Returns:

true if the monitor was found and processed, false otherwise