Spring XD

Spring XD 1.2.0.M1 API

This document is the API specification for Spring XD

See: Description

Packages 
Package Description
org.springframework.batch.integration.x
Package for Batch integration extensions.
org.springframework.batch.step.tasklet.x  
org.springframework.integration.x.gemfire
Package for Gemfire integration extensions.
org.springframework.integration.x.http
Package for batch integration classes.
org.springframework.integration.x.kafka
Package for kafka integration extensions.
org.springframework.integration.x.splunk
Package for Splunk integration extensions.
org.springframework.integration.x.twitter
Package for twitter integration extensions.
org.springframework.xd.analytics.metrics.core
Package for core metrics.
org.springframework.xd.analytics.metrics.integration
Package for metrics integration.
org.springframework.xd.analytics.metrics.memory
Package for in-memory metrics.
org.springframework.xd.analytics.metrics.metadata
Package for metrics' options metadata.
org.springframework.xd.analytics.metrics.redis
Package for Redis based metrics support.
org.springframework.xd.analytics.ml
Package with core abstractions for Machine Learning Support.
org.springframework.xd.batch
Package for XD batch database support.
org.springframework.xd.batch.hsqldb.server
Package for HSQL database server.
org.springframework.xd.batch.item.hadoop
Package for batch item writer for hadoop.
org.springframework.xd.batch.item.jdbc
Package for JDBC item provider.
org.springframework.xd.batch.jdbc  
org.springframework.xd.dirt
Base package for DIRT (Distributed Integration RunTime).
org.springframework.xd.dirt.analytics
Package for DIRT analytics support.
org.springframework.xd.dirt.batch  
org.springframework.xd.dirt.cluster
Package for DIRT cluster.
org.springframework.xd.dirt.container.initializer
Package for container context initializer classes.
org.springframework.xd.dirt.container.store
Package for container metadata store.
org.springframework.xd.dirt.core
Package for DIRT core classes.
org.springframework.xd.dirt.event
Package for DIRT events.
org.springframework.xd.dirt.integration.bus
Package for DIRT classes that integrate with MessageBus.
org.springframework.xd.dirt.integration.bus.converter
Package for DIRT classes that provide message converters used to/from MessageBus.
org.springframework.xd.dirt.integration.bus.local  
org.springframework.xd.dirt.integration.bus.rabbit
Package for classes related to the RabbitMessageBus.
org.springframework.xd.dirt.integration.bus.serializer
Package for DIRT classes that provide serialization/deserialization to/from MessageBus.
org.springframework.xd.dirt.integration.bus.serializer.kryo
Contains classes that provide kryo serialization support to/from MessageBus.
org.springframework.xd.dirt.integration.json  
org.springframework.xd.dirt.integration.kafka  
org.springframework.xd.dirt.integration.rabbit
This package contains an implementation of the MessageBus for RabbitMQ.
org.springframework.xd.dirt.integration.redis
This package contains an implementation of the MessageBus for Redis.
org.springframework.xd.dirt.jdbc.util
Package for DIRT JDBC util classes.
org.springframework.xd.dirt.job
Provides classes that support spring batch admin for DIRT jobs.
org.springframework.xd.dirt.module
Base package for DIRT module.
org.springframework.xd.dirt.module.jmx
Package for DIRT module that provides JMX support.
org.springframework.xd.dirt.module.store
Package for module meta data.
org.springframework.xd.dirt.module.support
Package for DIRT module support.
org.springframework.xd.dirt.modules.metadata
Package for DIRT modules options' metadata.
org.springframework.xd.dirt.plugins
Base Package for Spring XD plugins.
org.springframework.xd.dirt.plugins.job
Contains classes that support Spring Batch for Job plugins.
org.springframework.xd.dirt.plugins.job.support
Contains classes for improved Spring Batch support.
org.springframework.xd.dirt.plugins.job.support.listener
Contains classes that support listeners for DIRT job lifecycle events.
org.springframework.xd.dirt.plugins.spark.streaming
Package for spark streaming plugin support.
org.springframework.xd.dirt.plugins.stream
Package for Stream plugins.
org.springframework.xd.dirt.rest
Provides a REST API for interacting with the XD runtime.
org.springframework.xd.dirt.rest.meta  
org.springframework.xd.dirt.rest.metrics
Provides a REST API for XD metrics.
org.springframework.xd.dirt.rest.security  
org.springframework.xd.dirt.rest.validation
Provides server-side validation REST end-points.
org.springframework.xd.dirt.server
Base package for DIRT server.
org.springframework.xd.dirt.server.admin
Base package for XD admin server.
org.springframework.xd.dirt.server.admin.deployment
Base package for deployment classes used by admin server.
org.springframework.xd.dirt.server.admin.deployment.zk
Base package for classes that are used for ZK based deployment.
org.springframework.xd.dirt.server.container
Base package for XD container server.
org.springframework.xd.dirt.server.options
Package for DIRT server options.
org.springframework.xd.dirt.server.security  
org.springframework.xd.dirt.spark  
org.springframework.xd.dirt.stream
Base package for processing DeploymentUnit (Stream/Job).
org.springframework.xd.dirt.stream.completion
Package for code completion provider for Stream/Job and their module names/options when used in Shell.
org.springframework.xd.dirt.stream.dsl
Base package for processing DeploymentUnit(Stream/Job) DSL.
org.springframework.xd.dirt.stream.zookeeper
Package for DeploymentUnit(Stream/Job)'s Zookeeper based repositories.
org.springframework.xd.dirt.test
Package for DIRT test classes.
org.springframework.xd.dirt.test.process
Package for processing chain test support.
org.springframework.xd.dirt.test.sink
Package for test support sink that binds to named channel.
org.springframework.xd.dirt.test.source
Package for test support source that binds to named channel.
org.springframework.xd.dirt.util
Package for DIRT utils.
org.springframework.xd.dirt.util.logging  
org.springframework.xd.dirt.web
Contains Spring MVC related classes, e.g.
org.springframework.xd.dirt.web.config
Contains Java Configuration classes.
org.springframework.xd.dirt.web.controller
Contains Spring MVC web controllers.
org.springframework.xd.dirt.web.controller.support
Contains various support classes for the web-ui controllers.
org.springframework.xd.dirt.zookeeper
Package for DIRT Zookeeper support.
org.springframework.xd.distributed.util
Package for distributed test utility classes.
org.springframework.xd.documentation  
org.springframework.xd.extension.process  
org.springframework.xd.extension.script  
org.springframework.xd.gemfire
Package for gemfire extensions.
org.springframework.xd.gemfire.server
Contains a simple driver application to run a Gemfire server.
org.springframework.xd.gpload  
org.springframework.xd.hadoop.fs
Package for hadoop FS related classes.
org.springframework.xd.http
Package for http extensions.
org.springframework.xd.integration.fixtures
Base package for integration fixtures.
org.springframework.xd.integration.hadoop
Base package for Hadoop/HDFS support.
org.springframework.xd.integration.hadoop.config
Provides classes for configuration - parsers, namespace handlers, factory beans.
org.springframework.xd.integration.hadoop.expression
Package for HDFS Partitioning expression support.
org.springframework.xd.integration.hadoop.outbound
Provides classes supporting outbound endpoints.
org.springframework.xd.integration.hadoop.partition
Package for HDFS Partitioning support.
org.springframework.xd.integration.reactor.config
Package for Reactor integration configurations.
org.springframework.xd.integration.reactor.net
Package for Reactor integration for network-aware server.
org.springframework.xd.integration.reactor.syslog
Package for Reactor integration for syslog.
org.springframework.xd.integration.throughput
Package for throughput sampler extensions.
org.springframework.xd.integration.util
Package for integration test utility.
org.springframework.xd.integration.util.jmxresult
Package for processing integration tests' JMX result.
org.springframework.xd.jdbc
Package for JDBC extensions.
org.springframework.xd.mail
Package for Mail module extensions.
org.springframework.xd.module
Root package of the Module support.
org.springframework.xd.module.core
Contains the Module core classes.
org.springframework.xd.module.info  
org.springframework.xd.module.options
Contains the ModuleOption related classes.
org.springframework.xd.module.options.mixins
A set of reusable mixins for defining module options metadata.
org.springframework.xd.module.options.spi
SPI for Module Options.
org.springframework.xd.module.options.types
Contains custom module option types.
org.springframework.xd.module.spark.streaming
Package for Spark module implementations.
org.springframework.xd.module.support
Contains support classes for the Module support
org.springframework.xd.mongodb
Package for mongodb extensions.
org.springframework.xd.redis  
org.springframework.xd.rest.client
Defines the various REST client operation interfaces.
org.springframework.xd.rest.client.impl
Contains REST client operation implementations.
org.springframework.xd.rest.client.impl.support
Contains support classes for the Rest client, e.g.
org.springframework.xd.rest.domain
Contains the resources managed by the REST API.
org.springframework.xd.rest.domain.meta  
org.springframework.xd.rest.domain.metrics
Package for Rest domain metrics classes.
org.springframework.xd.rest.domain.security
Contains the security-related resources managed by the REST API.
org.springframework.xd.rest.domain.support
Package for rest domain support classes.
org.springframework.xd.rest.domain.util
Package for common rest domain util classes.
org.springframework.xd.rest.domain.validation
Package for rest domain classes used for server-side validation purposes.
org.springframework.xd.rxjava  
org.springframework.xd.shell
Package for core Spring XD Shell classes.
org.springframework.xd.shell.command
Package for various Spring XD Shell commands.
org.springframework.xd.shell.command.support
Provides support classes for the various shell commands.
org.springframework.xd.shell.converter
Contains Shell converter classes.
org.springframework.xd.shell.hadoop
Package for Hadoop Shell command classes.
org.springframework.xd.shell.util
Contains utilities for rendering textual contents (example: text tables), to the console.
org.springframework.xd.spark
Package for XD spark extensions.
org.springframework.xd.spark.streaming
Package for spark streaming integration.
org.springframework.xd.spark.streaming.examples.java
Package for spark streaming java based examples.
org.springframework.xd.spark.streaming.java
Package for java based spark streaming integration support.
org.springframework.xd.spark.tasklet
Package for spark tasklets.
org.springframework.xd.splunk
Package for Splunk extensions.
org.springframework.xd.sqoop
Package for XD sqoop extensions.
org.springframework.xd.store
Package for analytics repository.
org.springframework.xd.syslog
Package for SYSLOG extensions.
org.springframework.xd.tcp
Package for TCP extensions.
org.springframework.xd.test
Contains test support classes.
org.springframework.xd.test.fixtures
Contains integration test fixtures classes.
org.springframework.xd.test.fixtures.util
Contains test fixture utility classes.
org.springframework.xd.test.generator
utilities to generate load on a server
org.springframework.xd.test.kafka
Contains Kafka test support classes.
org.springframework.xd.test.mqtt
Contains MQTT test support classes.
org.springframework.xd.test.rabbit
Contains Rabbit test support classes.
org.springframework.xd.test.redis
Contains Redis support classes.
org.springframework.xd.tuple
Base package for tuple classes.
org.springframework.xd.tuple.batch
Contains tuple batch classes.
org.springframework.xd.tuple.integration
Contains classes that supports tuple integration such as tuple transformers etc.,
org.springframework.xd.tuple.processor
Contains tuple processor classes.
org.springframework.xd.tuple.spel
Contains tuple SpEL accessor classes.
org.springframework.xd.yarn  
spark  
Spring XD