Shindig in 2 hours

www.exoplatform.com

Copyright 2011 eXo Platform

SHINDIG IN 2 HOURS

[email protected] team

2www.exoplatform.com




Apache Shindig: - Introduction - Architecture

Shindig integration (eXo)

Objective: 3W

In 2 hours ...

www.exoplatform.com


Shindig Introduction





Apache Shindig (Introduction)





















Apache Shindig

What is shindig?- OpenSocial container→start hosting OpenSocial apps quickly by: + Providing the code to render gadgets + Open Social API, RESTful, RPC protocol services

- Java and PHP

GoalLauch a new container in under an hour's worth of work.



Apache Shindig (History)

Version Release OpenSocial

3.0.02.0.3 01/Dec/10 2.0.2 30/Oct/10 2.0.0 07/Sep/10 2.0.0-RC2 10/Aug/10 1.1-BETA5 23/Nov/09 0.9 1.0.1 10/May/10 0.8 1.0 19/Jun/09

Nov 2007



Apache Shindig (In Production)



Apache Shindig. Why Use?

• Strong Open Source community

• High quality production-ready code

• Used by: hi5, orkut, iGoogle, Netlog, Hyves …

• Synchronized with specification

• Language neutral (Java, PHP, ...)



Apache Shindig (Getting Started-Java)

http://shindig.apache.org/getting-started.html

- Check out code svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk

- Build & Run (Jetty Server) mvn clean install mvn -Prun

- Run (tomcat server) http://localhost:8080/container/sample1.html http://localhost:8080/social/rest/people/canonical/@self?format=xml

www.exoplatform.com


Shindig Architecture



• Gadget Server Parses gadget XML, renders as HTML/JS/CSS• OpenSocial Data Server - Plugs into social graph data - RESTful, RPC protocol services• Downloaded JavaScript libraries Core gadgets, OpenSocial client JavaScript environment

Shindig Architecture (Components)



Apache Shindig (APIs – Entry Points)

- OS API renderGadget() req.send() req..requestCreateActivity()

- REST API ..social/rest/people/...

..social/rest/activities/...



• Shindig Client and Server Components

• Gadget Server

• Social Data Server





• Gadget Server





Shindig Architecture (Components)



Shindig Architecture (Server Comps)

- _Servlets are entry points to take calls from client side.



Shindig Architecture (How It Works?)

Req TYPE

FETCH_PEOPLE : Get Person data

FETCH_PERSON_APP_DATA : Get the data attributes for a person

UPDATE_PERSON_APP_DATA : update attributes of a person

FETCH_ACTIVITIES : Get List of activities for a Particular Person

CREATE_ACTIVITY : create Activity associated with a Person




• Gadget Server





Gadget Server

- Gadget Container JavaScript: JavaScript for general gadget functionality.

- Gadget Rendering Server: to render the gadget XML into HTML.

Gadget

GadgetServer

SocialData Server

HTML



Gadget Rendering in Flow




• Gadget Server





Social Data Server

People

Relationships

Activities



Social Data Server

- OpenSocial Container JavaScript: JavaScript environment that provides

OpenSocial specific functionality (Profiles, Relationships, Activities).

- OpenSocial Data Server: with extension points so others can connect it to their own backends.

Gadget

GadgetServer

SocialData Server

JSON



Social Data Server

http://rollerweblogger.org/roller/entry/shindig_java_internals_diagram_updated



Social Data Server

www.exoplatform.com


Shindig Integration



Utilize existing Open Source container code.

Wants Gadgets Wants Social features: Profiles, Relationships, Activities

Integration. Why?



Integration. How?

- Shindig Implementation: Java, PHP …

- Gadget Server, Social Data Server



Integration

Render gadget

OpenSocial Container (Social Data Server)



• Customize sample comtainer (Gadget Container)

• Implement Interfaces – People, Friends, Activities (Social Server)

• Write Guice Modules (binding)

• Add mapping information to web.xml (servlets, filters, guices- modules … )

• Add more SecurityTokenDecoder, etc. (Enabling OAuth support)

Integration (SUMMARIZE)








Integration








Integration



- People Service public class ExoPeopleService extends ExoService implements PersonService, AppDataService {

public Future<RestfulCollection<Person>> getPeople(...) {}

public Future<Person> getPerson(...) {}

}

- Activitiy Service public class ExoActivityService extends ExoService implements ActivityService {

public Future<RestfulCollection<Activity>> getActivities(...) {}

public Future<Void> createActivity(...) {}

}

Copyright 2010 eXo Platform SAS

Integration (Implement Interfaces)








Integration



public class ExoSocialApiGuiceModule extends AbstractModule {

@Override

protected void configure() {

bind(PersonService.class).to(ExoPeopleService.class);

bind(AppDataService.class).to(ExoPeopleService.class);

bind(ActivityService.class).to(ExoActivityService.class);

bind(Person.class).to(ExoPersonImpl.class);

}

}


Integreation (Guice Module)








Integration



webapp/opensocial/src/main/webapp/WEB-INF/web.xml

<context-param>

<param-name>guice-modules</param-name>

<param-value>

org.exoplatform.social.opensocial.ExoSocialApiGuiceModule

</param-value>

</context-param>


Integration (Config in Web.xml)

www.exoplatform.com


Re-Cap



- OpenSource implementation of OpenSocial & Gadgets standard (Java, PHP)

- Client and Server side (Container, REST, OpenSocial APIs …)

- Java version: Servlet stack

- Multiple entry points for various kinds of calls (servlets)

- Others: Image Resizer, Content Rewriter/Compressor ...


Re-Cap




Why not?



Home Page: http://shindig.apache.org/

Downloads: http://shindig.apache.org/download/index.html

Mailing Lists: http://shindig.apache.org/mail-lists.html

Source Code: http://svn.apache.org/repos/asf/shindig/

Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG

Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/


Resources

www.exoplatform.com


Thank you!

Technology

Shindig in 2 hours