XdEnvironment (Spring XD 1.3.0.RELEASE API)

java.lang.Object
- org.springframework.xd.integration.util.XdEnvironment

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware
```
public class XdEnvironment
extends java.lang.Object
implements org.springframework.beans.factory.BeanClassLoaderAware
```
Extracts the host and port information for the XD Instances. Assumes that the host that runs the RabbitMQ broker is the same host that runs the admin server.

Author:

Glenn Renfro

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HTTP_PREFIX`
`static java.lang.String`	`RESULT_LOCATION`
`static java.lang.String`	`XD_ADMIN_HOST`
`static java.lang.String`	`XD_HTTP_PORT`
`static java.lang.String`	`XD_JMX_PORT`

Constructor Summary

Constructors
Constructor and Description

XdEnvironment()

Constructors
Constructor and Description
`XdEnvironment()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.net.URL`	`getAdminServerUrl()`
`java.lang.String`	`getBaseDir()`
`java.lang.String`	`getContainerLogLocation()`
`java.lang.String`	`getDataNodePort()` The hadoop data node port that is available for this environment.
`javax.sql.DataSource`	`getDataSource()`
`java.lang.String`	`getGemfireHost()` Retrieves the Gemfire host.
`int`	`getGemfirePort()` Retrieves the Gemfire port.
`int`	`getHttpPort()`
`java.lang.String`	`getJmsHost()`
`int`	`getJmsPort()`
`int`	`getJmxPort()`
`java.lang.String`	`getKafkaBrokerList()` Retrieves the Kafka Broker List.
`java.lang.String`	`getKafkaZkConnect()` Retrieves the Kafka ZK Connection String.
`org.springframework.data.mongodb.MongoDbFactory`	`getMongoDbFactory()` The mongo db factory to be used for the tests.
`java.lang.String`	`getMongoHost()` Retrieves the host where the mongo server is running.
`java.lang.String`	`getMongoPort()` Retrieves the port that the mongo server is monitoring.
`java.lang.String`	`getNameNode()` The hadoop name node that is available for this environment.
`java.lang.String`	`getPrivateKey()`
`org.springframework.amqp.rabbit.connection.CachingConnectionFactory`	`getRabbitConnectionFactory()`
`java.lang.String`	`getRabbitMQHost()` Default value is the same as the admin server host.
`java.lang.String`	`getSparkAppJar()` Retrieves the location of the SparkApp Jar
`java.lang.String`	`getSparkAppJarSource()` Retrieves the location of the spark app jar to be used for the test.
`java.lang.String`	`getSparkAppMainClass()` Retrieves the package.class of the Spark App
`java.lang.String`	`getSparkAppName()` Retrieves the name associated with the Spark App
`java.lang.String`	`getSparkMaster()` Retrieves URI (spark://host:port or the local setting (local[x]) for the spark master
`java.lang.String`	`getTcpClientHost()` Retrieves the TCP Client host.
`int`	`getTcpClientPort()` Retrieves the TCP Client port.
`java.lang.String`	`getTwitterAccessToken()` The Twitter Access Token
`java.lang.String`	`getTwitterAccessTokenSecret()` The Twitter Access Token Secret
`java.lang.String`	`getTwitterConsumerKey()` The twitter consumer key
`java.lang.String`	`getTwitterConsumerSecretKey()` The twitter consumer secret key
`void`	`initalizeEc2Environment()` If not running tests on a local XD Instance it will retrieve the information from the artifact and setup the environment to test against a remote XD.
`boolean`	`isOnEc2()`
`void`	`setBeanClassLoader(java.lang.ClassLoader beanClassLoader)`

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

- Field Detail
  - XD_ADMIN_HOST
```
public static final java.lang.String XD_ADMIN_HOST
```
    See Also:
    Constant Field Values
  - XD_HTTP_PORT
```
public static final java.lang.String XD_HTTP_PORT
```
    See Also:
    Constant Field Values
  - XD_JMX_PORT
```
public static final java.lang.String XD_JMX_PORT
```
    See Also:
    Constant Field Values
  - RESULT_LOCATION
```
public static final java.lang.String RESULT_LOCATION
```
    See Also:
    Constant Field Values
  - HTTP_PREFIX
```
public static final java.lang.String HTTP_PREFIX
```
    See Also:
    Constant Field Values
- Constructor Detail
  - XdEnvironment
```
public XdEnvironment()
```
- Method Detail
  - initalizeEc2Environment
```
@PostConstruct
public void initalizeEc2Environment()
                             throws java.net.MalformedURLException
