Aerospike Connect Outbound SDK

An outbound SDK for creating custom transformers for streaming connectors.

Aerospike Connect outbound transformer provides a plugin system in Aerospike outbound connectors to transform incoming XDR change notification records dispatched to the outbound destination with a custom code.

Three transformers can be configured in any combination in the outbound connectors to apply to the incoming Aerospike change notification records dispatched by XDR:

• Routing transformer: Route the record to the outbound destination.
• Record transformer: Transform the contents of the Aerospike record. Transformations include:
  • Add bin
  • Delete bin
  • Change bin value
  • Change key
  • Change metadata (generation, last update time, expiry)
• Format transformer: Transform the Aerospike record into a custom format written to the outbound destination.

The transformers are plugged in by specifying the Java classpath of the custom transformer class in the outbound config YAML file. An optional params map can be specified which will be passed to the constructor of the custom transformer class.

For detailed documentation see Aerospike connector docs

Usage

Add a dependency to this repo in your project. The plugin should be compiled with the same/compatible Java version running the outbound connector.

See the build files in the examples folder for further details.

NOTE It is recommended to shade all the custom plugin dependencies to avoid classpath conflicts with the outbound connectors.

Maven

Use the artifact aerospike-connect-outbound-sdk for all the outbound connectors except Elasticsearch:

<dependency>
    <groupId>com.aerospike</groupId>
    <artifactId>aerospike-connect-outbound-sdk</artifactId>
    <version>2.2.0</version>
    <scope>provided</scope>
</dependency>

Use the artifact aerospike-connect-elasticsearch-outbound-sdk for Elasticsearch outbound:

<dependency>
    <groupId>com.aerospike</groupId>
    <artifactId>aerospike-connect-elasticsearch-outbound-sdk</artifactId>
    <version>2.1.2</version>
    <scope>provided</scope>
</dependency>

Gradle

Kotlin DSL

Use the artifact aerospike-connect-outbound-sdk for all the outbound connectors except Elasticsearch:

dependencies {
    compileOnly("com.aerospike:aerospike-connect-outbound-sdk:2.2.0")
}

Use the artifact aerospike-connect-elasticsearch-outbound-sdk for Elasticsearch outbound:

dependencies {
    compileOnly("com.aerospike:aerospike-connect-elasticsearch-outbound-sdk:2.1.2")
}

Groovy

Use the artifact aerospike-connect-outbound-sdk for all the outbound connectors except Elasticsearch:

dependencies {
    compileOnly "com.aerospike:aerospike-connect-outbound-sdk:2.2.0"
}

Use the artifact aerospike-connect-elasticsearch-outbound-sdk for Elasticsearch outbound:

dependencies {
    compileOnly "com.aerospike:aerospike-connect-elasticsearch-outbound-sdk:2.1.2"
}

Examples

See gradle and maven examples folder.