Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.facebook.api.FacebookJsonRestClient Maven / Gradle / Ivy
package com.facebook.api;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import com.facebook.api.schema.Listing;
/**
* A FacebookRestClient that uses the JSON result format. This means results from calls to the Facebook API are returned as JSON and
* transformed into Java Object's.
*/
public class FacebookJsonRestClient extends ExtensibleClient {
// used so that executeBatch can return the correct types in its list, without killing efficiency.
private static final Map RETURN_TYPES;
static {
RETURN_TYPES = new HashMap();
Method[] candidates = FacebookJsonRestClient.class.getMethods();
// this loop is inefficient, but it only executes once per JVM, so it doesn't really matter
for ( FacebookMethod method : EnumSet.allOf( FacebookMethod.class ) ) {
String name = method.methodName();
name = name.substring( name.indexOf( "." ) + 1 );
name = name.replace( ".", "_" );
for ( Method candidate : candidates ) {
if ( candidate.getName().equalsIgnoreCase( name ) ) {
String typeName = candidate.getReturnType().getName().toLowerCase();
// possible types are Document, String, Boolean, Integer, Long, void
if ( typeName.indexOf( "object" ) != -1 ) {
RETURN_TYPES.put( method, "default" );
} else if ( typeName.indexOf( "string" ) != -1 ) {
RETURN_TYPES.put( method, "string" );
} else if ( typeName.indexOf( "bool" ) != -1 ) {
RETURN_TYPES.put( method, "bool" );
} else if ( typeName.indexOf( "long" ) != -1 ) {
RETURN_TYPES.put( method, "long" );
} else if ( typeName.indexOf( "int" ) != -1 ) {
RETURN_TYPES.put( method, "int" );
} else if ( ( typeName.indexOf( "applicationpropertyset" ) != -1 ) || ( typeName.indexOf( "list" ) != -1 ) || ( typeName.indexOf( "url" ) != -1 )
|| ( typeName.indexOf( "map" ) != -1 ) || ( typeName.indexOf( "object" ) != -1 ) ) {
// we don't autobox these for now, the user can parse them on their own
RETURN_TYPES.put( method, "default" );
} else {
RETURN_TYPES.put( method, "void" );
}
break;
}
}
}
}
/**
* Constructor.
*
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
*/
public FacebookJsonRestClient( String apiKey, String secret ) {
super( apiKey, secret );
}
/**
* Constructor.
*
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param connectionTimeout
* the connection timeout to apply when making API requests to Facebook, in milliseconds
*/
public FacebookJsonRestClient( String apiKey, String secret, int connectionTimeout ) {
super( apiKey, secret, connectionTimeout );
}
/**
* Constructor.
*
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param sessionKey
* the session-id to use
*/
public FacebookJsonRestClient( String apiKey, String secret, String sessionKey ) {
super( apiKey, secret, sessionKey );
}
/**
* Constructor.
*
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param sessionKey
* the session-id to use
* @param connectionTimeout
* the connection timeout to apply when making API requests to Facebook, in milliseconds
*/
public FacebookJsonRestClient( String apiKey, String secret, String sessionKey, int connectionTimeout ) {
super( apiKey, secret, sessionKey, connectionTimeout );
}
/**
* Constructor.
*
* @param serverAddr
* the URL of the Facebook API server to use
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param sessionKey
* the session-id to use
*
* @throws MalformedURLException
* if you specify an invalid URL
*/
public FacebookJsonRestClient( String serverAddr, String apiKey, String secret, String sessionKey ) throws MalformedURLException {
super( serverAddr, apiKey, secret, sessionKey );
}
/**
* Constructor.
*
* @param serverAddr
* the URL of the Facebook API server to use
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param sessionKey
* the session-id to use
* @param connectionTimeout
* the connection timeout to apply when making API requests to Facebook, in milliseconds
*
* @throws MalformedURLException
* if you specify an invalid URL
*/
public FacebookJsonRestClient( String serverAddr, String apiKey, String secret, String sessionKey, int connectionTimeout ) throws MalformedURLException {
super( serverAddr, apiKey, secret, sessionKey, connectionTimeout );
}
/**
* Constructor.
*
* @param serverUrl
* the URL of the Facebook API server to use
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param sessionKey
* the session-id to use
*/
public FacebookJsonRestClient( URL serverUrl, String apiKey, String secret, String sessionKey ) {
super( serverUrl, apiKey, secret, sessionKey );
}
/**
* Constructor.
*
* @param serverUrl
* the URL of the Facebook API server to use
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param sessionKey
* the session-id to use
* @param connectionTimeout
* the connection timeout to apply when making API requests to Facebook, in milliseconds
*/
public FacebookJsonRestClient( URL serverUrl, String apiKey, String secret, String sessionKey, int connectionTimeout ) {
super( serverUrl, apiKey, secret, sessionKey, connectionTimeout, -1 );
}
/**
* Constructor.
*
* @param serverUrl
* the URL of the Facebook API server to use
* @param apiKey
* your Facebook API key
* @param secret
* your 'secret' Facebook key
* @param sessionKey
* the session-id to use
* @param connectionTimeout
* the connection timeout to apply when making API requests to Facebook, in milliseconds
* @param readTimeout
* the read timeout to apply when making API requests to Facebook, in milliseconds
*/
public FacebookJsonRestClient( URL serverUrl, String apiKey, String secret, String sessionKey, int connectionTimeout, int readTimeout ) {
super( serverUrl, apiKey, secret, sessionKey, connectionTimeout, readTimeout );
}
/**
* The response format in which results to FacebookMethod calls are returned
*
* @return the format: either XML, JSON, or null (API default)
*/
public String getResponseFormat() {
return "json";
}
/**
* Extracts a String from a result consisting entirely of a String.
*
* @param val
* @return the String
*/
public String extractString( Object val ) {
if ( val == null ) {
return null;
}
try {
return (String) val;
}
catch ( ClassCastException cce ) {
logException( cce );
return null;
}
}
/**
* Sets the session information (sessionKey) using the token from auth_createToken.
*
* @param authToken
* the token returned by auth_createToken or passed back to your callback_url.
* @return the session key
* @throws FacebookException
* @throws IOException
*/
public String auth_getSession( String authToken ) throws FacebookException, IOException {
if ( null != this._sessionKey ) {
return this._sessionKey;
}
JSONObject d = (JSONObject) callMethod( FacebookMethod.AUTH_GET_SESSION, new Pair( "auth_token", authToken.toString() ) );
try {
this._sessionKey = (String) d.get( "session_key" );
Object uid = d.get( "uid" );
Object expires = d.get( "expires" );
try {
this._userId = (Long) uid;
}
catch ( ClassCastException cce ) {
this._userId = Long.parseLong( (String) uid );
}
try {
this._expires = Long.parseLong( expires.toString() );
}
catch ( ClassCastException cce ) {
this._expires = Long.parseLong( (String) expires );
}
if ( this.isDesktop() ) {
this._sessionSecret = (String) d.get( "secret" );
}
}
catch ( Exception ignored ) {
ignored.printStackTrace();
}
return this._sessionKey;
}
/**
* Parses the result of an API call from JSON into Java Objects.
*
* @param data
* an InputStream with the results of a request to the Facebook servers
* @param method
* the method
* @return a Java Object
* @throws FacebookException
* if data represents an error
* @throws IOException
* if data is not readable
* @see JSONObject
*/
protected Object parseCallResult( InputStream data, IFacebookMethod method ) throws FacebookException, IOException {
BufferedReader in = new BufferedReader( new InputStreamReader( data, "UTF-8" ) );
StringBuffer buffer = new StringBuffer();
String line;
while ( ( line = in.readLine() ) != null ) {
buffer.append( line );
}
String jsonResp = new String( buffer );
Object json = null;
if ( this.rawResponse.matches( "[\\{\\[].*[\\}\\]]" ) ) {
try {
if ( this.rawResponse.matches( "\\{.*\\}" ) ) {
json = new JSONObject( jsonResp );
} else {
json = new JSONArray( jsonResp );
}
}
catch ( Exception ignored ) {
ignored.printStackTrace();
}
} else {
if ( this.rawResponse.startsWith( "\"" ) ) {
this.rawResponse = this.rawResponse.substring( 1 );
}
if ( this.rawResponse.endsWith( "\"" ) ) {
this.rawResponse = this.rawResponse.substring( 0, this.rawResponse.length() - 1 );
}
try {
// it's either a number...
json = Long.parseLong( this.rawResponse );
}
catch ( Exception e ) {
// ...or a string
json = this.rawResponse;
}
}
if ( isDebug() ) {
log( method.methodName() + ": " + ( null != json ? json.toString() : "null" ) );
}
if ( json instanceof JSONObject ) {
JSONObject jsonObj = (JSONObject) json;
try {
Object errorCode = jsonObj.get( "error_code" );
if ( errorCode != null ) {
String message = (String) jsonObj.get( "error_msg" );
Integer code;
if ( errorCode instanceof Integer ) {
code = (Integer) errorCode;
} else {
code = ( (Long) errorCode ).intValue();
}
throw new FacebookException( code, message );
}
}
catch ( JSONException ignored ) {
// the call completed normally
}
}
return json;
}
/**
* Extracts a URL from a result that consists of a URL only. For JSON, that result is simply a String.
*
* @param url
* @return the URL
*/
protected URL extractURL( Object url ) throws IOException {
if ( url == null ) {
return null;
}
if ( ! ( url instanceof String ) ) {
return null;
}
return ( null == url || "".equals( url ) ) ? null : new URL( (String) url );
}
/**
* Extracts an Integer from a result that consists of an Integer only.
*
* @param val
* @return the Integer
*/
protected int extractInt( Object val ) {
if ( val == null ) {
return 0;
}
try {
if ( val instanceof String ) {
// shouldn't happen, really
return Integer.parseInt( (String) val );
}
if ( val instanceof Long ) {
// this one will happen, the parse method parses all numbers as longs
return ( (Long) val ).intValue();
}
return (Integer) val;
}
catch ( ClassCastException cce ) {
logException( cce );
return 0;
}
}
/**
* Extracts a Boolean from a result that consists of a Boolean only.
*
* @param val
* @return the Boolean
*/
protected boolean extractBoolean( Object val ) {
if ( val == null ) {
return false;
}
try {
if ( val instanceof String ) {
return ( ( val != null ) && ( ( val.equals( "true" ) ) || ( val.equals( "1" ) ) ) );
}
return ( (Long) val == 1l );
}
catch ( ClassCastException cce ) {
logException( cce );
return false;
}
}
/**
* Extracts a Long from a result that consists of an Long only.
*
* @param val
* @return the Integer
*/
protected Long extractLong( Object val ) {
if ( val == null ) {
return 0l;
}
try {
if ( val instanceof String ) {
// shouldn't happen, really
return Long.parseLong( (String) val );
}
return (Long) val;
}
catch ( ClassCastException cce ) {
logException( cce );
return null;
}
}
public String data_getUserPreference( Integer prefId ) throws FacebookException, IOException {
throw new FacebookException( ErrorCode.GEN_UNKNOWN_METHOD,
"The FacebookJsonRestClient does not support this API call. Please use an instance of FacebookRestClient instead." );
}
public Map data_getUserPreferences() throws FacebookException, IOException {
throw new FacebookException( ErrorCode.GEN_UNKNOWN_METHOD,
"The FacebookJsonRestClient does not support this API call. Please use an instance of FacebookRestClient instead." );
}
public void data_setUserPreference( Integer prefId, String value ) throws FacebookException, IOException {
throw new FacebookException( ErrorCode.GEN_UNKNOWN_METHOD,
"The FacebookJsonRestClient does not support this API call. Please use an instance of FacebookRestClient instead." );
}
public void data_setUserPreferences( Map values, boolean replace ) throws FacebookException, IOException {
throw new FacebookException( ErrorCode.GEN_UNKNOWN_METHOD, "The FacebookJsonRestClient does not support this API call. "
+ "Please use an instance of FacebookRestClient instead." );
}
public List marketplace_getListings( List listingIds, List uids ) throws FacebookException, IOException {
throw new FacebookException( ErrorCode.GEN_UNKNOWN_METHOD, "The FacebookJsonRestClient does not support this API call. "
+ "Please use an instance of FacebookRestClient instead." );
}
public List marketplace_getSubCategories() throws FacebookException, IOException {
throw new FacebookException( ErrorCode.GEN_UNKNOWN_METHOD, "The FacebookJsonRestClient does not support this API call. "
+ "Please use an instance of FacebookRestClient instead." );
}
public List marketplace_search( MarketListingCategory category, MarketListingSubcategory subcategory, String searchTerm ) throws FacebookException,
IOException {
throw new FacebookException( ErrorCode.GEN_UNKNOWN_METHOD, "The FacebookJsonRestClient does not support this API call. "
+ "Please use an instance of FacebookRestClient instead." );
}
public String admin_getAppPropertiesAsString( Collection properties ) throws FacebookException, IOException {
if ( this._isDesktop ) {
// this method cannot be called from a desktop app
throw new FacebookException( ErrorCode.GEN_PERMISSIONS_ERROR, "Desktop applications cannot use 'admin.getAppProperties'" );
}
JSONArray props = new JSONArray();
for ( ApplicationProperty property : properties ) {
props.put( property.getName() );
}
callMethod( FacebookMethod.ADMIN_GET_APP_PROPERTIES, new Pair( "properties", props.toString() ) );
return this.rawResponse;
}
/**
* Executes a batch of queries. You define the queries to execute by calling 'beginBatch' and then invoking the desired API methods that you want to execute as part
* of your batch as normal. Invoking this method will then execute the API calls you made in the interim as a single batch query.
*
* @param serial
* set to true, and your batch queries will always execute serially, in the same order in which your specified them. If set to false, the Facebook API
* server may execute your queries in parallel and/or out of order in order to improve performance.
*
* @return a list containing the results of the batch execution. The list will be ordered such that the first element corresponds to the result of the first query in
* the batch, and the second element corresponds to the result of the second query, and so on. The types of the objects in the list will match the type
* normally returned by the API call being invoked (so calling users_getLoggedInUser as part of a batch will place a Long in the list, and calling friends_get
* will place a Document in the list, etc.).
*
* The list may be empty, it will never be null.
*
* @throws FacebookException
* @throws IOException
*/
public List executeBatch( boolean serial ) throws FacebookException, IOException {
this.batchMode = false;
List result = new ArrayList();
List buffer = new ArrayList();
while ( !this.queries.isEmpty() ) {
buffer.add( this.queries.remove( 0 ) );
if ( ( buffer.size() == 15 ) || ( this.queries.isEmpty() ) ) {
// we can only actually batch up to 15 at once
JSONArray doc = (JSONArray) batch_run( encodeMethods( buffer ), serial );
for ( int count = 0; count < doc.length(); count++ ) {
try {
String response = (String) doc.get( count );
if ( response.startsWith( "\"" ) ) {
// remove extraneous quote characters
response = response.substring( 1, response.length() - 1 );
}
String type = RETURN_TYPES.get( buffer.get( count ).getMethod() );
// possible types are document, string, bool, int, long, void
if ( type.equals( "default" ) ) {
if ( response.matches( "\\{.*\\}" ) ) {
result.add( new JSONObject( response.replace( "\\", "" ) ) );
} else {
result.add( new JSONArray( response ) );
}
} else if ( type.equals( "string" ) ) {
result.add( response );
} else if ( type.equals( "bool" ) ) {
result.add( extractBoolean( response ) );
} else if ( type.equals( "int" ) ) {
result.add( extractInt( response ) );
} else if ( type.equals( "long" ) ) {
result.add( extractLong( response ) );
} else {
// void
result.add( null );
}
}
catch ( Exception ignored ) {
ignored.printStackTrace();
if ( result.size() < count + 1 ) {
result.add( null );
}
}
}
}
}
return result;
}
}
