cern::laser::business::cache::AlarmCache Interface Reference

Inheritance diagram for cern::laser::business::cache::AlarmCache:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void initializeAlarmCache (Map alarms, Map activeLists)
Alarm getCopy (String identifier) throws AlarmCacheException
Alarm getReference (String identifier) throws AlarmCacheException
void replace (Alarm alarm) throws AlarmCacheException
void put (Alarm alarm) throws AlarmCacheException
void invalidate (String identifier) throws AlarmCacheException
CategoryActiveList getActiveListReference (Integer identifier) throws AlarmCacheException
void close ()
void removeActiveList (Integer identifier) throws AlarmCacheException

Detailed Description

AlarmImpl cache service class. It defines the interface for the alarm cache which holds alarm plain objects loaded and persisted via the alarm entity beans. Changes to the objects in the cache are propagated and published to the clients.

Author:
fracalde

Member Function Documentation

void cern::laser::business::cache::AlarmCache::close (  ) 

Close and deallocate the resources.

Implemented in com::cosylab::acs::laser::dao::ACSAlarmCacheImpl.

CategoryActiveList cern::laser::business::cache::AlarmCache::getActiveListReference ( Integer  identifier  )  throws AlarmCacheException

Returns a reference to the active list for a category.

Parameters:
identifier the active list private identifier
Returns:
the reference to the active list object.
Exceptions:
Exception if the operation can not be performed

Implemented in com::cosylab::acs::laser::dao::ACSAlarmCacheImpl.

Referenced by cern::laser::business::pojo::CoreServiceImpl::select().

Alarm cern::laser::business::cache::AlarmCache::getCopy ( String  identifier  )  throws AlarmCacheException
Alarm cern::laser::business::cache::AlarmCache::getReference ( String  identifier  )  throws AlarmCacheException

Returns a reference to the cached alarm.

Parameters:
identifier the alarm private identifier
Returns:
the reference to the alarm object
Exceptions:
AlarmCacheException if the operation cannot be performed

Implemented in com::cosylab::acs::laser::dao::ACSAlarmCacheImpl.

Referenced by cern::laser::business::pojo::CoreServiceImpl::archiveSearch(), cern::laser::business::pojo::CoreServiceImpl::getActiveMultiplicityChildren(), cern::laser::business::pojo::CoreServiceImpl::getActiveNodeChildren(), cern::laser::business::pojo::AlarmDefinitionServiceImpl::getAlarmDefinition(), cern::laser::business::pojo::CoreServiceImpl::getAlarmsByCategory(), cern::laser::business::pojo::CoreServiceImpl::getAlarmsByPriority(), cern::laser::business::pojo::CoreServiceImpl::getAlarmsByResponsiblePerson(), cern::laser::business::pojo::CoreServiceImpl::getAlarmsBySource(), cern::laser::business::pojo::CoreServiceImpl::getMultiplicityChildren(), cern::laser::business::pojo::CoreServiceImpl::getMultiplicityParents(), cern::laser::business::pojo::CoreServiceImpl::getMultiplicityThreshold(), cern::laser::business::pojo::CoreServiceImpl::getNodeChildren(), cern::laser::business::pojo::CoreServiceImpl::getNodeParents(), cern::laser::business::pojo::AlarmMessageProcessorImpl::hasActiveMultiplicityParents(), cern::laser::business::pojo::AlarmMessageProcessorImpl::hasActiveNodeParents(), cern::laser::business::pojo::AlarmMessageProcessorImpl::hasTooManyActiveMultiplicityChildren(), cern::laser::business::pojo::AlarmMessageProcessorImpl::processBackup(), cern::laser::business::pojo::CoreServiceImpl::search(), and cern::laser::business::pojo::CoreServiceImpl::select().

void cern::laser::business::cache::AlarmCache::initializeAlarmCache ( Map  alarms,
Map  activeLists 
)

Initializes the alarm cache. Can only be called once.

Implemented in com::cosylab::acs::laser::dao::ACSAlarmCacheImpl.

void cern::laser::business::cache::AlarmCache::invalidate ( String  identifier  )  throws AlarmCacheException
void cern::laser::business::cache::AlarmCache::put ( Alarm  alarm  )  throws AlarmCacheException
void cern::laser::business::cache::AlarmCache::removeActiveList ( Integer  identifier  )  throws AlarmCacheException

Remove the active list associated with the given category id.

Parameters:
identifier the id of the active list to destroy (=category id)
Exceptions:
Exception if the operation cannot be performed

Implemented in com::cosylab::acs::laser::dao::ACSAlarmCacheImpl.

void cern::laser::business::cache::AlarmCache::replace ( Alarm  alarm  )  throws AlarmCacheException

Returns a reference to the alarm specified. The object is locked from modification by other cache users.

Parameters:
identifier the id for the alarm
Returns:
a reference to the alarm
Exceptions:
AlarmCacheException if the operation cannot be performed Releases the lock held on an alarm.
Parameters:
identifier the id for the alarm
Exceptions:
AlarmCacheException if the operation cannot be performed. Puts alarm in the cache. This method must be called after as the alarm need to be locked. alarm object to put in cache AlarmCacheException if the operation cannot be performed. However, the lock is released.

Implemented in com::cosylab::acs::laser::dao::ACSAlarmCacheImpl.


The documentation for this interface was generated from the following file:

Generated by  doxygen 1.6.2