acs.benchmark.nc.client

Class PubSubExecutor

java.lang.Object

alma.acs.component.client.ComponentClient

acs.benchmark.nc.client.PubSubExecutor

public class PubSubExecutor
extends ComponentClient

Creates and runs publisher and subscriber components as specified in an XML configuration file that must comply with schema pubSubConfig.xsd.

About termination of pub-sub runs:

1. The optional xml attribute numberOfEvents can control how many events a publisher sends or a subscriber receives. This is useful only when these times are short, since this PubSubExecutor will keep open calls to these components.
2. If attribute numberOfEvents is missing or has a non-positive value, then the PubSubExecutor commands all publisher and subscriber components to do their work, and the calls to these components return. This makes sense for longer times. Therefore, if at least one pub/sub component is configured for an unbounded number of events, the method execute(PubSubScenario, long, TimeUnit) must be called with a timeout, so that the pub/sub components can be stopped and their containers as well.

Author:

hsommer

Field Summary

Fields inherited from class alma.acs.component.client.ComponentClient

m_logger, m_shutdownHook

Constructor Summary

Constructors

Constructor and Description
PubSubExecutor() Constructor, which is independent of a concrete pub-sub scenario.

Method Summary

Modifier and Type	Method and Description
void	execute(PubSubScenario scenario) Run the specified pub/sub container and components.
void	execute(PubSubScenario scenario, long executionTimeMax, java.util.concurrent.TimeUnit executionTimeMaxUnit) Run the specified pub/sub container and components.
static void	main(java.lang.String[] args) Parameters: XML config file name.
void	tearDown() This method must be called when done, so that this PubSubExecutor can release resources.

Methods inherited from class alma.acs.component.client.ComponentClient

getContainerServices, initAlarmSystem, initRemoteLogging, registerShutdownHook, tearDownAlarmSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

PubSubExecutor

public PubSubExecutor()
               throws java.lang.Exception

Constructor, which is independent of a concrete pub-sub scenario. This allows one PubSubExecutor to execute more than one scenario.

Throws:

java.lang.Exception

Method Detail

tearDown

public void tearDown()
              throws java.lang.Exception

This method must be called when done, so that this PubSubExecutor can release resources.

Overrides:

tearDown in class ComponentClient

Throws:

java.lang.Exception

See Also:

ComponentClient.tearDown()

execute

public void execute(PubSubScenario scenario)
             throws java.lang.Throwable

Run the specified pub/sub container and components. Since no timeout is passed to this method, one of the following must be true:

• The XML spec contains the (optional) Termination element that defines a timeout, or
• No pub/sub component has an unbounded number of events, which means that all component definitions must contain the numberOfEvents attribute.

Parameters:

scenario -

Throws:

java.lang.Throwable

execute

public void execute(PubSubScenario scenario,
                    long executionTimeMax,
                    java.util.concurrent.TimeUnit executionTimeMaxUnit)
             throws java.lang.Throwable

Run the specified pub/sub container and components. If this method gets called directly (and not by execute(PubSubScenario), the executionTime parameter can overwrite the timeout setting from the XML, or can set a timeout complementary to a finite PubSubSpecCommonT#numberOfEvents.

Throws:

java.lang.Throwable

main

public static void main(java.lang.String[] args)

Parameters:

1. XML config file name.
2. Optional container-host mapping in the form container1=host1:container2=host2.

Parameters:

args -