org.gecko.util.test

Class ServiceChecker<T>

java.lang.Object

org.gecko.util.test.ServiceChecker<T>

Type Parameters:

T -

public class ServiceChecker<T>
extends java.lang.Object

Helper class that helps waiting for services to create, update or delete. It adds support for blocking using CountDownLatch. Internally it uses the service tracker to Track services

Since:

10.11.2016

Constructor Summary

Constructors

Constructor and Description
ServiceChecker(java.lang.Class<T> serviceClass, BundleContext context) Creates a new instance.
ServiceChecker(Filter filter, BundleContext context) Creates a new instance.
ServiceChecker(java.lang.String filter, BundleContext context) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	awaitCreation() Awaits the service creation to the given timeout
boolean	awaitModification() Awaits the service modification to the given timeout
boolean	awaitRemoval() Awaits the service removal to the given timeout
int	getCreateExpectationCount() Returns the expectation count for create
int	getCreateTimeout() Returns the value for the timeout of a service creation
int	getCurrentCreateCount(boolean wait) Returns the current count, how many times the create of a service was triggered
int	getCurrentModifyCount(boolean wait) Returns the current count, how many times the modification of a service was triggered
int	getCurrentRemoveCount(boolean wait) Returns the current count, how many times the removal of a service was triggered
int	getModifyExpectationCount() Returns the expectation count for service modification
int	getModifyTimeout() Returns the value for the timeout of a service modification
int	getRemovalExpectationCount() Returns the expectation count for service removal
int	getRemoveTimeout() Returns the value for the timeout of a service removal
T	getTrackedService() Returns the tracked service, that maybe null.
<any>	getTrackedServiceReference() Returns the tracked service reference, that maybe null
void	setCreateExpectationCount(int createExpected) Sets the expectation count for service creations.
void	setCreateTimeout(int createTimeout) Sets the timeout in seconds for a service creation
void	setModifyExpectationCount(int modifyExpected) Sets the expectation count for service modification.
void	setModifyTimeout(int modifyTimeout) Sets the timeout in seconds for a service modification
void	setRemovalExpectationCount(int removeExpected) Sets the expectation count for service removals.
void	setRemovalTimeout(int removalTimeout) Sets the timeout in seconds for a service removal
void	start() Starts the checker
void	stop() Stops the service checker

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceChecker

public ServiceChecker(java.lang.Class<T> serviceClass,
                      BundleContext context)

Creates a new instance.

Parameters:

serviceClass - the class to be tracked

context - the bundle context

ServiceChecker

public ServiceChecker(java.lang.String filter,
                      BundleContext context)
               throws InvalidSyntaxException

Creates a new instance.

Parameters:

filter - the filter as string

context - the bundle context

Throws:

InvalidSyntaxException

ServiceChecker

public ServiceChecker(Filter filter,
                      BundleContext context)

Creates a new instance.

Parameters:

filter - the filter

context - the bundle context

Method Detail

getCreateExpectationCount

public int getCreateExpectationCount()

Returns the expectation count for create

Returns:

the expectation count for create

setCreateExpectationCount

public void setCreateExpectationCount(int createExpected)

Sets the expectation count for service creations. 1 or 0 are common values

Parameters:

createExpected - the value that will be expected

getModifyExpectationCount

public int getModifyExpectationCount()

Returns the expectation count for service modification

Returns:

the expectation count for service modification

setModifyExpectationCount

public void setModifyExpectationCount(int modifyExpected)

Sets the expectation count for service modification.

Parameters:

createExpected - the value that will be expected

getRemovalExpectationCount

public int getRemovalExpectationCount()

Returns the expectation count for service removal

Returns:

the expectation count for service removal

setRemovalExpectationCount

public void setRemovalExpectationCount(int removeExpected)

Sets the expectation count for service removals. 1 or 0 are common values

Parameters:

removeExpected - the value that will be expected

getCreateTimeout

public int getCreateTimeout()

Returns the value for the timeout of a service creation

Returns:

the value for the timeout of a service creation

setCreateTimeout

public void setCreateTimeout(int createTimeout)

Sets the timeout in seconds for a service creation

Parameters:

createTimeout - the value to be set

getModifyTimeout

public int getModifyTimeout()

Returns the value for the timeout of a service modification

Returns:

the value for the timeout of a service modification

setModifyTimeout

public void setModifyTimeout(int modifyTimeout)

Sets the timeout in seconds for a service modification

Parameters:

modifyTimeout - the value to be set

getRemoveTimeout

public int getRemoveTimeout()

Returns the value for the timeout of a service removal

Returns:

the value for the timeout of a service removal

setRemovalTimeout

public void setRemovalTimeout(int removalTimeout)

Sets the timeout in seconds for a service removal

Parameters:

removalTimeout - the value to be set

start

public void start()

Starts the checker

stop

public void stop()

Stops the service checker

getTrackedService

public T getTrackedService()

Returns the tracked service, that maybe null. It waits max 1s for the service to come

Returns:

the tracked service, that maybe null

getTrackedServiceReference

public <any> getTrackedServiceReference()

Returns the tracked service reference, that maybe null

Returns:

the tracked service reference, that maybe null

awaitCreation

public boolean awaitCreation()
                      throws java.lang.InterruptedException

Awaits the service creation to the given timeout

Returns:

true, if finished

Throws:

java.lang.InterruptedException

awaitModification

public boolean awaitModification()
                          throws java.lang.InterruptedException

Awaits the service modification to the given timeout

Returns:

true, if finished

Throws:

java.lang.InterruptedException

awaitRemoval

public boolean awaitRemoval()
                     throws java.lang.InterruptedException

Awaits the service removal to the given timeout

Returns:

true, if finished

Throws:

java.lang.InterruptedException

getCurrentCreateCount

public int getCurrentCreateCount(boolean wait)

Returns the current count, how many times the create of a service was triggered

Parameters:

wait - true, if wait till the given create timeout, default is 5 seconds

Returns:

the number of service creations

getCurrentModifyCount

public int getCurrentModifyCount(boolean wait)

Returns the current count, how many times the modification of a service was triggered

Parameters:

wait - true, if wait till the given create timeout, default is 5 seconds

Returns:

the number of service modifications

getCurrentRemoveCount

public int getCurrentRemoveCount(boolean wait)

Returns the current count, how many times the removal of a service was triggered

Parameters:

wait - true, if wait till the given create timeout, default is 5 seconds

Returns:

the number of service removals