| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-04-02 |
| | Rendered using Apache Maven Fluido Skin 1.5 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20180402" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>streams-examples – Overview</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-77087101-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| </head> |
| <body class="topBarEnabled"> |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/streams-examples"> |
| <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" |
| src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" |
| alt="Fork me on GitHub"> |
| </a> |
| |
| |
| |
| |
| |
| <div id="topbar" class="navbar navbar-fixed-top navbar-inverse"> |
| <div class="navbar-inner"> |
| <div class="container"><div class="nav-collapse"> |
| |
| |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| <li> <a href="../index.html" title="Overview">Overview</a> |
| </li> |
| |
| <li> <a href="../architecture.html" title="Architecture">Architecture</a> |
| </li> |
| |
| <li> <a href="../concepts.html" title="Concepts">Concepts</a> |
| </li> |
| |
| <li> <a href="../downloads.html" title="Downloads">Downloads</a> |
| </li> |
| |
| <li> <a href="../streams-examples/index.html" title="Examples">Examples</a> |
| </li> |
| |
| <li> <a href="../faq.html" title="Frequently Asked Questions">Frequently Asked Questions</a> |
| </li> |
| |
| <li> <a href="../modules.html" title="Modules">Modules</a> |
| </li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Reports <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| <li class="dropdown-submenu"> |
| <a href="project-info.html" title="Project Information">Project Information</a> |
| <ul class="dropdown-menu"> |
| <li> <a href="integration.html" title="CI Management">CI Management</a> |
| </li> |
| <li> <a href="dependencies.html" title="Dependencies">Dependencies</a> |
| </li> |
| <li> <a href="dependency-info.html" title="Dependency Information">Dependency Information</a> |
| </li> |
| <li> <a href="dependency-management.html" title="Dependency Management">Dependency Management</a> |
| </li> |
| <li> <a href="distribution-management.html" title="Distribution Management">Distribution Management</a> |
| </li> |
| <li> <a href="index.html" title="About">About</a> |
| </li> |
| <li> <a href="issue-tracking.html" title="Issue Management">Issue Management</a> |
| </li> |
| <li> <a href="license.html" title="Licenses">Licenses</a> |
| </li> |
| <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a> |
| </li> |
| <li> <a href="modules.html" title="Project Modules">Project Modules</a> |
| </li> |
| <li> <a href="plugin-management.html" title="Plugin Management">Plugin Management</a> |
| </li> |
| <li> <a href="plugins.html" title="Plugins">Plugins</a> |
| </li> |
| <li> <a href="team-list.html" title="Team">Team</a> |
| </li> |
| <li> <a href="source-repository.html" title="Source Code Management">Source Code Management</a> |
| </li> |
| <li> <a href="project-summary.html" title="Summary">Summary</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="dropdown-submenu"> |
| <a href="project-reports.html" title="Project Reports">Project Reports</a> |
| <ul class="dropdown-menu"> |
| <li> <a href="third-party-report.html" title="Third Parties">Third Parties</a> |
| </li> |
| <li> <a href="rat-report.html" title="Rat Report">Rat Report</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Examples <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| <li> <a href="streams-examples-flink/index.html" title="Flink">Flink</a> |
| </li> |
| |
| <li> <a href="streams-examples-local/index.html" title="Local">Local</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <ul class="nav pull-right"><li> |
| |
| <a href="https://twitter.com/ApacheStreams" class="twitter-follow-button" data-show-count="true" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheStreams</a> |
| <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> |
| |
| </li></ul> |
| |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <a href="http://streams.apache.org" id="bannerLeft"> |
| <img src="http://streams.apache.org/images/streams_logo.jpg" alt="Apache Streams" width="150" height="100"/> |
| </a> |
| </div> |
| <div class="pull-right"> </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| <li class=""> |
| <a href="http://streams.apache.org" class="externalLink" title="Streams"> |
| Streams</a> |
| <span class="divider">/</span> |
| </li> |
| <li class=""> |
| <a href="index.html" title="streams-examples"> |
| streams-examples</a> |
| <span class="divider">/</span> |
| </li> |
| <li class="active ">Overview</li> |
| |
| |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| <div class="section"> |
| <h2><a name="Overview"></a>Overview</h2> |
| <p>Apache Streams unifies a diverse world of digital profiles and online activities into common formats and vocabularies, and makes these datasets accessible across a variety of databases, devices, and platforms for streaming, browsing, search, sharing, and analytics use-cases.</p> |
| <div class="section"> |
| <h3><a name="How_do_I_use_Streams"></a>How do I use Streams?</h3> |
| <p>This repository contains officially maintained examples of how to compose and run streams in various contexts.</p></div> |
| <div class="section"> |
| <h3><a name="Getting_Started"></a>Getting Started</h3> |
| <p>Please visit the project website for the latest information: <a class="externalLink" href="http://streams.apache.org/">http://streams.apache.org/</a></p> |
| <p>Along with the developer mailing list archive: <a class="externalLink" href="https://lists.apache.org/list.html?dev@streams.apache.org">https://lists.apache.org/list.html?dev@streams.apache.org</a></p></div> |
| <div class="section"> |
| <h3><a name="Building_and_running"></a>Building and running</h3> |
| <p>To build from source code:</p> |
| |
| <ul> |
| |
| <li> |
| <p>Requirements: Sources compilation require Java SE 8 or higher. Sources compilation require Apache Maven 3.3.9 or higher. You need to download and install Maven 3 from: <a class="externalLink" href="http://maven.apache.org/">http://maven.apache.org/</a></p></li> |
| |
| <li> |
| <p>The Streams Examples project itself (this one) depends on the separate Streams project which contains the source code and poms for Apache Streams. As streams-project is already published to the Apache Releases repository, there is no need to check it out manually and build it locally yourself, unless you choose to checkout a SNAPSHOT branch.</p> |
| |
| <ul> |
| |
| <li>If so needed, streams can be checked out from: <a class="externalLink" href="http://git-wip-us.apache.org/repos/asf/streams.git">http://git-wip-us.apache.org/repos/asf/streams.git</a></li> |
| </ul> |
| |
| <ul> |
| |
| <li>After check out, cd into streams and invoke maven to install it using:</li> |
| </ul> |
| |
| <div class="source"> |
| <div class="source"><pre class="prettyprint"> mvn install |
| </pre></div></div></li> |
| |
| <li> |
| <p>To build all of the Streams examples, invoke maven with:</p> |
| |
| <div class="source"> |
| <div class="source"><pre class="prettyprint">mvn install |
| </pre></div></div></li> |
| </ul></div> |
| <div class="section"> |
| <h3><a name="Integration_Testing"></a>Integration Testing</h3> |
| <p><i>Integration Testing will fail unless you have a working docker installation and valid twitter credentials in local conf files.</i></p> |
| |
| <ul> |
| |
| <li> |
| <p>To run the full suite of integration tests, invoke maven with:</p> |
| |
| <div class="source"> |
| <div class="source"><pre class="prettyprint">mvn -N -PdockerITs docker:start |
| mvn clean verify -D |
| mvn -N -PdockerITs docker:stop |
| </pre></div></div></li> |
| |
| <li> |
| <p>To build and install a docker image containing a specific example, change to that example’s directory then:</p> |
| |
| <div class="source"> |
| <div class="source"><pre class="prettyprint">mvn -Pdocker clean package docker:build |
| </pre></div></div></li> |
| </ul></div> |
| <div class="section"> |
| <h3><a name="Disclaimer"></a>Disclaimer</h3> |
| <p>Apache Streams is an effort undergoing incubation at <a class="externalLink" href="http://apache.org">The Apache Software Foundation (ASF)</a> sponsored by the <a class="externalLink" href="http://incubator.apache.org">Apache Incubator PMC</a>. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p> |
| <div class="section"> |
| <div class="section"> |
| <div class="section"> |
| <h6><a name="Licensed_under_Apache_License_2.0_-_http:www.apache.orglicensesLICENSE-2.0"></a>Licensed under Apache License 2.0 - <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></h6></div></div></div></div></div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <p >Copyright © 2018 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| All rights reserved. |
| <li id="publishDate" class="pull-right">Last Published: 2018-04-02</li> |
| <li id="projectVersion" class="pull-right"> |
| Version: 0.5.2-SNAPSHOT |
| </li> |
| </p> |
| </div> |
| |
| <p id="poweredBy" class="pull-right"> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
| </a> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
