empowering the social web with apache shindig

Empowering the Social Web with Apache

ShindigPaul Lindner

Wed Nov 4th, 2009

Saturday, November 14, 2009

The Social WebSaturday, November 14, 2009

The Social WebPeople and Connections

Activity Streams / News FeedsMessaging / Notifications

APIs?


The SolutionGadgets from iGoogle

Add People, Activities, and Viral Javascript APIs

Open to all

Iterate..


And Then...OpenSocial Foundation

HackathonsAtom/XML/Json REST APIs

OpenSocial TemplatesData Pipelining

Portable ContactsOAuth

Activity Streams?


End ResultSaturday, November 14, 2009

Shindig


ShindigSaturday, November 14, 2009

Apache Shindig is...

• Gadgets and OpenSocial and Reference Implementation

• OAuth Client/Server

• Java/PHP Implementation

• Almost 2 years old!

• Production-Quality code.


Mostly ShindigSaturday, November 14, 2009

Shindig is not...

• A Full Featured Social Network

• A system to manage applications and developers

• All that developer friendly (yet!)


Project Status• 21 Committers

• 231 Jira Contributors

• 287k LoC

• 1.0 Released, 1.1 on the way

• Almost Graduated from Incubation

• Good Practices - Code Review, TDD


1.1 Release• OpenSocial 0.9 Features

• Server Side Templates

• Server Side Preloads

• Data Pipelining

• Proxied Content

• lightweight JavaScript apis / JSON-RPC

• Major Upgrade

• 2212 files changed, 138129 insertions(+), 40672 deletions(-)


OpenSocial VersionsSaturday, November 14, 2009

Shindig Offspring• Partuza

• SocialSite

• Sakai

• Lockheed Martin Eureka Framework

• Atlassian (Jira, Confluence, etc)

• Drupal Integration

• FriendConnect

• Others?


Getting Started - Java

• Install Maven, Subversion

• Check out Code

• Build, Install and run

svn co http://svn.apache.org/repos/asf/incubator/shindig/trunkcd trunkmvnmvn -Prun


http://svn.apache.org/repos/asf/incubator/shindig/trunk

http://svn.apache.org/repos/asf/incubator/shindig/trunk

Getting Started - PHP

• Install Subversion, Apache httpd, PHP > 5.2, and PHP with modules json, simplexml, mcrypt and curl

• Check out Shindig Code

• Configure Apache


DEMOSaturday, November 14, 2009

Shindig Foundations• Java

• Maven and plugins

• Guice 2.0

• Apache Commons

• OAuth

• Ehcache

• Juel

• httpclient

• google-collections

• PHP

• PHPUnit

• Zend

• mod_rewrite

• OAuth


Shindig Architecture

• Gadget Server/Renderer

• OpenSocial data server (REST, Atom, JSON-RPC)

• People/Activities/Messages/Persistence Interfaces.


Extra Features

• Proxy Server

• Image Resizer

• Content Rewriter/Compressor

• Gadget Blacklist

• more!


Java Implementation

• Uses Composition and Dependency Injection via Guice.

• People/Activities/AppData/Messaging Services.

• Authentication and Security

• Hooks for just about everything else.


Integration Basics

• Implement Interfaces - People, Activities, Data, Messaging

• Review shindig.properties, container.js

• Write Guice Module

• Add to web.xml

• Add more - HttpFetcher, HttpCache, SecurityTokenDecoder, etc.


http://web.xml

http://web.xml

PeopleServicepublic Future<RestfulCollection<Person>> getPeople(Set<UserId> userIds, GroupId groupId, CollectionOptions options, Set<String> fields, SecurityToken token) throws ProtocolException { ...}

public Future<Person> getPerson(UserId id, Set<String> fields, SecurityToken token) throws ProtocolException { ...}


ActivityServicepublic Future<RestfulCollection<Activity>> getActivities(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token);

public Future<Void> createActivity(UserId userId, GroupId groupId, String appId, Set<String> fields, Activity activity, SecurityToken token);(and more....)


AppDataServiceFuture<DataCollection> getPersonData(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, SecurityToken token);

Future<Void> deletePersonData(UserId userId, GroupId groupId, String appId, Set<String> fields, SecurityToken token);

Future<Void> updatePersonData(UserId userId, GroupId groupId, String appId, Set<String> fields, Map<String, String> values, SecurityToken token);


MessageServiceFuture<RestfulCollection<MessageCollection>> getMessageCollections(UserId userId, Set<String> fields, CollectionOptions options, SecurityToken token);

* also create/modify/delete

Future<RestfulCollection<Message>> getMessages(UserId userId, String msgCollId, Set<String> fields, List<String> msgIds, CollectionOptions options, SecurityToken token);

* also create/modify/delete


Guice Module

package com.example.MyGuiceModule;

public class MyGuiceModule extends AbstractBaseModule { protected void configure() { bind(PeopleService.class).to(MyPeopleService.class); bind(ActivityService.class).to(MyActivityService.class); bind(AppDataService.class).to(MyAppDataService.class); bind(MessageService.class).to(MyMessageService.class); }}


shindig.properties

• 42 Parameters at last count

• Global Cache Params

• Global RSA key for OAuth signed requests

• Bound via Guice in the code

• @Named(“shindig.param”) String param


container.js

• Support for multiple containers

• Defines supported fields, url paths

• Should match web.xml config


http://web.xml

http://web.xml

web.xml

<content-param> <param-name>guice-modules</param-name> <param-value>com.example.MyGuiceModule</param-value></context-param>

• Copy web.xml

• java/server/src/main/webapp/WEB-INF/web.xml

• Add Guice Module


http://web.xml

http://web.xml

http://web.xml

http://web.xml

http://web.xml

http://web.xml

More!• Customize HttpFetcher

for security

• OAuthDataStore OAuth API Access.

• SecurityTokenDecoder to link with your existing security infrastructure.

• ExecutionListener for logging and analytics

• GadgetSpecFactory for localized control of GadgetSpecs

• OAuthStore for proxying OAuth requests


Container to Platform

• Add Schemas for Data

• Apps, Developers, Permissions, Notifications, App Invites

• Add UI Elements

• Gallery, Canvas, Invites, Notifications


DEMOSaturday, November 14, 2009

Parting Thoughts

• OpenSocial & Shindig - Mature, Open, and Successful

• Social Networks to the Enterprise

• Open Stack is emerging

• OAuth, OpenId, Portable Contacts, Activity Streams

• Shindig is your gateway.


Learn More

• http://incubator.apache.org/shindig/

• http://www.opensocial.org

• [email protected]

• Social and Widgets Meetup

• Thursday, 8pm


http://incubator.apache.org/shindig/

http://incubator.apache.org/shindig/

http://www.opensocial.org

http://www.opensocial.org

mailto:[email protected]

mailto:[email protected]

Q & A


empowering the social web with apache shindig

Technology

groupid groupid

apache shindig

string appid

securitytoken tokensaturday

securitytoken tokenand

messaging review shindig

collectionoptions options

activity activity