org.openepics.cable.services

Class NamesServiceCache

java.lang.Object

org.openepics.cable.services.ConcurrentOperationServiceBase

org.openepics.cable.services.NamesServiceCache

All Implemented Interfaces:

Serializable, Names

public class NamesServiceCache
extends ConcurrentOperationServiceBase
implements Names, Serializable

A session bean holding caching the data retrieved from NamesService. This class ensures that the possibly slow read operations from underlying services are not performed more than once in a given session.

Author:

Sunil Sah

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openepics.cable.services.ConcurrentOperationServiceBase

initialized

Constructor Summary

Constructors

Constructor and Description
NamesServiceCache()

Method Summary

Modifier and Type	Method and Description
Set<String>	getActiveNames() Returns a set of all active names
Map<String,org.openepics.names.jaxb.DeviceNameElement>	getAllNames() Returns a map of all names
String	getNameByUuid(String uuid) Returns a name with the given uuid.
NameStatus	getNameStatus(String deviceName) Returns the status of the name.
protected String	getOperation() Extend this function to provide operation used for logging.
protected String	getServiceName() Extend this function to provide service name used for logging.
String	getUuidByName(String name) Returns a uuid of the name.
protected void	initialise()
boolean	isError()
boolean	isValid()
void	refresh() Refreshes the names, for example by clearing cache and reloading
protected boolean	runOperation(String... vargs) Update cache (names, devices).
void	update() Updated name service cache.

Methods inherited from class org.openepics.cable.services.ConcurrentOperationServiceBase

runOperationBlocking, runOperationNonBlocking

Methods inherited from class java.lang.Object

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

Constructor Detail

NamesServiceCache

public NamesServiceCache()

Method Detail

initialise

@PostConstruct
protected void initialise()

Overrides:

initialise in class ConcurrentOperationServiceBase

update

public void update()

Updated name service cache.

getServiceName

protected String getServiceName()

Description copied from class: ConcurrentOperationServiceBase

Extend this function to provide service name used for logging.

Specified by:

getServiceName in class ConcurrentOperationServiceBase

Returns:

the service name.

getOperation

protected String getOperation()

Description copied from class: ConcurrentOperationServiceBase

Extend this function to provide operation used for logging.

Specified by:

getOperation in class ConcurrentOperationServiceBase

Returns:

the operation.

runOperation

protected boolean runOperation(String... vargs)

Update cache (names, devices). Note @Lock(LockType.WRITE) for update of shared resources.

Specified by:

runOperation in class ConcurrentOperationServiceBase

Parameters:

vargs - arguments to pass on to operation

Returns:

true if the operation was successfully run, else false.

isError

public boolean isError()

Specified by:

isError in interface Names

Returns:

true if there was an error constructing a list of names, false otherwise

refresh

public void refresh()

Description copied from interface: Names

Refreshes the names, for example by clearing cache and reloading

Specified by:

refresh in interface Names

getAllNames

public Map<String,org.openepics.names.jaxb.DeviceNameElement> getAllNames()

Description copied from interface: Names

Returns a map of all names

Specified by:

getAllNames in interface Names

Returns:

a map of names

getActiveNames

public Set<String> getActiveNames()

Description copied from interface: Names

Returns a set of all active names

Specified by:

getActiveNames in interface Names

Returns:

a set of names

isValid

public boolean isValid()

Overrides:

isValid in class ConcurrentOperationServiceBase

Returns:

true if the cache contains valid data, else false

getNameStatus

public NameStatus getNameStatus(String deviceName)

Description copied from interface: Names

Returns the status of the name.

Specified by:

getNameStatus in interface Names

Parameters:

deviceName - the name

Returns:

status of the name

getNameByUuid

public String getNameByUuid(String uuid)

Description copied from interface: Names

Returns a name with the given uuid. If the name status is OBSOLETE, null is returned.

Specified by:

getNameByUuid in interface Names

Parameters:

uuid - uuid of the name

Returns:

name of the device or null if not found or obsolete

getUuidByName

public String getUuidByName(String name)

Description copied from interface: Names

Returns a uuid of the name.

Specified by:

getUuidByName in interface Names

Parameters:

name - device name

Returns:

UUID of the name or null if name not found