Reference

This is the reference documentation for an Alpakka connector. This section should contain a general overview of the connector and mention the libraries and APIs that the connector is using. Also it should link to external resources that might help to learn about the technology the connector is using.

Reported issues

Tagged issues at Github

Artifacts

The Akka dependencies are available from Akka’s library repository. To access them there, you need to configure the URL for this repository.

sbt

resolvers += "Akka library repository".at("https://repo.akka.io/maven")

Maven

<project>
  ...
  <repositories>
    <repository>
      <id>akka-repository</id>
      <name>Akka library repository</name>
      <url>https://repo.akka.io/maven</url>
    </repository>
  </repositories>
</project>

Gradle

repositories {
    mavenCentral()
    maven {
        url "https://repo.akka.io/maven"
    }
}

Additionally, add the dependencies as below.

sbt

val AkkaVersion = "2.10.0"
libraryDependencies ++= Seq(
  "com.lightbend.akka" %% "akka-stream-alpakka-reference" % "9.0.1",
  "com.typesafe.akka" %% "akka-stream" % AkkaVersion
)

Maven

<properties>
  <akka.version>2.10.0</akka.version>
  <scala.binary.version>2.13</scala.binary.version>
</properties>
<dependencies>
  <dependency>
    <groupId>com.lightbend.akka</groupId>
    <artifactId>akka-stream-alpakka-reference_${scala.binary.version}</artifactId>
    <version>9.0.1</version>
  </dependency>
  <dependency>
    <groupId>com.typesafe.akka</groupId>
    <artifactId>akka-stream_${scala.binary.version}</artifactId>
    <version>${akka.version}</version>
  </dependency>
</dependencies>

Gradle

def versions = [
  AkkaVersion: "2.10.0",
  ScalaBinary: "2.13"
]
dependencies {
  implementation "com.lightbend.akka:akka-stream-alpakka-reference_${versions.ScalaBinary}:9.0.1"
  implementation "com.typesafe.akka:akka-stream_${versions.ScalaBinary}:${versions.AkkaVersion}"
}

The table below shows direct dependencies of this module and the second tab shows all libraries it depends on transitively.

Direct dependencies

Organization	Artifact	Version
com.typesafe.akka	akka-stream_2.13	2.10.0
org.scala-lang	scala-library	2.13.12

Dependency tree

com.typesafe.akka    akka-stream_2.13    2.10.0    BUSL-1.1
    com.typesafe.akka    akka-actor_2.13    2.10.0    BUSL-1.1
        com.typesafe    config    1.4.3    Apache-2.0
        org.scala-lang    scala-library    2.13.12    Apache-2.0
    com.typesafe.akka    akka-protobuf-v3_2.13    2.10.0    BUSL-1.1
    org.reactivestreams    reactive-streams    1.0.4    MIT-0
    org.scala-lang    scala-library    2.13.12    Apache-2.0
org.scala-lang    scala-library    2.13.12    Apache-2.0

Reading messages

Give a brief description of the usage of this connector. If you want to mention a class name, make sure to link to the API docs: ReferenceReadResult.

If any of the API classes are different between Scala and Java, link to both API docs: Reference Reference.

Show an example code snippet of how a source of this connector can be created.

Scala

copysourceval settings: SourceSettings = SourceSettings(ClientId)

val source: Source[ReferenceReadResult, Future[Done]] =
  Reference.source(settings)

Java

copysourcefinal SourceSettings settings = SourceSettings.create(clientId);

final Source<ReferenceReadResult, CompletionStage<Done>> source = Reference.source(settings);

Wrap language specific text with language specific directives, like @scala for Scala specific text@java for Java specific text.

Writing messages

Show an example code snippet of how a flow of this connector can be created.

Scala

copysourceval flow: Flow[ReferenceWriteMessage, ReferenceWriteResult, NotUsed] =
  Reference.flow()

Java

copysourcefinal Flow<ReferenceWriteMessage, ReferenceWriteResult, NotUsed> flow = Reference.flow();