cern.laser.business.cache

Interface AlarmCache

All Known Implementing Classes:

ACSAlarmCacheImpl

public interface AlarmCache

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

Method Summary

Modifier and Type	Method and Description
void	close() Close and deallocate the resources.
CategoryActiveList	getActiveListReference(java.lang.Integer identifier) Returns a reference to the active list for a category.
Alarm	getCopy(java.lang.String identifier) Returns a clone of the cached alarm.
Alarm	getReference(java.lang.String identifier) Returns a reference to the cached alarm.
void	initializeAlarmCache(java.util.Map alarms, java.util.Map activeLists) Initializes the alarm cache.
void	invalidate(java.lang.String identifier) Invalidate the cached object.
void	put(Alarm alarm) Puts an object in the cache.
void	removeActiveList(java.lang.Integer identifier) Remove the active list associated with the given category id.
void	replace(Alarm alarm) Puts alarm in the cache.

Method Detail

initializeAlarmCache

void initializeAlarmCache(java.util.Map alarms,
                          java.util.Map activeLists)

Initializes the alarm cache. Can only be called once.

getCopy

Alarm getCopy(java.lang.String identifier)
       throws AlarmCacheException

Returns a clone of the cached alarm.

Parameters:

identifier - the alarm private identifier

Returns:

the cloned alarm object.

Throws:

java.lang.Exception - if the operation can not be performed

AlarmCacheException

getReference

Alarm getReference(java.lang.String identifier)
            throws AlarmCacheException

Returns a reference to the cached alarm.

Parameters:

identifier - the alarm private identifier

Returns:

the reference to the alarm object

Throws:

AlarmCacheException - if the operation cannot be performed

replace

void replace(Alarm alarm)
      throws AlarmCacheException

Puts alarm in the cache. This method must be called after @link acquire as the alarm need to be locked.

Parameters:

alarm - object to put in cache

Throws:

AlarmCacheException - if the operation cannot be performed. However, the lock is released.

put

void put(Alarm alarm)
  throws AlarmCacheException

Puts an object in the cache. If that object was already in the cache it is replaced. This method combines the methods @link acquire, @link replace, and @link release

Parameters:

alarm - the new alarm object

Throws:

java.lang.Exception - if the operation can not be performed

AlarmCacheException

invalidate

void invalidate(java.lang.String identifier)
         throws AlarmCacheException

Invalidate the cached object. Subsequent accesses to that object will cause the object to be loaded again from the ejb.

Parameters:

identifier - the alarm private identifier

Throws:

java.lang.Exception - if the operation can not be performed

AlarmCacheException

getActiveListReference

CategoryActiveList getActiveListReference(java.lang.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.

Throws:

java.lang.Exception - if the operation can not be performed

AlarmCacheException

close

void close()

Close and deallocate the resources.

removeActiveList

void removeActiveList(java.lang.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)

Throws:

java.lang.Exception - if the operation cannot be performed

AlarmCacheException