org.openepics.cable.services

Class ConcurrentOperationServiceBase

java.lang.Object

org.openepics.cable.services.ConcurrentOperationServiceBase

Direct Known Subclasses:

CableValidationService, NamesServiceCache

public abstract class ConcurrentOperationServiceBase
extends Object

This is base for timed services functionality that supports handling timed operations like validation and cache update from concurrent requests.

Author:

Sunil Sah

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized

Constructor Summary

Constructors

Constructor and Description
ConcurrentOperationServiceBase()

Method Summary

Modifier and Type	Method and Description
protected abstract String	getOperation() Extend this function to provide operation used for logging.
protected abstract String	getServiceName() Extend this function to provide service name used for logging.
protected void	initialise()
boolean	isValid()
protected abstract boolean	runOperation(String... vargs) Extend this function to run timed operation.
void	runOperationBlocking(String... vargs) Runs timed operation and returns when finished.
void	runOperationNonBlocking(String... vargs) Runs operation and returns when finished.

Methods inherited from class java.lang.Object

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

Field Detail

initialized

protected boolean initialized

Constructor Detail

ConcurrentOperationServiceBase

public ConcurrentOperationServiceBase()

Method Detail

getServiceName

protected abstract String getServiceName()

Extend this function to provide service name used for logging.

Returns:

the service name.

getOperation

protected abstract String getOperation()

Extend this function to provide operation used for logging.

Returns:

the operation.

runOperation

protected abstract boolean runOperation(String... vargs)

Extend this function to run timed operation.

Parameters:

vargs - arguments to pass on to operation

Returns:

true if the operation was successfully run, else false.

initialise

protected void initialise()

runOperationBlocking

public void runOperationBlocking(String... vargs)

Runs timed operation and returns when finished. If operation is already in progress when the method is invoked, it returns when that operation completes.

Parameters:

vargs - parameters to pass on to opertaion

runOperationNonBlocking

public void runOperationNonBlocking(String... vargs)

Runs operation and returns when finished. If operation is already in progress when the method is invoked, it returns immediately.

Parameters:

vargs - parameters to pass on to opertaion

isValid

public boolean isValid()

Returns:

true if the cache contains valid data, else false