com.restfb
Class DefaultFacebookClient

java.lang.Object
  com.restfb.DefaultFacebookClient

All Implemented Interfaces:

FacebookClient

public class DefaultFacebookClient
extends Object
implements FacebookClient

Default implementation of a Facebook Graph API client.

Author:

Mark Allen

Constructor Summary

DefaultFacebookClient()
Creates a Facebook Graph API client with no access token.

DefaultFacebookClient(String accessToken)
Creates a Facebook Graph API client with the given accessToken.

DefaultFacebookClient(String accessToken, WebRequestor webRequestor, JsonMapper jsonMapper)
Creates a Facebook Graph API client with the given accessToken, webRequestor, and jsonMapper.

Method Summary

boolean	deleteObject(String object) Performs a Graph API delete operation on the given object.
<T> T	executeMultiquery(Map<String,String> queries, Class<T> objectType, Parameter... parameters) Executes an FQL multiquery, which allows you to batch multiple queries into a single request.
<T> List<T>	executeQuery(String query, Class<T> objectType, Parameter... parameters) Executes an FQL query.
<T> Connection<T>	fetchConnection(String connection, Class<T> connectionType, Parameter... parameters) Fetches a Graph API Connection type.
<T> T	fetchObject(String object, Class<T> objectType, Parameter... parameters) Fetches a single Graph API object.
<T> T	fetchObjects(List<String> ids, Class<T> objectType, Parameter... parameters) Fetches multiple Graph API objects in a single call.
<T> T	publish(String connection, Class<T> objectType, InputStream binaryAttachment, Parameter... parameters) Performs a Graph API publish operation on the given connection and include a file - a photo, for example - in the publish request.
<T> T	publish(String connection, Class<T> objectType, Parameter... parameters) Performs a Graph API publish operation on the given connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFacebookClient

public DefaultFacebookClient()

Creates a Facebook Graph API client with no access token.

Without an access token, you can view and search public graph data but can't do much else.

DefaultFacebookClient

public DefaultFacebookClient(String accessToken)

Creates a Facebook Graph API client with the given accessToken.

Parameters:

accessToken - A Facebook OAuth2 access token.

DefaultFacebookClient

public DefaultFacebookClient(String accessToken,
                             WebRequestor webRequestor,
                             JsonMapper jsonMapper)

Creates a Facebook Graph API client with the given accessToken, webRequestor, and jsonMapper.

Parameters:

accessToken - A Facebook OAuth2 access token.

webRequestor - The WebRequestor implementation to use for sending requests to the API endpoint.

jsonMapper - The JsonMapper implementation to use for mapping API response JSON to Java objects.

Throws:

NullPointerException - If jsonMapper or webRequestor is null.

Method Detail

deleteObject

public boolean deleteObject(String object)
                     throws FacebookException

Description copied from interface: FacebookClient

Performs a Graph API delete operation on the given object.

Specified by:

deleteObject in interface FacebookClient

Parameters:

object - The ID of the object to delete.

Returns:

true if Facebook indicated that the object was successfully deleted, false otherwise.

Throws:

FacebookException - If an error occurred while attempting to delete the object.

See Also:

FacebookClient.deleteObject(java.lang.String)

fetchConnection

public <T> Connection<T> fetchConnection(String connection,
                                         Class<T> connectionType,
                                         Parameter... parameters)
                              throws FacebookException

Description copied from interface: FacebookClient

Fetches a Graph API Connection type.

Specified by:

fetchConnection in interface FacebookClient

Type Parameters:

T - Java type to map to.

Parameters:

connection - The name of the connection, e.g. "me/feed".

connectionType - Connection type token.

parameters - URL parameters to include in the API call (optional).

Returns:

An instance of type connectionType which contains the requested Connection's data.

Throws:

FacebookException - If an error occurs while performing the API call.

See Also:

FacebookClient.fetchConnection(java.lang.String, java.lang.Class, com.restfb.Parameter[])

fetchObject

public <T> T fetchObject(String object,
                         Class<T> objectType,
                         Parameter... parameters)
              throws FacebookException

Description copied from interface: FacebookClient

Fetches a single Graph API object.

Specified by:

fetchObject in interface FacebookClient

Type Parameters:

T - Java type to map to.

Parameters:

object - ID of the object to fetch, e.g. "me".

objectType - Object type token.

