Sources (Spring XD 1.2.1.RELEASE API)

java.lang.Object
- org.springframework.xd.integration.fixtures.ModuleFixture
- - org.springframework.xd.integration.fixtures.Sources

```
public class Sources
extends ModuleFixture
```
A convenience class for creating instances of sources to be used for integration testing. Created with information about hosts and ports from the testing environment. Only supports one admin server and one container location. The RabbitMQ broker is assumed to be at the same location as the admin server.

Author:

Glenn Renfro, Mark Pollack

Constructor Summary

Constructors
Constructor and Description

Sources(XdEnvironment xdEnvironment)
Construct a new Sources instance using the provided environment.

Constructors
Constructor and Description
`Sources(XdEnvironment xdEnvironment)` Construct a new Sources instance using the provided environment.

Method Summary

Methods
Modifier and Type	Method and Description
`SimpleFileSource`	`file(java.lang.String dir, java.lang.String fileName)` Construct a new SimpleFileSource using the provided directory and filename
`GemFireCQSource`	`gemFireCqSource(java.lang.String query)` Constructs a new `GemFireCQSource`.
`GemFireSource`	`gemFireSource(java.lang.String region)` Constructs a new `GemFireSource`.
`SimpleHttpSource`	`http()` Create an instance of the http source with the default target host (localhost) and default port (9000).
`SimpleHttpSource`	`http(java.lang.String host)` Create an instance of the http source with the default target host and default port (9000).
`SimpleHttpSource`	`http(java.lang.String host, int port)` Create an instance of the http source with the default target host and provided port
`SimpleHttpSource`	`httpSource()` Create an instance of the http source with the target host resolved at runtime from the default stream name.
`SimpleHttpSource`	`httpSource(java.lang.String streamName)` Create an instance of the http source with the target host resolved at runtime from the stream name.
`JmsSource`	`jms()` Construct a new JmsSource using the default JMS Broker host and port as specified in the environment
`KafkaSource`	`kafkaSource()` Constructs a new `KafkaSource`
`MqttSource`	`mqtt()` Construct a new MqttSource using the default RabbitMQ (MQTT-enbaled) broker host as specified in the environment.
`RabbitSource`	`rabbitSource()` Construct a new RabbitSource using the environment and defaults.
`SyslogTcpSource`	`syslogTcp()` Constructs a SyslogTcpSource that receives syslog events via tcp.
`SyslogTcpSource`	`syslogTcp(java.lang.String host)` Constructs a SyslogTcpSource that receives syslog events via tcp.
`SyslogTcpSource`	`syslogTcpSource()` Construct a new SyslogTcpSource with the target host resolved at runtime from the default stream name.
`SyslogUdpSource`	`syslogUdp()` Constructs a SyslogUdpSource that receives syslog events via udp using defaults.
`SyslogUdpSource`	`syslogUdp(java.lang.String host)` Constructs a SyslogUdpSource that receives syslog events via udp.
`SyslogUdpSource`	`syslogUdpForContainerHost()` Construct a new SyslogUdpSource with the target host resolved at runtime from the default stream name.
`SimpleTailSource`	`tail(int delayInMillis, java.lang.String fileName)` Construct a new SimpleTailSource with the the provided file name and delay
`Tap`	`tap(java.lang.String streamName)` Constructs a Tap fixture.
`TcpSource`	`tcp()` Construct a new TcpSource with the default target host localhost and port (1234)
`TcpSource`	`tcp(java.lang.String host)` Construct a new TcpSource with the default target host taken from the environment and default port (1234)
`TcpSource`	`tcp(java.lang.String host, int port)` Construct a new TcpSource with the default target host taken from the environment and the provided port.
`TcpClientSource`	`tcpClientSource()` Constructs a new `TcpClientSource`.
`TcpSource`	`tcpSource()` Construct a new TcpSource with the target host resolved at runtime from the default stream name.
`TcpSource`	`tcpSource(java.lang.String streamName)` Construct a new TcpSource with the target host resolved at runtime from the stream name.
`TwitterSearchSource`	`twitterSearch(java.lang.String query)` Construct a TwitterSearchSource using that will search for the query string provided..
`TwitterStreamSource`	`twitterStream()` Construct a TwitterStreamSource fixture..

