org.springframework.xd.distributed.util

Interface DistributedTestSupport

All Known Implementing Classes:

DefaultDistributedTestSupport

public interface DistributedTestSupport

Provides support methods for building distributed system tests. Implementations are responsible for starting up infrastructure required for testing across multiple containers.

Author:

Patrick Peralta

Method Summary

Methods

Modifier and Type	Method and Description
SpringXDTemplate	ensureTemplate() Return an instance of SpringXDTemplate based on the port configured for the admin server started by startup().
void	shutdownAll() Shut down all servers started, including those started via startup() and all containers started via startContainer(java.util.Properties).
void	shutdownContainer(long pid) Shut down the container JVM with the given process id.
void	shutdownContainers() Shut down all containers started via startContainer(java.util.Properties).
com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication>	startContainer() Start a container in a new JVM.
com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication>	startContainer(java.util.Properties properties) Start a container in a new JVM, using the provided properties as system properties for the container JVM process.
void	startup() Start the minimum required servers for a distributed XD system: ZooKeeper HSQL Admin server (for serving REST endpoints)
java.util.Map<java.lang.Long,java.lang.String>	waitForContainers() Block the executing thread until all of the container JVMs requested have started.

Method Detail

startup

void startup()

Start the minimum required servers for a distributed XD system:

• ZooKeeper
• HSQL
• Admin server (for serving REST endpoints)

ensureTemplate

SpringXDTemplate ensureTemplate()

Return an instance of SpringXDTemplate based on the port configured for the admin server started by startup().

Returns:

REST template for executing commands against the admin server

startContainer

com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication> startContainer(java.util.Properties properties)

Start a container in a new JVM, using the provided properties as system properties for the container JVM process.

Parameters:

properties - properties to provide to the container process

Returns:

JVM process for new container

startContainer

com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication> startContainer()

Start a container in a new JVM.

Returns:

JVM process for new container

waitForContainers

java.util.Map<java.lang.Long,java.lang.String> waitForContainers()
                                                                 throws java.lang.InterruptedException

Block the executing thread until all of the container JVMs requested have started. This may also be used to ensure that a shut down container JVM process is no longer running.

Returns:

map of process ID to container UUId for currently running container processes

Throws:

java.lang.InterruptedException

See Also:

ServerProcessUtils.waitForContainers(org.springframework.xd.rest.client.impl.SpringXDTemplate, java.util.Set<java.lang.Long>)

shutdownContainer

void shutdownContainer(long pid)

Shut down the container JVM with the given process id.

Parameters:

pid - process id of container JVM to shut down

shutdownContainers

void shutdownContainers()
                        throws java.lang.InterruptedException

Shut down all containers started via startContainer(java.util.Properties). This method will block the executing thread until the admin server indicates that there are no containers running.

Throws:

java.lang.InterruptedException

shutdownAll

void shutdownAll()
                 throws java.lang.InterruptedException

Shut down all servers started, including those started via startup() and all containers started via startContainer(java.util.Properties).

Throws:

java.lang.InterruptedException