parameters - URL parameters to include in the API call (optional).

Returns:

An instance of type objectType which contains the requested object's data.

Throws:

FacebookException - If an error occurs while performing the API call.

See Also:

FacebookClient.fetchObject(java.lang.String, java.lang.Class, com.restfb.Parameter[])

fetchObjects

public <T> T fetchObjects(List<String> ids,
                          Class<T> objectType,
                          Parameter... parameters)
               throws FacebookException

Description copied from interface: FacebookClient

Fetches multiple Graph API objects in a single call.

You'll need to write your own container type (objectType) to hold the results. See http://restfb.com for an example of how to do this.

Specified by:

fetchObjects in interface FacebookClient

Type Parameters:

T - Java type to map to.

Parameters:

ids - IDs of the objects to fetch, e.g. "me", "arjun".

objectType - Object type token.

parameters - URL parameters to include in the API call (optional).

Returns:

An instance of type objectType which contains the requested objects' data.

Throws:

FacebookException - If an error occurs while performing the API call.

See Also:

FacebookClient.fetchObjects(java.util.List, java.lang.Class, com.restfb.Parameter[])

publish

public <T> T publish(String connection,
                     Class<T> objectType,
                     InputStream binaryAttachment,
                     Parameter... parameters)
          throws FacebookException

Description copied from interface: FacebookClient

Performs a Graph API publish operation on the given connection and include a file - a photo, for example - in the publish request.

Specified by:

publish in interface FacebookClient

Type Parameters:

T - Java type to map to.

Parameters:

connection - The Connection to publish to.

objectType - Object type token.

binaryAttachment - The file to include in the publish request - a photo, for example.

parameters - URL parameters to include in the API call.

Returns:

An instance of type objectType which contains the Facebook response to your publish request.

Throws:

FacebookException - If an error occurs while performing the API call.

See Also:

FacebookClient.publish(java.lang.String, java.lang.Class, java.io.InputStream, com.restfb.Parameter[])

publish

public <T> T publish(String connection,
                     Class<T> objectType,
                     Parameter... parameters)
          throws FacebookException

Description copied from interface: FacebookClient

Performs a Graph API publish operation on the given connection.

Specified by:

publish in interface FacebookClient

Type Parameters:

T - Java type to map to.

Parameters:

connection - The Connection to publish to.

objectType - Object type token.

parameters - URL parameters to include in the API call.

Returns:

An instance of type objectType which contains the Facebook response to your publish request.

Throws:

FacebookException - If an error occurs while performing the API call.

See Also:

FacebookClient.publish(java.lang.String, java.lang.Class, com.restfb.Parameter[])

executeMultiquery

public <T> T executeMultiquery(Map<String,String> queries,
                               Class<T> objectType,
                               Parameter... parameters)
                    throws FacebookException

Description copied from interface: FacebookClient

Executes an FQL multiquery, which allows you to batch multiple queries into a single request.

You'll need to write your own container type (objectType) to hold the results. See http://restfb.com for an example of how to do this.

Specified by:

executeMultiquery in interface FacebookClient

Type Parameters:

T - Java type to map to.

Parameters:

queries - A mapping of query names to queries. This is marshaled to JSON and sent over the wire to the Facebook API endpoint as the queries parameter.

objectType - Object type token.

parameters - URL parameters to include in the API call (optional).

Returns:

An instance of type objectType which contains the requested objects' data.

Throws:

FacebookException - If an error occurs while performing the API call.

See Also:

FacebookClient.executeMultiquery(java.util.Map, java.lang.Class, com.restfb.Parameter[])

executeQuery

public <T> List<T> executeQuery(String query,
                                Class<T> objectType,
                                Parameter... parameters)
                     throws FacebookException

Description copied from interface: FacebookClient

Executes an FQL query.

Specified by:

executeQuery in interface FacebookClient

Type Parameters:

T - Java type to map to.

Parameters:

query - The FQL query to execute, e.g. "SELECT name FROM user WHERE uid=220439 or uid=7901103".

objectType - Resultset object type token.

parameters - URL parameters to include in the API call (optional).

Returns:

A list of instances of objectType which map to the query results.

Throws:

FacebookException - If an error occurs while performing the API call.

See Also:

FacebookClient.executeQuery(java.lang.String, java.lang.Class, com.restfb.Parameter[])