org.springframework.xd.integration.util

Class StreamUtils

java.lang.Object

org.springframework.xd.integration.util.StreamUtils

public class StreamUtils
extends java.lang.Object

Utilities for creating and monitoring streams and the JMX hooks for those strings.

Author:

Glenn Renfro

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TMP_DIR

Constructor Summary

Constructors

Constructor and Description
StreamUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	destroyAllStreams(java.net.URL adminServer) Removes all the streams from the cluster.
static java.lang.String	httpGet(java.net.URL url) Executes a http get for the client and returns the results as a string
static boolean	isStreamDeployed(java.lang.String streamName, java.net.URL adminServer) Checks to see if the specified stream is deployed on the XD cluster.
static java.net.URL	replacePort(java.net.URL url, int port) Substitutes the port associated with the URL with another port.
static void	stream(java.lang.String streamName, java.lang.String streamDefinition, java.net.URL adminServer) Creates the stream definition and deploys it to the cluster being tested.
static java.lang.String	transferResultsToLocal(XdEnvironment xdEnvironment, java.net.URL url, java.lang.String fileName) Copies the specified file from a remote machine to local machine.
static void	undeployStream(java.net.URL adminServer, java.lang.String streamName) Undeploys the specified stream name
static boolean	waitForStreamDeployment(java.lang.String streamName, java.net.URL adminServer, int waitTime) Waits up to the wait time for a stream to be deployed.

Methods inherited from class java.lang.Object

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

Field Detail

TMP_DIR

public static final java.lang.String TMP_DIR

See Also:

Constant Field Values

Constructor Detail

StreamUtils

public StreamUtils()

Method Detail

stream

public static void stream(java.lang.String streamName,
          java.lang.String streamDefinition,
          java.net.URL adminServer)

Creates the stream definition and deploys it to the cluster being tested.

Parameters:

streamName - The name of the stream

streamDefinition - The definition that needs to be deployed for this stream.

adminServer - The admin server that this stream will be deployed against.

httpGet

public static java.lang.String httpGet(java.net.URL url)

Executes a http get for the client and returns the results as a string

Parameters:

url - The location to execute the get against.

Returns:

the string result of the get

destroyAllStreams

public static void destroyAllStreams(java.net.URL adminServer)

Removes all the streams from the cluster. Used to guarantee a clean acceptance test.

Parameters:

adminServer - The admin server that the command will be executed against.

undeployStream

public static void undeployStream(java.net.URL adminServer,
                  java.lang.String streamName)

Undeploys the specified stream name

Parameters:

adminServer - The admin server that the command will be executed against.

streamName - The name of the stream to undeploy

transferResultsToLocal

public static java.lang.String transferResultsToLocal(XdEnvironment xdEnvironment,
                                      java.net.URL url,
                                      java.lang.String fileName)

Copies the specified file from a remote machine to local machine.

Parameters:

xdEnvironment - The environment configuration for this test

url - The remote machine's url.

fileName - The fully qualified file name of the file to be transferred.

Returns:

The location to the fully qualified file name where the remote file was copied.

replacePort

public static java.net.URL replacePort(java.net.URL url,
                       int port)

Substitutes the port associated with the URL with another port.

Parameters:

url - The URL that needs a port replaced.

port - The new port number

Returns:

A new URL with the host from the URL passed in and the new port.

waitForStreamDeployment

public static boolean waitForStreamDeployment(java.lang.String streamName,
                              java.net.URL adminServer,
                              int waitTime)

Waits up to the wait time for a stream to be deployed.

Parameters:

streamName - The name of the stream to be evaluated.

adminServer - The admin server URL that will be queried.

waitTime - the amount of time in millis to wait.

Returns:

true if the stream is deployed else false.

isStreamDeployed

public static boolean isStreamDeployed(java.lang.String streamName,
                       java.net.URL adminServer)

Checks to see if the specified stream is deployed on the XD cluster.

Parameters:

streamName - The name of the stream to be evaluated.

adminServer - The admin server URL that will be queried.

Returns:

true if the stream is deployed else false