org.springframework.xd.distributed.util

Class ServerProcessUtils

java.lang.Object

org.springframework.xd.distributed.util.ServerProcessUtils

public class ServerProcessUtils
extends java.lang.Object

Collection of utilities for starting external processes required for a distributed XD system.

Author:

Patrick Peralta

Constructor Summary

Constructors

Constructor and Description
ServerProcessUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Map<java.lang.Long,java.lang.String>	getRunningContainers(SpringXDTemplate template) Return a map of running containers.
static com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication>	startAdmin(java.util.Properties properties) Start an instance of the admin server.
static com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication>	startContainer(java.util.Properties properties) Start a container instance.
static com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication>	startHsql(java.util.Properties systemProperties) Start an instance of HSQL.
static org.apache.curator.test.TestingServer	startZooKeeper(int port) Start an instance of ZooKeeper.
static java.util.Map<java.lang.Long,java.lang.String>	waitForContainers(SpringXDTemplate template, java.util.Set<java.lang.Long> pids) Block the executing thread until all of the indicated process IDs have been identified in the list of runtime containers as indicated by the admin server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerProcessUtils

public ServerProcessUtils()

Method Detail

startZooKeeper

public static org.apache.curator.test.TestingServer startZooKeeper(int port)
                                                            throws java.lang.Exception

Start an instance of ZooKeeper. Upon test completion, the method TestingServer.stop() should be invoked to shut down the server.

Parameters:

port - ZooKeeper port

Returns:

ZooKeeper testing server

Throws:

java.lang.Exception

startAdmin

public static com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication> startAdmin(java.util.Properties properties)
                                                                                                                     throws java.io.IOException,
                                                                                                                            java.lang.InterruptedException

Start an instance of the admin server. This method will block until the admin server is capable of processing HTTP requests. Upon test completion, the method Application.close() should be invoked to shut down the server.

Parameters:

properties - system properties to pass to the container; at minimum must contain key zk.client.connect to indicate the ZooKeeper connect string and key server.port to indicate the admin server port

Returns:

admin server application reference

Throws:

java.io.IOException - if an exception is thrown launching the process

java.lang.InterruptedException - if the executing thread is interrupted

startContainer

public static com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication> startContainer(java.util.Properties properties)
                                                                                                                         throws java.io.IOException

Start a container instance. Upon test completion, the method Application.close() should be invoked to shut down the server. This method may also be invoked as part of failover testing.

Note that this method returns immediately. In order to verify that the container was started, invoke waitForContainers(org.springframework.xd.rest.client.impl.SpringXDTemplate, java.util.Set<java.lang.Long>) to block until the container(s) are started.

Parameters:

properties - system properties to pass to the admin server; at minimum must contain key zk.client.connect to indicate the ZooKeeper connect string

Returns:

container server application reference

Throws:

java.io.IOException - if an exception is thrown launching the process

See Also:

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

startHsql

public static com.oracle.tools.runtime.java.JavaApplication<com.oracle.tools.runtime.java.SimpleJavaApplication> startHsql(java.util.Properties systemProperties)
                                                                                                                    throws java.io.IOException

Start an instance of HSQL. Upon test completion, the method Application.close() should be invoked to shut down the server.

Parameters:

systemProperties - system properties for new process

Returns:

HSQL server application reference

Throws:

java.io.IOException - if an exception is thrown launching the process

waitForContainers

public static java.util.Map<java.lang.Long,java.lang.String> waitForContainers(SpringXDTemplate template,
                                                               java.util.Set<java.lang.Long> pids)
                                                                        throws java.lang.InterruptedException,
                                                                               java.lang.IllegalStateException

Block the executing thread until all of the indicated process IDs have been identified in the list of runtime containers as indicated by the admin server. If an empty list is provided, the executing thread will block until there are no containers running.

Parameters:

template - REST template used to communicate with the admin server

pids - set of process IDs for the expected containers

Returns:

map of process id to container id

Throws:

java.lang.InterruptedException - if the executing thread is interrupted

java.lang.IllegalStateException - if the number of containers identified does not match the number of PIDs provided

getRunningContainers

public static java.util.Map<java.lang.Long,java.lang.String> getRunningContainers(SpringXDTemplate template)

Return a map of running containers. Map key is pid; value is the container ID.

Parameters:

template - REST template used to communicate with the admin server

Returns:

map of process id to container id