Methods inherited from class org.springframework.xd.integration.fixtures.ModuleFixture
getContainerResolver, setContainerResolver

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Sources
```
public Sources(XdEnvironment xdEnvironment)
```
    Construct a new Sources instance using the provided environment.
    
    Parameters:
    xdEnvironment - the environment with information on what port/hosts to connect to
- Method Detail
  - http
```
public SimpleHttpSource http()
```
    Create an instance of the http source with the default target host (localhost) and default port (9000).
    
    Returns:
    an instance of HttpSource
  - http
```
public SimpleHttpSource http(java.lang.String host)
```
    Create an instance of the http source with the default target host and default port (9000).
    
    Parameters:
    host - the host ip where http data will be posted.
    
    Returns:
    an instance of HttpSource
  - http
```
public SimpleHttpSource http(java.lang.String host,
                    int port)
```
    Create an instance of the http source with the default target host and provided port
    
    Parameters:
    host - the host ip where http data will be posted.
    port - the port to connect to
    
    Returns:
    an instance of HttpSource
  - httpSource
```
public SimpleHttpSource httpSource(java.lang.String streamName)
```
    Create an instance of the http source with the target host resolved at runtime from the stream name.
    
    Parameters:
    streamName - the name of the stream that has an http source module deployed
    
    Returns:
    an instance of HttpSource configured with host and port of http module deployed at runtime.
  - httpSource
```
public SimpleHttpSource httpSource()
```
    Create an instance of the http source with the target host resolved at runtime from the default stream name.
    
    Returns:
    an instance of HttpSource configured with host and port of http module deployed at runtime.
  - tcp
```
public TcpSource tcp()
```
    Construct a new TcpSource with the default target host localhost and port (1234)
    
    Returns:
    an instance of TcpSource
  - tcp
```
public TcpSource tcp(java.lang.String host)
```
    Construct a new TcpSource with the default target host taken from the environment and default port (1234)
    
    Parameters:
    host - the host ip where tcp data will be posted.
    
    Returns:
    an instance of TcpSource
  - tcp
```
public TcpSource tcp(java.lang.String host,
            int port)
```
    Construct a new TcpSource with the default target host taken from the environment and the provided port.
    
    Parameters:
    host - the host ip where tcp data will be posted.
    port - the port to connect to
    
    Returns:
    an instance of TcpSource
  - tcpSource
```
public TcpSource tcpSource()
```
    Construct a new TcpSource with the target host resolved at runtime from the default stream name.
    
    Returns:
    an instance of TcpSource configured with host and port of tcp module deployed at runtime.
  - tcpSource
```
public TcpSource tcpSource(java.lang.String streamName)
```
    Construct a new TcpSource with the target host resolved at runtime from the stream name.
    
    Parameters:
    streamName - the name of the stream that has an tcp source module deployed
    
    Returns:
    an instance of TcpSource configured with host and port of http module deployed at runtime.
  - tail
```
public SimpleTailSource tail(int delayInMillis,
                    java.lang.String fileName)
```
    Construct a new SimpleTailSource with the the provided file name and delay
    
    Parameters:
    delayInMillis - on platforms that don't wait for a missing file to appear, how often (ms) to look for the file.
    fileName - the absolute path of the file to tail
    
    Returns:
    a tail source
  - jms
```
public JmsSource jms()
```
    Construct a new JmsSource using the default JMS Broker host and port as specified in the environment
    
    Returns:
    a jms source
  - mqtt
```
public MqttSource mqtt()
```
    Construct a new MqttSource using the default RabbitMQ (MQTT-enbaled) broker host as specified in the environment.
    
    Returns:
    a mqtt source
  - file
```
public SimpleFileSource file(java.lang.String dir,
                    java.lang.String fileName)
```
    Construct a new SimpleFileSource using the provided directory and filename
    
    Parameters:
    dir - directory name
    fileName - file name
    
    Returns:
    new SimpleFileSource
  - rabbitSource
