Author: buildbot
Date: Sun Dec 7 16:37:40 2014
New Revision: 931781
Log:
Staging update by buildbot for streams
Modified:
websites/staging/streams/trunk/content/ (props changed)
websites/staging/streams/trunk/content/architecture.html
websites/staging/streams/trunk/content/index.html
websites/staging/streams/trunk/content/source-repository.html
websites/staging/streams/trunk/content/streams-usage.html
Propchange: websites/staging/streams/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Dec 7 16:37:40 2014
@@ -1 +1 @@
-1643413
+1643695
Modified: websites/staging/streams/trunk/content/architecture.html
==============================================================================
--- websites/staging/streams/trunk/content/architecture.html (original)
+++ websites/staging/streams/trunk/content/architecture.html Sun Dec 7
16:37:40 2014
@@ -160,14 +160,18 @@
Apache Streams Architecture
</h1>
- <p>The preliminary architecture for the Apache Streams (v0.1)
project is heavily influenced by Enterprise Integration Patterns and general
messaging architecture. It is the goal of the project to support both a
lightweight servlet container deployment and a robust distributed deployment.
The initial architectural patterns selected are being developed with an
Enterprise Service Bus based architecture in mind with target implementations
of Apache ServiceMix and Apache Camel.</p>
+ <p>The architecture for the Apache Streams (v0.1) project is
essentially a loosely coupled set of modules which provide, process, or persist
documents, with a preference for ActivityStreams.</p>
+<p>Streams is heavily influenced by Enterprise Integration Patterns and
general messaging architecture. It is the goal of the project to support
multiple execution containers, including distributed deployments.</p>
<hr />
<blockquote>
<p><em>Apache Streams (incubating) v0.1 Architecture</em></p>
</blockquote>
<hr />
-<p><img alt="v0.1 Architecture" src="/images/v.1_architecture.png" /></p>
-<h2 id="component-descriptions">Component Descriptions</h2>
+<h2 id="streams-vocabulary">Streams Vocabulary</h2>
+<p><em>Activity Persist Reader</em>: Task running within an Activity Streams
deployment that sources documents from a file system or database.</p>
+<p><em>Activity Persist Writer</em>: Task running within an Activity Streams
deployment that saves documents to a file system or database.</p>
+<p><em>Activity Processor</em>: Task running within Activity Streams
deployment that transforms documents, perhaps with a synchronous call to an
external system.</p>
+<p><em>Activity Provider</em>: Task running within Activity Streams
deployment that sources documents for the stream, likely in their original data
format.</p>
<p><em>Activity Publisher</em>: Entity external to Activity Streams server
that creates Activities per the activitystre.ms specification</p>
<p><em>Activity Publisher Endpoint Adapter</em>: Provides protocol interfaces
for Activity Publishers to use when registering as an Activity Publisher and
when publishing Activities</p>
<p><em>Publisher Registration Service</em>: Authorizes Activity Producers to
publish Activities to Activity Streams server and configures a dedicated
Activity Consumer for the Activity Publisher</p>
Modified: websites/staging/streams/trunk/content/index.html
==============================================================================
--- websites/staging/streams/trunk/content/index.html (original)
+++ websites/staging/streams/trunk/content/index.html Sun Dec 7 16:37:40 2014
@@ -159,12 +159,12 @@
<h1 class="title">
Apache Streams
- <small>Lightweight server for ActivityStreams</small>
+ <small>Lightweight framework for ActivityStreams</small>
</h1>
<hr />
<blockquote>
-<p><em>Apache Streams (incubating)</em> is a lightweight (yet scalable) server
for ActivityStreams.</p>
+<p><em>Apache Streams (incubating)</em> is a lightweight (yet scalable)
framework for ActivityStreams.</p>
</blockquote>
<hr />
<h2 id="latest-news">Latest News</h2>
Modified: websites/staging/streams/trunk/content/source-repository.html
==============================================================================
--- websites/staging/streams/trunk/content/source-repository.html (original)
+++ websites/staging/streams/trunk/content/source-repository.html Sun Dec 7
16:37:40 2014
@@ -160,30 +160,19 @@
Getting the Source Code
</h1>
- <p>Apache Streams uses <a
href="http://subversion.apache.org/";>Subversion</a> for version control with a
<a href="http://git.apache.org/";>Git</a> mirror.</p>
+ <h2 id="getting-the-source-code">Getting the Source Code</h2>
+<p>Apache Streams uses <a href="http://git.apache.org/";>Git</a> for version
control.</p>
<p>Run the following command to check out the repository trunk:</p>
<blockquote>
-<p>svn checkout https://svn.apache.org/repos/asf/incubator/streams/trunk
streams-trunk</p>
+<p>https://git-wip-us.apache.org/repos/asf/incubator-streams.git</p>
</blockquote>
-<p>OR</p>
-<blockquote>
-<p>git clone git://git.apache.org/streams.git streams-trunk</p>
-</blockquote>
-<p>There is also a <a
href="http://svnsearch.org/svnsearch/repos/ASF/search?path=%2Fincubator%2Fstreams";>Web
UI</a>
+<p>There is also a <a
href="https://git-wip-us.apache.org/repos/asf/incubator-streams.git";>Web UI</a>
which can be used to view the repository and project activity online.</p>
-<h2 id="project-build-structure">Project Build Structure</h2>
-<p>Streams uses Maven 3+ as its build tool. Below is a breakdown of the
projects and components that are built or can be built using Maven.</p>
-<p><strong>streams-eip-routes</strong>: contains Camel xml routes that are
packaged as a
-war. This could be hot deployed to servicemix or packaged with
-streams-web for a servlet container or applications server deployment.</p>
-<p><strong>streams-osgi-components</strong>: contains OSGI compliant java
modules. Each
-module is packaged as an osgi bundle jar. A uber-jar
-(streams-components) is also built that contains all of the components
-for packaging with streams-web. Each module could be hot deployed to
-servicemix.</p>
-<p><strong>streams-web</strong>: contains streams-eip-routes,
streams-components.jar,
-camel web interface, and possibly a streams web interface.
-Specifically for servlet contain/application server deployment.</p>
+<p>The repository syncs to <a href="http://git.apache.org/";>GitHub</a>, where
most pull requests are created and discussed.</p>
+<h2 id="building-the-project">Building the Project</h2>
+<p>Streams uses Maven 3+ as its build tool. </p>
+<p><code>mvn clean install</code> from project root will build all modules and
install them to your local maven repo.</p>
+<p>Streams requires Java 1.7+.</p>
</div> <!-- /span -->
</div> <!-- /row-fluid -->
</div>
Modified: websites/staging/streams/trunk/content/streams-usage.html
==============================================================================
--- websites/staging/streams/trunk/content/streams-usage.html (original)
+++ websites/staging/streams/trunk/content/streams-usage.html Sun Dec 7
16:37:40 2014
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="Content-Language" content="en" />
- <title>Apache Streams (Incubating) - Apache Streams Usage</title>
+ <title>Apache Streams (Incubating) - Running Apache Streams Server</title>
<link rel="stylesheet" href="/css/bootstrap-2.1.0.min.css"
type="text/css"/>
<link rel="stylesheet" href="/css/streams.css" type="text/css"/>
@@ -157,13 +157,69 @@
<!-- CONTENT AREA -->
<div class="span10">
<h1 class="title">
- Apache Streams Usage
+ Running Apache Streams Server
</h1>
- <p>The following is an outline of how to work with the current
development branch of Streams. It provides a walkthrough to see the current
major functions of Streams in action.</p>
+ <hr />
+<blockquote>
+<p><em>Running Apache Streams Embedded</em></p>
+</blockquote>
+<hr />
+<p>Streams can be embedded in a stand-alone Java Application using the
streams-runtime-local module.</p>
+<p>First, in your application's build definition, import:</p>
+<div class="codehilite"><pre><span class="n">org</span><span
class="p">.</span><span class="n">apache</span><span class="p">.</span><span
class="n">streams</span><span class="p">:</span><span
class="n">streams</span><span class="o">-</span><span
class="n">runtime</span><span class="o">-</span><span
class="n">local</span><span class="p">:</span>0<span class="p">.</span>1
+</pre></div>
+
+
+<p>Next, in the class you intend to run, create a StreamLocalBuilder.</p>
+<div class="codehilite"><pre><span class="n">StreamBuilder</span> <span
class="n">builder</span> <span class="p">=</span> <span class="n">new</span>
<span class="n">LocalStreamBuilder</span><span class="p">(</span>100<span
class="p">);</span>
+</pre></div>
+
+
+<p>Add data providers for your application by importing additional provider
modules, for example:</p>
+<div class="codehilite"><pre><span class="n">org</span><span
class="p">.</span><span class="n">apache</span><span class="p">.</span><span
class="n">streams</span><span class="p">:</span><span
class="n">streams</span><span class="o">-</span><span
class="n">provider</span><span class="o">-</span><span
class="n">twitter</span><span class="p">:</span>0<span class="p">.</span>1
+</pre></div>
+
+
+<p>and adding providers to the builder:</p>
+<div class="codehilite"><pre><span class="n">builder</span><span
class="p">.</span><span class="n">newPerpetualStream</span><span
class="p">(</span>"<span class="n">provider</span>"<span
class="p">,</span> <span class="n">new</span> <span
class="n">TwitterStreamProvider</span><span class="p">());</span>
+</pre></div>
+
+
+<p>The provided documents can be transformed by your application with
processors:</p>
+<div class="codehilite"><pre><span class="n">builder</span><span
class="p">.</span><span class="n">addStreamsProcessor</span><span
class="p">(</span>"<span class="n">converter</span>"<span
class="p">,</span> <span class="n">new</span> <span
class="n">TwitterTypeConverter</span><span class="p">(</span><span
class="n">ObjectNode</span><span class="p">.</span><span
class="n">class</span><span class="p">,</span> <span
class="n">Activity</span><span class="p">.</span><span
class="n">class</span><span class="p">);,</span> 2<span class="p">,</span>
"<span class="n">provider</span>"<span class="p">);</span>
+</pre></div>
+
+
+<p>Common database persistence libraries are also available as modules.</p>
+<div class="codehilite"><pre><span class="n">org</span><span
class="p">.</span><span class="n">apache</span><span class="p">.</span><span
class="n">streams</span><span class="p">:</span><span
class="n">streams</span><span class="o">-</span><span
class="n">persist</span><span class="o">-</span><span
class="n">hdfs</span><span class="p">:</span>0<span class="p">.</span>1
+</pre></div>
+
+
+<p>Your stream can write documents to databases with a PersistWriter:</p>
+<div class="codehilite"><pre><span class="n">builder</span><span
class="p">.</span><span class="n">addStreamsPersistWriter</span><span
class="p">(</span>"<span class="n">hdfs</span>"<span
class="p">,</span> <span class="n">new</span> <span
class="n">WebHdfsPersistWriter</span><span class="p">(),</span> 1<span
class="p">,</span> "<span class="n">converter</span>"<span
class="p">);</span>
+</pre></div>
+
+
+<p>Finally, your program should call</p>
+<div class="codehilite"><pre><span class="n">builder</span><span
class="p">.</span><span class="n">start</span><span class="p">();</span>
+</pre></div>
+
+
+<p>At which point the stream will initialize, begin execution, and run until
all providers have completed.</p>
+<p>Perpetual stream providers can run indefinitely, while other provider modes
typically complete after retrieving a finite dataset.</p>
+<p>Streams may be configured to time-out and terminate if no new documents are
provided with some amount of time:</p>
+<div class="codehilite"><pre><span class="n">Map</span><span
class="o"><</span><span class="n">String</span><span class="p">,</span>
<span class="n">Object</span><span class="o">></span> <span
class="n">streamConfig</span> <span class="p">=</span> <span
class="n">Maps</span><span class="p">.</span><span
class="n">newHashMap</span><span class="p">();</span>
+<span class="n">streamConfig</span><span class="p">.</span><span
class="n">put</span><span class="p">(</span><span
class="n">LocalStreamBuilder</span><span class="p">.</span><span
class="n">TIMEOUT_KEY</span><span class="p">,</span> 20 <span
class="o">*</span> 60 <span class="o">*</span> 1000<span class="p">);</span>
+<span class="n">StreamBuilder</span> <span class="n">builder</span> <span
class="p">=</span> <span class="n">new</span> <span
class="n">LocalStreamBuilder</span><span class="p">(</span>1000<span
class="p">,</span> <span class="n">streamConfig</span><span class="p">);</span>
+</pre></div>
+
+
+<p>The shell running your application stream may also terminate the stream.</p>
+<p>Upon receipt of a halt signal, the stream will attempt to process and write
any documents in flight before shutting down.</p>
<hr />
<blockquote>
-<p><em>Apache Streams (incubating) v0.1 Setup</em></p>
+<p><em>Running Apache Streams Server</em></p>
</blockquote>
<hr />
<p>Before starting you will need the following software:</p>
