Skip to content

Commit

Permalink
Docs sync 20241020 (#454)
Browse files Browse the repository at this point in the history
Co-authored-by: urfreespace <urfreespace@users.noreply.github.com>
  • Loading branch information
streamnativebot and urfreespace authored Oct 22, 2024
1 parent fd40a15 commit 3d610c8
Show file tree
Hide file tree
Showing 42 changed files with 3,299 additions and 51 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags: apache-pulsar,pulsar-io,source-connector,sink-connector,apache-activemq
alias: ActiveMQ sink connector
features: ["ActiveMQ Connector integrates Apache Pulsar with Apache ActiveMQ. "]
icon: "/images/connectors/activemq_logo_white_vertical.jpg"
download: https://api.github.com/repos/streamnative/pulsar-io-activemq/tarball/refs/tags/v3.0.6.8
download: https://api.github.com/repos/streamnative/pulsar-io-activemq/tarball/refs/tags/v3.0.7.1
support: streamnative
support_link: https://github.com/streamnative/pulsar-io-activemq
support_img: "https://avatars.githubusercontent.com/u/44651383?v=4"
Expand Down
172 changes: 172 additions & 0 deletions connectors/activemq-sink/v4.0.0.1/io-activemq-sink.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
---
description: ActiveMQ Connector integrates Apache Pulsar with Apache ActiveMQ.
author: StreamNative
contributors: gaoran10,shibd,dependabot[bot],sijie
language: Java,Shell,Dockerfile
document:
source: https://github.com/streamnative/pulsar-io-activemq
license: Apache License 2.0
license_link: https://github.com/streamnative/pulsar-io-activemq/blob/master/LICENSE
tags: apache-pulsar,pulsar-io,source-connector,sink-connector,apache-activemq
alias: ActiveMQ sink connector
features: ["ActiveMQ Connector integrates Apache Pulsar with Apache ActiveMQ. "]
icon: "/images/connectors/activemq_logo_white_vertical.jpg"
download: https://api.github.com/repos/streamnative/pulsar-io-activemq/tarball/refs/tags/v4.0.0.1
support: streamnative
support_link: https://github.com/streamnative/pulsar-io-activemq
support_img: "https://avatars.githubusercontent.com/u/44651383?v=4"
owner_name: "streamnative"
owner_img: "https://avatars.githubusercontent.com/u/44651383?v=4"
dockerfile: https://hub.docker.com/r/streamnative/pulsar-io-activemq
sn_available: ""
id: "io-activemq-sink"
---


The ActiveMQ sink connector pulls messages from Pulsar topics and persist messages to ActiveMQ.

# Installation

```
git clone https://github.com/streamnative/pulsar-io-activemq.git
cd pulsar-io-activemq/
mvn clean install -DskipTests
cp target/pulsar-io-activemq-0.0.1.nar $PULSAR_HOME/pulsar-io-activemq-0.0.1.nar
```

# Configuration

The configuration of the ActiveMQ sink connector has the following properties.

## ActiveMQ sink connector configuration

| Name | Type | Required | Sensitive | Default | Description |
|---------------------|--------|----------|-----------|--------------------|--------------------------------------------------------------------------|
| `protocol` | String | true | false | "tcp" | The ActiveMQ protocol. |
| `host` | String | true | false | " " (empty string) | The ActiveMQ host. |
| `port` | int | true | false | 5672 | The ActiveMQ port. |
| `username` | String | false | true | " " (empty string) | The username used to authenticate to ActiveMQ. |
| `password` | String | false | true | " " (empty string) | The password used to authenticate to ActiveMQ. |
| `queueName` | String | false | false | " " (empty string) | The ActiveMQ queue name that messages should be read from or written to. |
| `topicName` | String | false | false | " " (empty string) | The ActiveMQ topic name that messages should be read from or written to. |
| `activeMessageType` | String | false | false | 0 | The ActiveMQ message simple class name. |

## Configure ActiveMQ sink connector

Before using the ActiveMQ sink connector, you need to create a configuration file through one of the following methods.

* JSON

```json
{
"tenant": "public",
"namespace": "default",
"name": "activemq-sink",
"inputs": ["user-op-queue-topic"],
"archive": "connectors/pulsar-io-activemq-2.5.1.nar",
"parallelism": 1,
"configs":
{
"protocol": "tcp",
"host": "localhost",
"port": "61616",
"username": "admin",
"password": "admin",
"queueName": "user-op-queue-pulsar"
}
}
```

* YAML

```yaml
tenant: "public"
namespace: "default"
name: "activemq-sink"
inputs:
- "user-op-queue-topic"
archive: "connectors/pulsar-io-activemq-2.5.1.nar"
parallelism: 1

configs:
protocol: "tcp"
host: "localhost"
port: "61616"
username: "admin"
password: "admin"
queueName: "user-op-queue-pulsar"
```

# Usage

1. Prepare ActiveMQ service.

```
docker pull rmohr/activemq
docker run -p 61616:61616 -p 8161:8161 rmohr/activemq
```

2. Put the `pulsar-io-activemq-2.5.1.nar` in the pulsar connectors catalog.

```
cp pulsar-io-activemq-2.5.1.nar $PULSAR_HOME/connectors/pulsar-io-activemq-2.5.1.nar
```

3. Start Pulsar in standalone mode.

```
$PULSAR_HOME/bin/pulsar standalone
```

4. Run ActiveMQ sink locally.

```
$PULSAR_HOME/bin/pulsar-admin sink localrun --sink-config-file activemq-sink-config.yaml
```

5. Send Pulsar messages.

```
$PULSAR_HOME/bin/pulsar-client produce public/default/user-op-queue-topic --messages hello -n 10
```

6. Consume ActiveMQ messages.

Use the test method `receiveMessage` of the class `org.apache.pulsar.ecosystem.io.activemq.ActiveMQDemo`
to consume ActiveMQ messages.

```
@Test
private void receiveMessage() throws JMSException, InterruptedException {

ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory("tcp://localhost:61616");

@Cleanup
Connection connection = connectionFactory.createConnection();
connection.start();

@Cleanup
Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);

Destination destination = session.createQueue("user-op-queue-pulsar");

@Cleanup
MessageConsumer consumer = session.createConsumer(destination);

consumer.setMessageListener(new MessageListener() {
@Override
public void onMessage(Message message) {
if (message instanceof ActiveMQTextMessage) {
try {
System.out.println("get message ----------------- ");
System.out.println("receive: " + ((ActiveMQTextMessage) message).getText());
} catch (JMSException e) {
e.printStackTrace();
}
}
}
});
}
```


Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags: apache-pulsar,pulsar-io,source-connector,sink-connector,apache-activemq
alias: ActiveMQ source connector
features: ["ActiveMQ Connector integrates Apache Pulsar with Apache ActiveMQ. "]
icon: "/images/connectors/activemq_logo_white_vertical.jpg"
download: https://api.github.com/repos/streamnative/pulsar-io-activemq/tarball/refs/tags/v3.0.6.8
download: https://api.github.com/repos/streamnative/pulsar-io-activemq/tarball/refs/tags/v3.0.7.1
support: streamnative
support_link: https://github.com/streamnative/pulsar-io-activemq
support_img: "https://avatars.githubusercontent.com/u/44651383?v=4"
Expand Down
161 changes: 161 additions & 0 deletions connectors/activemq-source/v4.0.0.1/io-activemq-source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
---
description: ActiveMQ Connector integrates Apache Pulsar with Apache ActiveMQ.
author: StreamNative
contributors: gaoran10,shibd,dependabot[bot],sijie
language: Java,Shell,Dockerfile
document:
source: https://github.com/streamnative/pulsar-io-activemq
license: Apache License 2.0
license_link: https://github.com/streamnative/pulsar-io-activemq/blob/master/LICENSE
tags: apache-pulsar,pulsar-io,source-connector,sink-connector,apache-activemq
alias: ActiveMQ source connector
features: ["ActiveMQ Connector integrates Apache Pulsar with Apache ActiveMQ. "]
icon: "/images/connectors/activemq_logo_white_vertical.jpg"
download: https://api.github.com/repos/streamnative/pulsar-io-activemq/tarball/refs/tags/v4.0.0.1
support: streamnative
support_link: https://github.com/streamnative/pulsar-io-activemq
support_img: "https://avatars.githubusercontent.com/u/44651383?v=4"
owner_name: "streamnative"
owner_img: "https://avatars.githubusercontent.com/u/44651383?v=4"
dockerfile: https://hub.docker.com/r/streamnative/pulsar-io-activemq
sn_available: ""
id: "io-activemq-source"
---


The ActiveMQ source connector receives messages from ActiveMQ clusters and writes messages to Pulsar topics.

# Installation

```
git clone https://github.com/streamnative/pulsar-io-activemq.git
cd pulsar-io-activemq/
mvn clean install -DskipTests
cp target/pulsar-io-activemq-0.0.1.nar $PULSAR_HOME/pulsar-io-activemq-0.0.1.nar
```

# Configuration

The configuration of the ActiveMQ source connector has the following properties.

## ActiveMQ source connector configuration

| Name | Type | Required | Sensitive | Default | Description |
|-------------|--------|----------|-----------|--------------------|--------------------------------------------------------------------------|
| `protocol` | String | true | false | "tcp" | The ActiveMQ protocol. |
| `host` | String | true | false | " " (empty string) | The ActiveMQ host. |
| `port` | int | true | false | 5672 | The ActiveMQ port. |
| `username` | String | false | true | " " (empty string) | The username used to authenticate to ActiveMQ. |
| `password` | String | false | true | " " (empty string) | The password used to authenticate to ActiveMQ. |
| `queueName` | String | false | false | " " (empty string) | The ActiveMQ queue name that messages should be read from or written to. |
| `topicName` | String | false | false | " " (empty string) | The ActiveMQ topic name that messages should be read from or written to. |

## Configure ActiveMQ source connector

Before using the ActiveMQ source connector, you need to create a configuration file through one of the following methods.

* JSON

```json
{
"tenant": "public",
"namespace": "default",
"name": "activemq-source",
"topicName": "user-op-queue-topic",
"archive": "connectors/pulsar-io-activemq-2.5.1.nar",
"parallelism": 1,
"configs": {
"protocol": "tcp",
"host": "localhost",
"port": "61616",
"username": "admin",
"password": "admin",
"queueName": "user-op-queue"
}
}
```

* YAML

```yaml
tenant: "public"
namespace: "default"
name: "activemq-source"
topicName: "user-op-queue-topic"
archive: "connectors/pulsar-io-activemq-2.5.1.nar"
parallelism: 1

configs:
protocol: "tcp"
host: "localhost"
port: "61616"
username: "admin"
password: "admin"
queueName: "user-op-queue"
```

1. Prepare ActiveMQ service.

```
docker pull rmohr/activemq
docker run -p 61616:61616 -p 8161:8161 rmohr/activemq
```

2. Put the `pulsar-io-activemq-2.5.1.nar` in the pulsar connectors catalog.

```
cp pulsar-io-activemq-2.5.1.nar $PULSAR_HOME/connectors/pulsar-io-activemq-2.5.1.nar
```

3. Start Pulsar in standalone mode.

```
$PULSAR_HOME/bin/pulsar standalone
```

4. Run ActiveMQ source locally.

```
$PULSAR_HOME/bin/pulsar-admin source localrun --source-config-file activemq-source-config.yaml
```

5. Consume Pulsar messages.

```
bin/pulsar-client consume -s "sub-products" public/default/user-op-queue-topic -n 0
```

6. Send ActiveMQ messages.

Use the test method `sendMessage` of the `class org.apache.pulsar.ecosystem.io.activemq.ActiveMQDemo`
to send ActiveMQ messages.

```
@Test
private void sendMessage() throws JMSException {

ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory("tcp://localhost:61616");

@Cleanup
Connection connection = connectionFactory.createConnection();
connection.start();

@Cleanup
Session session = connection.createSession(false, Session.CLIENT_ACKNOWLEDGE);

Destination destination = session.createQueue("user-op-queue");

@Cleanup
MessageProducer producer = session.createProducer(destination);
producer.setDeliveryMode(DeliveryMode.NON_PERSISTENT);

for (int i = 0; i < 10; i++) {
String msgContent = "Hello ActiveMQ - " + i;
ActiveMQTextMessage message = new ActiveMQTextMessage();
message.setText(msgContent);
producer.send(message);
}
}
```


Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ author: ["ASF"]
contributors: ["ASF"]
language: Java
document: sss
source: "https://github.com/apache/pulsar/tree/v3.0.6/pulsar-io/aerospike"
source: "https://github.com/apache/pulsar/tree/v3.0.7/pulsar-io/aerospike"
license: Apache License 2.0
tags: ["Pulsar IO", "Aerospike", "Sink"]
alias: Aerospike Sink
features: ["Use Aerospike sink connector to sync data from Pulsar"]
license_link: "https://www.apache.org/licenses/LICENSE-2.0"
icon: "/images/connectors/aerospike-sink.png"
download: "https://archive.apache.org/dist/pulsar/pulsar-3.0.6/connectors/pulsar-io-aerospike-3.0.6.nar"
download: "https://archive.apache.org/dist/pulsar/pulsar-3.0.7/connectors/pulsar-io-aerospike-3.0.7.nar"
support: StreamNative
support_link: https://streamnative.io
support_img: "/images/streamnative.png"
Expand Down
Loading

0 comments on commit 3d610c8

Please sign in to comment.