Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Broadcaster 448 #22

Merged
merged 8 commits into from
Dec 20, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions islandora-connector-broadcast/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Islandora Connector Broadcast

## Description

This service takes an incoming message and broadcasts it to a list of queues/topics. The list of recipients is specified in the `IslandoraBroadcastRecipients` header as a comma separated list.

## Configuration

Once deployed, the incoming message stream can be configured by editing the `ca.islandora.alpaca.connector.broadcast.cfg` file in your Karaf installation's `etc` directory.

input.stream=broker:queue:islandora-connector-broadcast

For example, by changing `broker` to `activemq`, this service will attempt read messages from the ActiveMQ queue `islandora-connector-broadcast`. In theory, any broker technology supported by Camel should be supported, though ActiveMQ is the only one tested.

## More Information

For more information, please visit the [Apache Camel](http://camel.apache.org) documentation.
29 changes: 29 additions & 0 deletions islandora-connector-broadcast/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
apply plugin: 'osgi'

description = 'Islandora CLAW Broadcaster'

dependencies {
compile group: 'org.apache.camel', name: 'camel-core', version: camelVersion
compile group: 'org.apache.camel', name: 'camel-blueprint', version: camelVersion
compile group: 'org.slf4j', name: 'slf4j-api', version: slf4jVersion
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine to leave this here, but I'd note that you're not actually using SLF4J in the code. (You may want to at some future point, but I'd probably remove this until that time comes).

testCompile group: 'org.apache.camel', name: 'camel-test-blueprint', version: camelVersion
}

jar {
manifest {
description project.description
docURL project.docURL
vendor project.vendor
license project.license

instruction 'Import-Package', "org.apache.camel;version=\"${camelVersionRange}\",${defaultOsgiImports}"
instruction 'Export-Package', 'ca.islandora.alpaca.connector.broadcast'
}
}

artifacts {
archives (file('build/cfg/main/ca.islandora.alpaca.connector.broadcast.cfg')) {
classifier 'configuration'
type 'cfg'
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Incoming queue/topic on the broker of your choice.
# Replace the 'broker' prefix with the broker for your system.
# E.g. activemq, zeromq, etc...
input.stream=broker:queue:islandora-connector-broadcast
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* Licensed to Islandora Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* The Islandora Foundation licenses this file to you under the MIT License.
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/MIT
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ca.islandora.alpaca.connector.broadcast;

import static org.apache.camel.LoggingLevel.INFO;

import org.apache.camel.builder.RouteBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* A content router distributing messages to multiple endpoints.
*
* @author Daniel Lamb
*/
public class BroadcastRouter extends RouteBuilder {

private static final Logger LOGGER = LoggerFactory.getLogger(BroadcastRouter.class);

/**
* Configure the message route workflow.
*/
public void configure() throws Exception {

// Distribute message based on configured header.
from("{{input.stream}}")
.routeId("MessageBroadcaster")
.description("Broadcast messages from one queue/topic to other specified queues/topics.")
.log(INFO, LOGGER,
"Distributing message: ${headers[JMSMessageID]} with timestamp ${headers[JMSTimestamp]}")
.recipientList(simple("${headers[IslandoraBroadcastRecipients]}"))
.ignoreInvalidEndpoints();
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<blueprint
xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.1.0"
xsi:schemaLocation="
http://www.osgi.org/xmlns/blueprint/v1.0.0
http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">

<cm:property-placeholder persistent-id="ca.islandora.alpaca.connector.broadcast" update-strategy="reload">
<cm:default-properties>
<cm:property name="input.stream" value="broker:queue:islandora-connector-broadcast" />
</cm:default-properties>
</cm:property-placeholder>

<reference id="broker" interface="org.apache.camel.Component" filter="(osgi.jndi.service.name=acrepo/Broker)"/>

<camelContext id="IslandoraConnectorBroadcast" xmlns="http://camel.apache.org/schema/blueprint">
<package>ca.islandora.alpaca.connector.broadcast</package>
</camelContext>
</blueprint>
15 changes: 13 additions & 2 deletions karaf/src/main/resources/features.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,20 @@
<feature version="${camelVersion}">camel</feature>
<feature version="${activemqVersion}">activemq-camel</feature>

<bundle>mvn:ca.islandora.indexing/islandora-indexing-triplestore/${project.version}</bundle>
<bundle>mvn:ca.islandora.alpaca/islandora-indexing-triplestore/${project.version}</bundle>

<configfile finalname="/etc/ca.islandora.indexing.triplestore.cfg">mvn:ca.islandora.indexing/islandora-indexing-triplestore/${project.version}/cfg/configuration</configfile>
<configfile finalname="/etc/ca.islandora.indexing.triplestore.cfg">mvn:ca.islandora.alpaca/islandora-indexing-triplestore/${project.version}/cfg/configuration</configfile>

</feature>

<feature name="islandora-connector-broadcast" version="${project.version}" start-level="80">
<details>Distributes a message to a list of queues/topics.</details>

<feature version="${camelVersion}">camel</feature>

<bundle>mvn:ca.islandora.alpaca/islandora-connector-broadcast/${project.version}</bundle>

<configfile finalname="/etc/ca.islandora.alpaca.connector.broadcast.cfg">mvn:ca.islandora.alpaca/islandora-connector-broadcast/${project.version}/cfg/configuration</configfile>

</feature>
</features>
2 changes: 2 additions & 0 deletions settings.gradle
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
include ':islandora-karaf'
include ':islandora-indexing-triplestore'
include ':islandora-connector-broadcast'

project(':islandora-karaf').projectDir = "$rootDir/karaf" as File
project(':islandora-indexing-triplestore').projectDir = "$rootDir/islandora-indexing-triplestore" as File
project(':islandora-connector-broadcast').projectDir = "$rootDir/islandora-connector-broadcast" as File