```
    If not running tests on a local XD Instance it will retrieve the information from the artifact and setup the environment to test against a remote XD. Als initializes the dataSource for JDBC Tests.
    
    Throws:
    
    java.net.MalformedURLException
  - setBeanClassLoader
```
public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
```
    Specified by:
    
    setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware
  - getAdminServerUrl
```
public java.net.URL getAdminServerUrl()
```
  - getJmxPort
```
public int getJmxPort()
```
  - getHttpPort
```
public int getHttpPort()
```
  - getPrivateKey
```
public java.lang.String getPrivateKey()
```
  - isOnEc2
```
public boolean isOnEc2()
```
  - getContainerLogLocation
```
public java.lang.String getContainerLogLocation()
```
  - getBaseDir
```
public java.lang.String getBaseDir()
```
  - getDataSource
```
public javax.sql.DataSource getDataSource()
```
  - getRabbitConnectionFactory
```
public org.springframework.amqp.rabbit.connection.CachingConnectionFactory getRabbitConnectionFactory()
```
  - getJmsHost
```
public java.lang.String getJmsHost()
```
  - getJmsPort
```
public int getJmsPort()
```
  - getRabbitMQHost
```
public java.lang.String getRabbitMQHost()
```
    Default value is the same as the admin server host.
    
    Returns:
    the host where the rabbitmq broker is running.
  - getTwitterConsumerKey
```
public java.lang.String getTwitterConsumerKey()
```
    The twitter consumer key
    
    Returns:
    consumer key
  - getTwitterConsumerSecretKey
```
public java.lang.String getTwitterConsumerSecretKey()
```
    The twitter consumer secret key
    
    Returns:
    consumer secret key
  - getTwitterAccessToken
```
public java.lang.String getTwitterAccessToken()
```
    The Twitter Access Token
    
    Returns:
    twitter access token
  - getTwitterAccessTokenSecret
```
public java.lang.String getTwitterAccessTokenSecret()
```
    The Twitter Access Token Secret
    
    Returns:
    twitter access token secret
  - getNameNode
```
public java.lang.String getNameNode()
```
    The hadoop name node that is available for this environment.
    
    Returns:
    the hadoop name node.
  - getDataNodePort
```
public java.lang.String getDataNodePort()
```
    The hadoop data node port that is available for this environment.
    
    Returns:
    the data node port.
  - getMongoDbFactory
```
public org.springframework.data.mongodb.MongoDbFactory getMongoDbFactory()
```
    The mongo db factory to be used for the tests.
    
    Returns:
    The current mongoDbFactory instance.
  - getMongoHost
```
public java.lang.String getMongoHost()
```
    Retrieves the host where the mongo server is running.
    
    Returns:
    the mongo host
  - getMongoPort
```
public java.lang.String getMongoPort()
```
    Retrieves the port that the mongo server is monitoring.
    
    Returns:
    the mongo server port.
  - getGemfireHost
```
public java.lang.String getGemfireHost()
```
    Retrieves the Gemfire host.
    
    Returns:
    the host
  - getGemfirePort
```
public int getGemfirePort()
```
    Retrieves the Gemfire port.
    
    Returns:
    the port
  - getKafkaBrokerList
```
public java.lang.String getKafkaBrokerList()
```
    Retrieves the Kafka Broker List.
    
    Returns:
    the kafka broker list
  - getKafkaZkConnect
```
public java.lang.String getKafkaZkConnect()
```
    Retrieves the Kafka ZK Connection String.
    
    Returns:
    the kafka ZK Connection String
  - getTcpClientPort
```
public int getTcpClientPort()
```
    Retrieves the TCP Client port.
    
    Returns:
    the port
  - getTcpClientHost
```
public java.lang.String getTcpClientHost()
```
    Retrieves the TCP Client host.
    
    Returns:
    the host
  - getSparkAppName
```
public java.lang.String getSparkAppName()
```
    Retrieves the name associated with the Spark App
    
    Returns:
    string containing the spark app name
  - getSparkAppJar
```
public java.lang.String getSparkAppJar()
```
    Retrieves the location of the SparkApp Jar
    
    Returns:
    the location of the spark app jar.
  - getSparkMaster
```
public java.lang.String getSparkMaster()
```
    Retrieves URI (spark://host:port or the local setting (local[x]) for the spark master
    
    Returns:
    the spark master to be used by the test.
  - getSparkAppMainClass
```
public java.lang.String getSparkAppMainClass()
```
    Retrieves the package.class of the Spark App
    
    Returns:
    package and class of the spark app
  - getSparkAppJarSource
```
public java.lang.String getSparkAppJarSource()
```
    Retrieves the location of the spark app jar to be used for the test.
    
    Returns:
    The location of the spark app jar to be used for the test.

Class XdEnvironment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XD_ADMIN_HOST

XD_HTTP_PORT

XD_JMX_PORT

RESULT_LOCATION

HTTP_PREFIX

Constructor Detail

XdEnvironment

Method Detail

initalizeEc2Environment

setBeanClassLoader

getAdminServerUrl

getJmxPort

getHttpPort

getPrivateKey

isOnEc2

getContainerLogLocation

getBaseDir

getDataSource

getRabbitConnectionFactory

getJmsHost

getJmsPort

getRabbitMQHost

getTwitterConsumerKey

getTwitterConsumerSecretKey

getTwitterAccessToken

getTwitterAccessTokenSecret

getNameNode

getDataNodePort

getMongoDbFactory

getMongoHost

getMongoPort

getGemfireHost

getGemfirePort

getKafkaBrokerList

getKafkaZkConnect

getTcpClientPort

getTcpClientHost

getSparkAppName

getSparkAppJar

getSparkMaster

getSparkAppMainClass

getSparkAppJarSource