acs.benchmark.util

Class ComponentAccessUtil

java.lang.Object

acs.benchmark.util.ComponentAccessUtil

Direct Known Subclasses:

ConcurrentComponentAccessUtil, PubSubComponentAccessUtil

public class ComponentAccessUtil
extends java.lang.Object

A reflection-based convenience class that retrieves components either from the container services or from its own component cache.

Features:

• It restricts the interface to the IDL-derived "xxxOperations" class in order to allow unit testing with mock components or actual component impl classes, without requiring container/corba support.
• Hides the Corba helper class that performs the "narrow". Together with the above point, corba is then completely hidden.
• (TODO) It optionally installs a transparent client-side interceptor that detects runtime problems.
• (TODO) Configurable timeout disconnect from components, with transparent reconnect.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ComponentAccessUtil.CompRefHelper Component reference plus synchronization support for other threads that request the same component reference but must wait until the shared component has been activated.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,ComponentAccessUtil.CompRefHelper>	compName2Comp key = component instance name, value = component reference + sync support for other threads that request the same component.
protected ContainerServices	contSrv
protected java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ComponentAccessUtil(ContainerServices contSrv)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCachedComponentNames() Lists the names of the component instances that have already been retrieved.
java.util.List<ACSComponentOperations>	getCachedComponents()
<T extends ACSComponentOperations> T	getDynamicComponent(ComponentSpec compSpec, java.lang.Class<T> idlOpInterface) Returns the cached reference or the component retrieved from the container services
protected <T extends ACSComponentOperations> T	getDynamicComponentFromContainerServices(ComponentSpec compSpec, java.lang.Class<T> idlOpInterface) Gets the component via contSrv, without using the cache.
protected <T,U extends ACSComponentOperations & ComponentLifecycle> T	initCompImpl(U compImpl, java.lang.Class<T> idlOpInterface) Convenience method for subclasses created by unit tests, that override #getComponentFromContainerServices(String, Class) and need to create and initialize component implementation classes locally inside the test.
void	logInfo()
void	releaseAllComponents(boolean waitForCompsRelease) Should be called when none of the components are needed any more.
void	releaseComponent(java.lang.String compName, boolean waitForCompRelease) Should be called when a component is no longer needed.
void	releaseComponents(java.util.Collection<java.lang.String> componentNames, boolean waitForCompsRelease) Releases a set of components sequentially.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final java.util.logging.Logger logger

contSrv

protected final ContainerServices contSrv

compName2Comp

protected final java.util.Map<java.lang.String,ComponentAccessUtil.CompRefHelper> compName2Comp

key = component instance name, value = component reference + sync support for other threads that request the same component.

This map must be protected from concurrent access.

Constructor Detail

ComponentAccessUtil

public ComponentAccessUtil(ContainerServices contSrv)

Method Detail

getDynamicComponent

public <T extends ACSComponentOperations> T getDynamicComponent(ComponentSpec compSpec,
                                                                java.lang.Class<T> idlOpInterface)
                                                         throws AcsJContainerServicesEx

Returns the cached reference or the component retrieved from the container services

Type Parameters:

T - The IDL-derived component interface

Parameters:

compSpec -

idlOpInterface -

Returns:

Throws:

AcsJContainerServicesEx

getDynamicComponentFromContainerServices

protected <T extends ACSComponentOperations> T getDynamicComponentFromContainerServices(ComponentSpec compSpec,
                                                                                        java.lang.Class<T> idlOpInterface)
                                                                                 throws AcsJContainerServicesEx

Gets the component via contSrv, without using the cache. Can be overridden for tests, to bypass the container services.

Throws:

AcsJContainerServicesEx

getCachedComponentNames

public java.util.List<java.lang.String> getCachedComponentNames()

Lists the names of the component instances that have already been retrieved.

getCachedComponents

public java.util.List<ACSComponentOperations> getCachedComponents()

releaseComponent

public void releaseComponent(java.lang.String compName,
                             boolean waitForCompRelease)

Should be called when a component is no longer needed.

Parameters:

waitForCompRelease - If true this method waits for the complete component release otherwise returns immediately

releaseAllComponents

public void releaseAllComponents(boolean waitForCompsRelease)

Should be called when none of the components are needed any more.

Parameters:

waitForCompsRelease - If true this method waits for the complete components release, otherwise returns immediately.

releaseComponents

public void releaseComponents(java.util.Collection<java.lang.String> componentNames,
                              boolean waitForCompsRelease)

Releases a set of components sequentially.

Subclasses may override this method, see for example ConcurrentComponentAccessUtil.releaseComponents(Collection, boolean), to implement concurrent component release calls, which then also affects releaseAllComponents(boolean).

Parameters:

componentNames - The name of the components to release

waitForCompsRelease - If true this method waits for the complete components release otherwise returns immediately

logInfo

public void logInfo()

initCompImpl

protected <T,U extends ACSComponentOperations & ComponentLifecycle> T initCompImpl(U compImpl,
                                                                                   java.lang.Class<T> idlOpInterface)
                                                                            throws ComponentLifecycleException

Convenience method for subclasses created by unit tests, that override #getComponentFromContainerServices(String, Class) and need to create and initialize component implementation classes locally inside the test.

Throws:

ComponentLifecycleException