Spring/spring-integration-extensions
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

INTEXT-36 - Add Voldemort Module

Browse Source
This commit is contained in:
Lukasz Antoniak
2013-01-13 11:54:25 -08:00
committed by Gunnar Hillert
parent 3063278b0e
commit 1d2a5b5f06
61 changed files with 3819 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
spring-integration-voldemort/src/reference/docbook/history.xml Executable file
View File

@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="history"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Change History</title>
<table frame="all">
<title>Change History</title>
<tgroup cols="3">
<thead>
<row>
<entry>Release</entry>
<entry>Date</entry>
<entry>Changes</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.0.0</entry>
<entry>1 March 2013</entry>
<entry>
Initial release providing basic capabilities for message store,
inbound and outbound adapters.
</entry>
</row>
</tbody>
</tgroup>
</table>
</appendix>

BIN
spring-integration-voldemort/src/reference/docbook/images/logo.png Executable file
View File

Binary file not shown.

63
spring-integration-voldemort/src/reference/docbook/index.xml Executable file
View File

@@ -0,0 +1,63 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook" version="5.0"
xml:id="spring-integration-reference" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<bookinfo>
<title>Spring Integration Voldemort Adapter</title>
<titleabbrev>Voldemort Adapter ${version}</titleabbrev>
<productname>Spring Integration</productname>
<releaseinfo>${version}</releaseinfo>
<!-- TODO: this isn't showing up. -->
<mediaobject>
<imageobject role="fo">
<imagedata fileref="images/logo.png" format="PNG" align="center"/>
</imageobject>
<imageobject role="html">
<imagedata fileref="images/logo.png" format="PNG" align="center"/>
</imageobject>
</mediaobject>
<!-- END TODO -->
<authorgroup>
<author>
<firstname>Lukasz Antoniak</firstname>
</author>
</authorgroup>
<legalnotice>
<para>© SpringSource Inc., 2013</para>
</legalnotice>
</bookinfo>
<toc />
<part id="whats-new-part">
<title>What's new?</title>
<partintro id="spring-integration-change-history">
<para>
If you are interested in the changes and features, that were introduced in
earlier versions, please take a look at chapter <xref linkend="history"/>.
</para>
</partintro>
<xi:include href="./whats-new.xml"/>
</part>
<part id="spring-integration-adapters">
<title>Integration Adapters</title>
<partintro id="spring-integration-adapters">
<para>
Spring Integration adapter for Voldemort enables users to persist data
transferred through message channel in the destination key-value store,
as well as to poll records from the Voldemort database and process them
inside Spring Integration flow. Hereby extension provides also the
implementation of a message store.
</para>
</partintro>
<xi:include href="./voldemort.xml"/>
</part>
<part id="spring-integration-appendices">
<title>Appendices</title>
<xi:include href="./resources.xml"/>
<xi:include href="./history.xml"/>
</part>
</book>

35
spring-integration-voldemort/src/reference/docbook/resources.xml Executable file
View File

@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="resources"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Additional Resources</title>
<section id="spring-integration-home">
<title>Spring Integration Home</title>
<para>
The definitive source of information about Spring Integration is the
<ulink url="http://www.springsource.org/spring-integration">Spring Integration Home</ulink>
at <ulink url="http://www.springsource.org">http://www.springsource.org</ulink>. That site serves as a hub
of information and is the best place to find up-to-date announcements about the project as well as links to
articles, blogs, and new sample applications.
</para>
</section>
<section id="voldemort-home">
<title>Project Voldemort Home</title>
<para>
If you are not familiar with Voldemort distributed key-value store, please visit
<ulink url="http://www.project-voldemort.com">Project Voldemort</ulink> homepage. Hereby site contains
complete design overview, list of available configuration options and documentation of client API. Links
to source code, bug tracker and wiki can be found as well.
</para>
</section>
<section id="voldemort-integration-tests">
<title>Voldemort Adapter Integration Tests</title>
<para>
Integration tests of Voldemort adapter are available together with the entire source code on GitHub
(review content of <literal>src/test/java</literal> and <literal>src/test/resources</literal> packages).
</para>
</section>
</appendix>

214
spring-integration-voldemort/src/reference/docbook/voldemort.xml Executable file
View File

