acs.benchmark.util

Class ContainerUtil

java.lang.Object

acs.benchmark.util.ContainerUtil

public class ContainerUtil
extends java.lang.Object

Provides direct container access to test code.

The constructors only store parameters. You must call loginToManager() explicitly before using the other methods. * Make sure to call logoutFromManager() when done.

Some methods use JUnit asserts from Assert which means that runtime exceptions such as AssertionFailedError may be thrown.

TODO: Merge with similar class in ACS/LGPL/CommonSoftware/containerTests/contLogTest (which builds before this, but does not get installed).

Author:

hsommer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContainerUtil.ContainerLogLevelSpec Complete logging spec for a container.

Field Summary

Fields

Modifier and Type	Field and Description
protected AcsManagerProxy	adminProxy
protected ContainerServices	containerServices
protected boolean	loggedInToManager
protected AcsLogger	logger
protected ManagerAdminClient	managerAdminClient
protected org.omg.CORBA.ORB	orb

Constructor Summary

Constructors

Constructor and Description
ContainerUtil(ContainerServices cs) Constructor for use as stand-alone application.
ContainerUtil(ContainerServices cs, AcsManagerProxy managerProxy) Constructor for use in a ComponentClientTestCase.

Method Summary

Modifier and Type	Method and Description
java.util.List<ContainerInfo>	getAllContainerInfos()
ContainerDaemonOperations	getContainerDaemon(java.lang.String host)
LoggingConfigurableOperations	getContainerLoggingIF(java.lang.String containerName) Gets a reference to the LoggingConfigurableOperations interface of a container with a given name.
protected void	init(ContainerServices cs, AcsManagerProxy adminProxy) Common to both constructors.
boolean	isContainerLoggedIn(java.lang.String containerName) Asks the manager if the specified container is logged in.
void	loginToManager()
void	logoutFromManager()
java.lang.String	resolveContainerName(java.lang.String componentName) Gets the name of the container running (or configured to run) the component of the given name.
void	setContainerLogLevels(java.lang.String containerName, ContainerUtil.ContainerLogLevelSpec spec) Dynamically configures container log levels, using getContainerLoggingIF(String).
void	startContainer(java.lang.String host, ContainerImplLangType containerType, java.lang.String containerName, java.lang.String flags, boolean waitContainerReady) Starts (possibly remote) containers using container daemons.
void	stopContainer(java.lang.String host, java.lang.String containerName)

Methods inherited from class java.lang.Object

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

Field Detail

containerServices

protected ContainerServices containerServices

logger

protected AcsLogger logger

adminProxy

protected AcsManagerProxy adminProxy

loggedInToManager

protected boolean loggedInToManager

orb

protected org.omg.CORBA.ORB orb

managerAdminClient

protected ManagerAdminClient managerAdminClient

Constructor Detail

ContainerUtil

public ContainerUtil(ContainerServices cs)

Constructor for use as stand-alone application.

Parameters:

cs -

managerLoc -

ContainerUtil

public ContainerUtil(ContainerServices cs,
                     AcsManagerProxy managerProxy)

Constructor for use in a ComponentClientTestCase.

Allows access to the manager as an administrator client, on top of the existing manager connection from managerProxy;

Parameters:

cs -

managerProxy - As inherited from ComponentClientTestCase

See Also:

ManagerAdminClient

Method Detail

init

protected void init(ContainerServices cs,
                    AcsManagerProxy adminProxy)

Common to both constructors.

Parameters:

cs -

adminProxy -

loginToManager

public void loginToManager()
                    throws AcsJContainerEx

Throws:

AcsJContainerEx

logoutFromManager

public void logoutFromManager()

getAllContainerInfos

public java.util.List<ContainerInfo> getAllContainerInfos()
                                                   throws NoPermissionEx,
                                                          AcsJContainerEx

Throws:

NoPermissionEx

AcsJContainerEx

isContainerLoggedIn

public boolean isContainerLoggedIn(java.lang.String containerName)
                            throws AcsJContainerEx,
                                   NoPermissionEx

Asks the manager if the specified container is logged in.

Parameters:

containerName -

Returns:

true if container is logged in.

Throws:

AcsJContainerEx

NoPermissionEx

getContainerLoggingIF

public LoggingConfigurableOperations getContainerLoggingIF(java.lang.String containerName)
                                                    throws AcsJContainerEx,
                                                           NoPermissionEx

Gets a reference to the LoggingConfigurableOperations interface of a container with a given name.

Note that only in test code like here we are allowed to talk directly with the manager. For operational code, the ContainerServices methods must be used and extended if necessary.

Parameters:

containerName -

Throws:

AcsJContainerEx

NoPermissionEx

setContainerLogLevels

public void setContainerLogLevels(java.lang.String containerName,
                                  ContainerUtil.ContainerLogLevelSpec spec)
                           throws AcsJContainerEx,
                                  NoPermissionEx

Dynamically configures container log levels, using getContainerLoggingIF(String).

Parameters:

containerName -

defaultConfig -

namedLoggerConfigs -

Throws:

AcsJContainerEx

NoPermissionEx

resolveContainerName

public java.lang.String resolveContainerName(java.lang.String componentName)
                                      throws AcsJContainerEx,
                                             NoPermissionEx

Gets the name of the container running (or configured to run) the component of the given name.

Throws:

AcsJContainerEx

NoPermissionEx

getContainerDaemon

public ContainerDaemonOperations getContainerDaemon(java.lang.String host)

Parameters:

host -

Returns:

startContainer

public void startContainer(java.lang.String host,
                           ContainerImplLangType containerType,
                           java.lang.String containerName,
                           java.lang.String flags,
                           boolean waitContainerReady)
                    throws AcsJBadParameterEx,
                           AcsJFailedToStartContainerEx

Starts (possibly remote) containers using container daemons.

Note that outside of performance tests it is required to start containers either through the OMC or by the manager in case of CDB-configured autostart containers. Here we do it from application code in order to run flexible tests that don't require a CDB setup.

Similar code from module acscommandcenter (Executor#remoteDaemonForContainers) does not seem to implement synchronization on the container becoming available.

Parameters:

host - Name of container host. Can be null for localhost.

containerType -

containerName -

flags -

waitContainerReady - If true, waits for the container to be ready, as indicated by a callback from the manager (requires prior login to the manager).

Throws:

FailedToStartContainerEx

BadParameterEx

AcsJBadParameterEx

AcsJFailedToStartContainerEx

stopContainer

public void stopContainer(java.lang.String host,
                          java.lang.String containerName)
                   throws BadParameterEx,
                          FailedToStopContainerEx

Parameters:

host - Name of container host. Can be null for localhost.

containerName -

Throws:

BadParameterEx

FailedToStopContainerEx