org.opensocial

Class Client

java.lang.Object

org.opensocial.Client

public class Client
extends Object

OpenSocial RESTful client supporting both the RPC and REST protocols defined in the OpenSocial specification as well as two- and three-legged OAuth for authentication. This class handles the transmission of requests to OpenSocial containers such as orkut and MySpace. Typical usage:

   Client client = new Client(new OrkutProvider(),
         new OAuth2LeggedScheme(ORKUT_KEY, ORKUT_SECRET, ORKUT_ID));
     Response response = client.send(PeopleService.getViewer());
 

The send method either returns a single Response or a Map of Response objects mapped to ID strings. The data returned from the container can be extracted from these objects.

Author:

Jason Cooper

Constructor Summary

Constructors

Constructor and Description
Client(Provider provider, AuthScheme authScheme) Creates and returns a new Client associated with the passed Provider and AuthScheme.
Client(Provider provider, AuthScheme authScheme, HttpClient httpClient) Creates and returns a new Client associated with the passed Provider and AuthScheme.

Method Summary

Methods

Modifier and Type	Method and Description
AuthScheme	getAuthScheme() Returns the associated AuthScheme.
Provider	getProvider() Returns the associated Provider.
Map<String,Response>	send(Map<String,Request> requests) Submits the passed Map of Requests to the associated Provider and returns the container's response data as a Map of Response objects mapped to the same IDs as the passed requests.
Response	send(Request request) Submits the passed Request to the associated Provider and returns the container's response data as a Response object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Client

public Client(Provider provider,
      AuthScheme authScheme)

Creates and returns a new Client associated with the passed Provider and AuthScheme.

Parameters:

provider - Provider to associate with new Client

authScheme - AuthScheme to associate with new Client

Client

public Client(Provider provider,
      AuthScheme authScheme,
      HttpClient httpClient)

Creates and returns a new Client associated with the passed Provider and AuthScheme.

Parameters:

provider - Provider to associate with new Client

authScheme - AuthScheme to associate with new Client

httpClient - HttpClient to use with new Client

Method Detail

getProvider

public Provider getProvider()

Returns the associated Provider.

getAuthScheme

public AuthScheme getAuthScheme()

Returns the associated AuthScheme.

send

public Response send(Request request)
              throws RequestException,
                     IOException

Submits the passed Request to the associated Provider and returns the container's response data as a Response object.

Parameters:

request - Request object (typically returned from static methods in service classes) encapsulating all request data including endpoint, HTTP method, and any required parameters

Returns:

Response object encapsulating the response data returned by the container

Throws:

RequestException - if the passed request cannot be serialized, the container returns an error code, or the response cannot be parsed

IOException - if an I/O error prevents a connection from being opened or otherwise causes request transmission to fail

send

public Map<String,Response> send(Map<String,Request> requests)
                          throws RequestException,
                                 IOException

Submits the passed Map of Requests to the associated Provider and returns the container's response data as a Map of Response objects mapped to the same IDs as the passed requests. If the associated provider supports the OpenSocial RPC protocol, only one HTTP request is sent; otherwise, one HTTP request is executed per container request.

Parameters:

requests - Map of Request objects (typically returned from static methods in service classes) to ID strings; each object encapsulates the data for a single container request such as fetching the viewer or creating an activity.

Returns:

Map of Response objects, each encapsulating the response data returned by the container for a single request, to the associated ID strings in the passed Map of Request objects

Throws:

RequestException - if the passed request cannot be serialized, the container returns an error code, or the response cannot be parsed

IOException - if an I/O error prevents a connection from being opened or otherwise causes request transmission to fail