Skip to content

Latest commit

 

History

History
169 lines (115 loc) · 6.39 KB

readme.md

File metadata and controls

169 lines (115 loc) · 6.39 KB
Raw

#Seam Social

#THIS PROJECT IS NO MORE UNDER ACTVE DEVELOPMENT. THE INITIATIVE HAS MOVED TO AGORAVA PROJECT

##Changelog

3.2.0-SNAPSHOT includes a lot of new features

  • Introduction of SocialNetworkServicesHub to gather all API families for a given Social Service
  • SocialNetworkServiceHub is the main entrance for APIs in each Social Network Service now
  • Spliting of API to have smaller Service bean reflecting separation of REST API of Social Network
  • Better coverage of API for Twitter (70 %), Facebook (20 %) & LinkedIn (20 %)
  • Introduction of CDI events to have better decoupling between high level services and low level (Rest call)
  • API for integration in Seam Security
  • Upgrade to Java Scribe 1.3.0 and Jackson 1.9.2

##Introduction Seam Social Provides CDI Beans and extensions to interact with major social network.

Provides:

  • OAuth connectors to authentify with an OAuth providers
  • Support for Authentication for Twitter, LinkedIn and Facebook only right now
  • Status update for Facebook Twitter and LinkedIn
  • Support for multi-account (multi-service and multi session for the same service)

Seam Social is independent of CDI implementation and fully portable between Java EE 6 and Servlet environments enhanced with CDI. It can be also used with CDI in JSE (desktop application). It is build on top of scribe-java from fernandezpablo85 and forked API bindings developped on

Many thanks to Craig Walls and Spring Social Team for their helpfull work.

For more information, see the Seam Social project page.

##Building

mvn clean install

you need to be connected to internet to launch the tests. You can build without the tests like that :

mvn clean install -DskipTests=true

##Usage big picture

The Web example app is quite simple and give a good idea of possibilities of Seam Social Framework.

Main steps to use Seam Social are :

  • Declare an OAuth configuration
  • Inject an OAuthService bean
  • Request the Authorization URL for the service and get a request token
  • Store the verifier in OAuthService bean and init access token
  • Use the service

Should you need to fully understand each step, the complete OAuth lifecycle can be found here or here

##Starting with OAuth configuration

To consume an OAuth service you need to declare an application on the service platform (i.e. for Twitter you can do, this on https://dev.twitter.com/apps/new). The declaration of an application contains at least :

  • an API public key
  • an API private/secret key

To use an OAuth service bean in Seam social you need to provide these configuration information by producing the right OAuthService bean

  • thru an xml configuration (with Seam Solder XML config)
  • thru a producer Field or method

###Create an OAuthService bean thru Seam configuration (in bean.xml)

Due to limitation of Solder XML configuration you'll have to provide the implementation class of the bean in the configuration file Here is an example of such a configuration :

<beans xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:s="urn:java:ee"
    xmlns:o="urn:java:org.jboss.seam.social:org.jboss.seam.social.oauth">

<o:TwitterServicesHub>
        <s:modifies />
        <s:ApplicationScoped />
        <o:Twitter />
        <o:OAuthApplication apiKey="FQzlQC49UhvbMZoxUIvHTQ"
            apiSecret="VQ5CZHG4qUoAkUUmckPn4iN4yyjBKcORTW0wnok4r1k"
            callback="http://localhost:8080/social-web-client/callback.jsf" />
    </o:TwitterServicesHub>
</beans>

Api Key and Api secret is provided by the service you want to consume (here Twitter). You can use the values above since they're coming from "Seam Social" Twitter application. Callback depends on your application : it's the URL that will collect OAuth verifier

##Inject a SocialNetworkServicesHub bean with one of the following ways :

Using the Interface of the service

@Named
@SessionScoped
public class mySessionBean implements Serializable {
    ...
    @Inject
    @Twitter
    public TwitterServicesHub twitter;
    ...
}

or using the generic OAuthService with a Qualifier

@Named
@SessionScoped
public class mySessionBean implements Serializable {
    ...
    @Inject
    @Twitter
    SocialNetworkServicesHub service;
    ...
}

The two are equivalent but the second one give you a way to do polymorphic calls to the hub. The OAuthService provides methods in relation to authentication.

##Request the Authorization URL for the service and redirect the app to this url

If we go on with the same example, we can get this authorization URL with this call :

twitter.getService().getAuthorizationUrl();

It will return the URL needed to initiate connection to the service.

##Store the verifier in Hub bean and init access token

When we return from the service connection to the callback URL, we get a verifier that we need to store in the OAuthService and init the access token In JSF we do this like that

<f:metadata>
    <f:viewParam name="verifier"
        value="#{mySessionBean.twitter.session.verifier}"
                 required="true"
                 requiredMessage="Error with Twitter. Retry later"/>
    <f:event type="preRenderView"
        listener="#{mySessionBean.twitter.service.initAccessToken()}"/>
</f:metadata>

##After what we can send calls to the service

Getting the Twitter user profile

TwitterProfile user = twitter.getMyProfile();
String fullName = user.getFullName();

And we can also use all the services associated

@Inject
TwitterTimelineService tls;
...
tls.updateStatus("Hello");

##Testing

After building you can deploy the war generated in example/web-client/target in a Java EE 6 container implementing web profile (tested with JBoss 6 but should work in glassfish too)

##Known issues

  • Right now the Web example app doesn't run well on JBoss AS 7.0.2 : probably due to a JSF bug.