You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streams.apache.org by le...@apache.org on 2013/02/05 16:35:38 UTC
svn commit: r1442626 - in /incubator/streams/site/trunk:
content/architecture.mdtext content/streams-usage.mdtext lib/path.pm
Author: letourneau
Date: Tue Feb 5 15:35:37 2013
New Revision: 1442626
URL: http://svn.apache.org/viewvc?rev=1442626&view=rev
Log:
added usage page for current development branch
Added:
incubator/streams/site/trunk/content/streams-usage.mdtext
Modified:
incubator/streams/site/trunk/content/architecture.mdtext
incubator/streams/site/trunk/lib/path.pm
Modified: incubator/streams/site/trunk/content/architecture.mdtext
URL: http://svn.apache.org/viewvc/incubator/streams/site/trunk/content/architecture.mdtext?rev=1442626&r1=1442625&r2=1442626&view=diff
==============================================================================
--- incubator/streams/site/trunk/content/architecture.mdtext (original)
+++ incubator/streams/site/trunk/content/architecture.mdtext Tue Feb 5 15:35:37 2013
@@ -51,6 +51,6 @@ Component Descriptions
*Activity Streams Subscriber Endpoint Adapter*: Provides protocol interfaces for Activity Streams Subscribers to use when subscribing to Activity Streams and polling for new Activity Streams
-*Activity Streams Consumer Registration Service*: Creates Activity Streams Subscriber Delegates for each Activity Streams Subscribers.
+*Activity Streams Subscriber Registration Service*: Creates Activity Streams Subscriber Delegates for each Activity Streams Subscribers.
*Activity Streams Router*: Handles the routing of poll requests from Activity Streams Subscribers to Activity Streams Subscriber Delegates and push notifications from Activity Streams Subscriber Delegates to Activity Streams Subscribers
Added: incubator/streams/site/trunk/content/streams-usage.mdtext
URL: http://svn.apache.org/viewvc/incubator/streams/site/trunk/content/streams-usage.mdtext?rev=1442626&view=auto
==============================================================================
--- incubator/streams/site/trunk/content/streams-usage.mdtext (added)
+++ incubator/streams/site/trunk/content/streams-usage.mdtext Tue Feb 5 15:35:37 2013
@@ -0,0 +1,81 @@
+Title: Apache Streams Usage
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ 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.
+
+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.
+
+---
+
+> *Apache Streams (incubating) v0.1 Setup*
+
+---
+
+Streams is designed for deployment in Apache ServiceMix which provides Apache Camel and as OSGI container. Step 1 is to download the latest [ServiceMix][1]. You should also get the latest [Streams source] [2].
+
+ mvn install
+
+This will generate jar files for streams-eip-routes and streams-osgi-components (each module individually). Transfer (drag and drop, or copy):
+
+>streams-eip-routes-0.1-SNAPSHOT.jar, activity-subscriber-0.1-SNAPSHOT.jar,activity-registration-0.1-SNAPSHOT.jar, and activity-consumer-0.1-SNAPSHOT.jar into the {servicemix}/deploy folder.
+
+ ./bin/servicemix will start servicemix
+
+
+Testing Throughput
+==================
+
+You can use any utility capable a sending HTTP requests, but Chrome's Advanced Rest Client browser plugin is simple and easy to use.
+
+With your HTTP utility of choice set up a publisher by POSTing JSON like the following to http://localhost:8000/streams/publisher/register
+
+ TODO: paste JSON
+
+The service will return a URL that can be POSTed to with ActivityStrea.ms formatted JSON.
+
+Next setup a subscriber by POSTing JSON like the following to http://localhost:8000/streams/subscriber/register
+
+ {
+ "authToken": "token",
+ "@class":"org.apache.streams.osgi.components.activitysubscriber.impl.ActivityStreamsSubscriptionImpl",
+ "filters": [
+ {
+ "@class":"org.apache.streams.osgi.components.activitysubscriber.impl.ActivityStreamsSubscriptionLuceneFilterImpl",
+ "query": "string represented query of type expected by filter implementation"
+
+
+ }
+ ],
+ "outputs": [
+ {
+ "output_type": "http",
+ "method": "post",
+ "url": "http.example.com:8888",
+ "delivery_frequency": "60",
+ "max_size": "10485760",
+ "auth_type": "none",
+ "username": "username",
+ "password": "password"
+ }
+ ]
+ }
+
+This will return a unique URL that can take GET and POST requests. POST requests should contain JSON like the above to reconfigure the endpoint, GET requests will return activity streams JSON.
+
+Now, POST some JSON activitystrea.ms to the URL you received for the Publisher and then GET the URL you received for the Subscriber.
+
+[1]http://servicemix.apache.org/
+[2]http://streams.incubator.apache.org/source-repository.html
\ No newline at end of file
Modified: incubator/streams/site/trunk/lib/path.pm
URL: http://svn.apache.org/viewvc/incubator/streams/site/trunk/lib/path.pm?rev=1442626&r1=1442625&r2=1442626&view=diff
==============================================================================
--- incubator/streams/site/trunk/lib/path.pm (original)
+++ incubator/streams/site/trunk/lib/path.pm Tue Feb 5 15:35:37 2013
@@ -14,6 +14,8 @@ our @nav = (
href => "/downloads.html" },
{ title => "Source Code",
href => "/source-repository.html" },
+ { title => "Usage",
+ href => "/streams-usage.html" },
{ title => "Mailing Lists",
href => "/mailing-lists.html" },
{ title => "People",