org.springframework.xd.test.fixtures

Class TcpSink

java.lang.Object

org.springframework.xd.test.fixtures.AbstractModuleFixture<TcpSink>

org.springframework.xd.test.fixtures.TcpSink

All Implemented Interfaces:

Disposable

public class TcpSink
extends AbstractModuleFixture<TcpSink>
implements Disposable

Test fixture that creates a simple socket server, ready to accept connections from a 'tcp' sink module.

Author:

Eric Bottard, Glenn Renfro

Field Summary

Fields inherited from class org.springframework.xd.test.fixtures.AbstractModuleFixture

label

Constructor Summary

Constructors

Constructor and Description
TcpSink() Construct a TcpSink with a port selected by @link AvailableSocketPorts.nextAvailablePort()
TcpSink(int port) Create a TcpSink with the provided port
TcpSink(java.lang.String host, int port) Create a TcpSink with the provided port

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Free up resources that this fixture may have created.
byte[]	getReceivedBytes() Return the bytes received by the sink
TcpSink	start() Create a socket and copy received data into a buffer
protected java.lang.String	toDSL() Returns a representation of the module suitable for inclusion in a stream definition, e.g. file --dir=xxxx --name=yyyy
static TcpSink	withDefaultPort() Construct a TcpSink with the default port of 1234
static TcpSink	withDefaults(java.lang.String host) Construct a TcpSink with the specified host and a default port of 1234

Methods inherited from class org.springframework.xd.test.fixtures.AbstractModuleFixture

label, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpSink

public TcpSink()

Construct a TcpSink with a port selected by @link AvailableSocketPorts.nextAvailablePort()

TcpSink

public TcpSink(java.lang.String host,
       int port)

Create a TcpSink with the provided port

Parameters:

host - used to configure the sink

TcpSink

public TcpSink(int port)

Create a TcpSink with the provided port

Parameters:

port - used to configure the sink

Method Detail

withDefaults

public static TcpSink withDefaults(java.lang.String host)

Construct a TcpSink with the specified host and a default port of 1234

Parameters:

host - the host where tcp data will be sent

Returns:

TcpSink

withDefaultPort

public static TcpSink withDefaultPort()

Construct a TcpSink with the default port of 1234

Returns:

TcpSink

start

public TcpSink start()
              throws java.io.IOException

Create a socket and copy received data into a buffer

Returns:

instance of TcpSink for fluent API chaining

Throws:

java.io.IOException - socket processing errors

getReceivedBytes

public byte[] getReceivedBytes()
                        throws java.io.IOException

Return the bytes received by the sink

Returns:

bytes received by the sink

Throws:

java.io.IOException - exception getting bytes from ByteArrayOutputStream

cleanup

public void cleanup()

Description copied from interface: Disposable

Free up resources that this fixture may have created.

Specified by:

cleanup in interface Disposable

toDSL

protected java.lang.String toDSL()

Description copied from class: AbstractModuleFixture

Returns a representation of the module suitable for inclusion in a stream definition, e.g. file --dir=xxxx --name=yyyy

Specified by:

toDSL in class AbstractModuleFixture<TcpSink>