@@ -0,0 +1,214 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="SIAdapterLowerPrefix"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Voldemort Adapter</title>
<para>
The Voldemort extension for Spring Integration provides:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>
<link linkend='voldemort-outbound-channel-adapter'>Outbound Channel Adapter</link>
</emphasis>
</para>
</listitem>
<listitem>
<para>
<emphasis>
<link linkend='voldemort-inbound-channel-adapter'>Inbound Channel Adapter</link>
</emphasis>
</para>
</listitem>
<listitem>
<para>
<emphasis>
<link linkend='voldemort-message-store'>Message Store</link>
</emphasis>
</para>
</listitem>
</itemizedlist>
<para>
Each one of the components listed above requires to pass an implementation of
<interfacename>voldemort.client.StoreClient</interfacename> as constructor parameter. This way
Voldemort Adapter does not need to introduce all configuration options required to build native store client
and enables developers to choose the concrete implementation of hereby interface.
</para>
<programlisting language="xml"><![CDATA[<bean id="config" class="voldemort.client.ClientConfig">
<property name="bootstrapUrls" value="tcp://localhost:6666" />
<bean>
<bean id="clientFactory" class="voldemort.client.SocketStoreClientFactory" destroy-method="close">
<constructor-arg name="config" ref="config" />
</bean>
<bean id="storeClient" factory-bean="clientFactory" factory-method="getStoreClient">
<constructor-arg value="test-store" />
</bean>]]></programlisting>
<section id="voldemort-common-configuration-attributes">
<title>Common Configuration Attributes</title>
<para>
Certain configuration parameters that are shared amongst inbound and
outbound adapters have been described below.
</para>
<table frame="all">
<title>Common Adapter Attributes</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="1*" />
<thead>
<row>
<entry>Attribute Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>id</literal></entry>
<entry>
Identifies the underlying Spring bean definition, which is an instance of either
<classname>EventDrivenConsumer</classname> or <classname>PollingConsumer</classname>
depending on whether the component's input channel is a
<classname>SubscribableChannel</classname> or <classname>PollableChannel</classname>.
<emphasis>Optional</emphasis>.
</entry>
</row>
<row>
<entry><literal>channel</literal></entry>
<entry>
Reference to a message channel that will be utilized to "receive from" or "send to"
messages depending on the adapter type (e.g. inbound or outbound).
<emphasis>Required</emphasis>.
</entry>
</row>
<row>
<entry><literal>store-client</literal></entry>
<entry>
Native Voldemort store client (implementation of
<interfacename>voldemort.client.StoreClient</interfacename> interface).
<emphasis>Required</emphasis>.
</entry>
</row>
<row>
<entry><literal>auto-startup</literal></entry>
<entry>
Lifecycle attribute signaling if this component should be started during application
context startup. Defaults to <code>true</code>. <emphasis>Optional</emphasis>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section id="voldemort-outbound-channel-adapter">
<title>Outbound Channel Adapter</title>
<para>
The Voldemort Outbound channel adapter allows to persist data transferred through message channel in
the underlying key-value store.
</para>
<programlisting language="xml">&lt;int-voldemort:outbound-channel-adapter id="voldemortOutbound"
channel="voldemortOutboundChannel"
store-client="storeClient"
store-key="constant-key" <co id="voldemort#outbound#store-key" />
store-key-expression="payload.id" <co id="voldemort#outbound#store-key-expression" />
persist-mode="DELETE" <co id="voldemort#outbound#persist-mode" />
order="1" <co id="voldemort#outbound#order" />
auto-startup="true" /&gt;</programlisting>
<calloutlist>
<callout arearefs="voldemort#outbound#store-key">
<para>
Specifies the key for Voldemort store. If an expression is needed, use
<literal>store-key-expression</literal> attribute. Both options are mutually exclusive.
<emphasis>Required</emphasis>.
</para>
</callout>
<callout arearefs="voldemort#outbound#store-key-expression">
<para>
Spring Expression Language statement used to determine desired entry key in Voldemort store.
Default expression equals <literal>headers.voldemort_key</literal>
(see <classname>VoldemortHeaders.KEY</classname>). This option is mutually exclusive with
<literal>store-key</literal> attribute. <emphasis>Required</emphasis>.
</para>
</callout>
<callout arearefs="voldemort#outbound#persist-mode">
<para>
Defines default persist mode for outbound channel adapter. Normally values are added
or updated in the Voldemort database. Hereby behavior can be overridden on a message level using
<literal>VoldemortHeaders.PERSIST_MODE</literal> header (see <classname>PersistMode</classname>
enumeration). Supported options: <literal>PUT</literal> or <literal>DELETE</literal>.
<emphasis>Optional</emphasis>.
</para>
</callout>
<callout arearefs="voldemort#outbound#order">
<para>
Specifies the order for invocation when this endpoint is connected as a subscriber to
<interfacename>SubscribableChannel</interfacename>. <emphasis>Optional</emphasis>.
</para>
</callout>
</calloutlist>
</section>
<section id="voldemort-inbound-channel-adapter">
<title>Inbound Channel Adapter</title>
<para>
An inbound channel adapter allows to poll records from the Voldemort database and process them inside
Spring Integration flow.
</para>
<programlisting language="xml">&lt;int-voldemort:inbound-channel-adapter id="voldemortInbound"
channel="voldemortInboundChannel"
store-client="storeClient"
message-converter="messageConverter"
search-key="lukasz" <co id="voldemort#inbound#search-key" />
search-key-expression="@keyProducer.value" <co id="voldemort#inbound#search-key-expression" />
delete-after-poll="true" <co id="voldemort#inbound#delete-after-poll" />
extract-value="true" <co id="voldemort#inbound#extract-value" />
auto-startup="true" /&gt;</programlisting>
<calloutlist>
<callout arearefs="voldemort#inbound#search-key">
<para>
String key that is being searched. This option is mutually exclusive with
<literal>search-key-expression</literal> attribute. <emphasis>Required</emphasis>.
</para>
</callout>
<callout arearefs="voldemort#inbound#search-key-expression">
<para>
Spring Expression Language statement that returns desired entry key. Useful for keys of non string
type. This option is mutually exclusive with <literal>search-key</literal> attribute.
<emphasis>Required</emphasis>.
</para>
</callout>
<callout arearefs="voldemort#inbound#delete-after-poll">
<para>
Indicates whether returned object should be removed from Voldemort database after polling into
Spring Integration channel. Defaults to <code>false</code>. <emphasis>Optional</emphasis>.
</para>
</callout>
<callout arearefs="voldemort#inbound#extract-value">
<para>
Flag controlling value extraction from Voldemort's
<classname>voldemort.versioning.Versioned</classname> object.
Defaults to <code>true</code>. <emphasis>Optional</emphasis>.
</para>
</callout>
</calloutlist>
</section>
<section id="voldemort-message-store">
<title>Message Store</title>
<para>
Message Store allows to persist Spring Integration messages in Voldemort database. Hereby module provides
<classname>VoldemortMessageStore</classname> which is an implementation of both the
<classname>MessageStore</classname> strategy (mainly used by <emphasis>QueueChannel</emphasis> and
<emphasis>ClaimCheck</emphasis> patterns) and the <classname>MessageGroupStore</classname> strategy
(mainly used by <emphasis>Aggregator</emphasis> and <emphasis>Resequencer</emphasis> patterns).
</para>
<programlisting language="xml"><![CDATA[<bean id="voldemortMessageStore" class="org.springframework.integration.voldemort.store.VoldemortMessageStore">
<constructor-arg name="client" ref="storeClient" />
</bean>
<int:aggregator input-channel="inputChannel" output-channel="outputChannel" message-store="voldemortMessageStore" />]]></programlisting>
</section>
</chapter>

35
spring-integration-voldemort/src/reference/docbook/whats-new.xml Executable file
View File

@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="whats-new"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Changes in 1.0.0</title>
<para>
This chapter provides an overview of new features and improvements
that have been added to the Voldemort Adapter.
</para>
<orderedlist>
<listitem>
Inbound Channel Adapter allows to poll data from Voldemort key-value store.
Supported features:
<itemizedlist>
<listitem>Periodically poll value persisted under given key.</listitem>
<listitem>Specify search key directly or as a Spring Expression Language statement.</listitem>
<listitem>Automatically remove data from Voldemort store after putting message into
Spring Integration channel.</listitem>
<listitem>Control adapter startup time.</listitem>
</itemizedlist>
</listitem>
<listitem>
Outbound Channel Adapter allows to insert, update and delete data from
Voldemort key-value store. Supported features:
<itemizedlist>
<listitem>Define operation type (e.g. put or delete) on adapter and message level.</listitem>
<listitem>Order execution when chaining with other adapters.</listitem>
<listitem>Control adapter startup time.</listitem>
</itemizedlist>
</listitem>
<listitem>
Message store allows to persist Spring Integration messages in Voldemort database.
</listitem>
</orderedlist>
</chapter>