```
public RabbitSource rabbitSource()
```
    Construct a new RabbitSource using the environment and defaults.
    
    Returns:
    An instance of the rabbitsource fixture.
  - twitterSearch
```
public TwitterSearchSource twitterSearch(java.lang.String query)
```
    Construct a TwitterSearchSource using that will search for the query string provided..
    
    Parameters:
    query - The string to search for on twitter.
    
    Returns:
    An instance of the twitterSearchSource fixture.
  - twitterStream
```
public TwitterStreamSource twitterStream()
```
    Construct a TwitterStreamSource fixture..
    
    Returns:
    An instance of the twitterStreamSource fixture.
  - syslogTcp
```
public SyslogTcpSource syslogTcp(java.lang.String host)
```
    Constructs a SyslogTcpSource that receives syslog events via tcp.
    
    Parameters:
    host - the ip of the machine where simulated syslog traffic will be sent.
    
    Returns:
    an instance of SyslogTcpSource.
  - syslogTcp
```
public SyslogTcpSource syslogTcp()
```
    Constructs a SyslogTcpSource that receives syslog events via tcp.
    
    Returns:
    an instance of SyslogTcpSource.
  - syslogTcpSource
```
public SyslogTcpSource syslogTcpSource()
```
    Construct a new SyslogTcpSource with the target host resolved at runtime from the default stream name.
    
    Returns:
    an instance of SyslogTcpSource configured with host and port of syslogtcp source deployed at runtime.
  - syslogUdp
```
public SyslogUdpSource syslogUdp(java.lang.String host)
```
    Constructs a SyslogUdpSource that receives syslog events via udp.
    
    Parameters:
    host - the ip of the machine where simulated syslog traffic will be sent.
    
    Returns:
    an instance of SyslogUdpSource.
  - syslogUdp
```
public SyslogUdpSource syslogUdp()
```
    Constructs a SyslogUdpSource that receives syslog events via udp using defaults.
    
    Returns:
    an instance of SyslogUdpSource.
  - syslogUdpForContainerHost
```
public SyslogUdpSource syslogUdpForContainerHost()
```
    Construct a new SyslogUdpSource with the target host resolved at runtime from the default stream name.
    
    Returns:
    an instance of SyslogTcpSource configured with host and port of syslogudp source deployed at runtime.
  - tap
```
public Tap tap(java.lang.String streamName)
```
    Constructs a Tap fixture.
    
    Parameters:
    streamName - The name of stream to tap
    
    Returns:
    Tap fixture
  - gemFireSource
```
public GemFireSource gemFireSource(java.lang.String region)
```
    Constructs a new GemFireSource.
    
    Parameters:
    region - the name of the region bound to this source
    
    Returns:
    a new instance of GemFireSource.
  - gemFireCqSource
```
public GemFireCQSource gemFireCqSource(java.lang.String query)
```
    Constructs a new GemFireCQSource.
    
    Parameters:
    query - the OQL query string bound to this source
    
    Returns:
    a new instance of GemFireCQSource.
  - kafkaSource
```
public KafkaSource kafkaSource()
```
    Constructs a new KafkaSource
    
    Returns:
    a new instance of KafkaSource
  - tcpClientSource
```
public TcpClientSource tcpClientSource()
```
    Constructs a new TcpClientSource.
    
    Returns:
    a new instance of TcpClientSource.

Class Sources

Constructor Summary

Method Summary

Methods inherited from class org.springframework.xd.integration.fixtures.ModuleFixture

Methods inherited from class java.lang.Object

Constructor Detail

Sources

Method Detail

http

http

http

httpSource

httpSource

tcp

tcp

tcp

tcpSource

tcpSource

tail

jms

mqtt

file

rabbitSource

twitterSearch

twitterStream

syslogTcp

syslogTcp

syslogTcpSource

syslogUdp

syslogUdp

syslogUdpForContainerHost

tap

gemFireSource

gemFireCqSource

kafkaSource

tcpClientSource