Empowering the Social Web with Apache Shindig

Empowering the Social
Web with Apache
Shindig
Paul Lindner
Wed Nov 4th, 2009

Saturday, November 14, 2009

The Social Web

The Social Web
People and Connections
Activity Streams / News Feeds
Messaging / Notiﬁcations

APIs?


The Solution
Gadgets from iGoogle

Add People, Activities, and Viral
Javascript APIs

Open to all

Iterate..


And Then...
OpenSocial Foundation
Hackathons
Atom/XML/Json REST APIs
OpenSocial Templates
Data Pipelining
Portable Contacts
OAuth
Activity Streams?


End Result

Shindig


Apache Shindig is...
• Gadgets and OpenSocial
and Reference
Implementation

• OAuth Client/Server

• Java/PHP Implementation

• Almost 2 years old!

• Production-Quality code.


Mostly Shindig

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 • Major Upgrade

• Server Side Templates • 2212 ﬁles changed,
138129 insertions(+),
• Server Side Preloads 40672 deletions(-)

• Data Pipelining

• Proxied Content

• lightweight JavaScript
apis / JSON-RPC


OpenSocial Versions

Shindig Offspring
• Partuza • Drupal Integration

• SocialSite • FriendConnect

• Sakai • Others?

• Lockheed Martin Eureka
Framework

• Atlassian (Jira,
Conﬂuence, etc)


Getting Started - Java

• Install Maven, Subversion
• Check out Code
• Build, Install and run
svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk
cd trunk
mvn
mvn -Prun


Getting Started - PHP

• Install Subversion, Apache httpd, PHP > 5.2,
and PHP with modules json, simplexml,
mcrypt and curl
• Check out Shindig Code
• Conﬁgure Apache


DEMO

Shindig Foundations
• Java • PHP

• Maven and plugins
• PHPUnit
• Guice 2.0

• Apache Commons • Zend

• OAuth • mod_rewrite

• Ehcache
• OAuth
• Juel

• httpclient

• google-collections


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.


PeopleService
public 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 {
...
}


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

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


AppDataService
Future<DataCollection>
getPersonData(Set<UserId> userIds, GroupId groupId,
String appId, Set<String> fields,

Future<Void>
deletePersonData(UserId userId, GroupId groupId,

Future<Void>
updatePersonData(UserId userId, GroupId groupId,
Map<String, String> values,


MessageService
Future<RestfulCollection<MessageCollection>>
getMessageCollections(UserId userId,
Set<String> fields,

* 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


web.xml
• Copy web.xml

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

• Add Guice Module

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


More!
• Customize HttpFetcher • GadgetSpecFactory for
for security localized control of
GadgetSpecs
• OAuthDataStore OAuth
API Access. • OAuthStore for
proxying OAuth
• SecurityTokenDecoder requests
to link with your existing
security infrastructure.

• ExecutionListener for
logging and analytics


Container to Platform
• Add Schemas for Data

• Apps, Developers,
Permissions,
Notiﬁcations, App
Invites

• Add UI Elements

• Gallery, Canvas,
Invites, Notiﬁcations


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
• shindig-dev@incubator.apache.org
• Social and Widgets Meetup
• Thursday, 8pm


Q &A


Empowering the Social Web with Apache Shindig

Recommended

Recommended

More Related Content

What's hot

What's hot (6)

Viewers also liked

Viewers also liked (20)

Similar to Empowering the Social Web with Apache Shindig

Similar to Empowering the Social Web with Apache Shindig (20)

Recently uploaded

Recently uploaded (20)

Empowering the Social Web with Apache Shindig