Skip to main content

A tiny Java connector for Facebook

This article explains my spare time initiative, a small piece of Java connector for Facebook API. Though I completed this piece of code back in early 2008, I didn't get enough time to structure this write up.... Anyway..., it demonstrates a set of key concepts e.g. authentication, signature code and session key generation to access REST architecture based Facebook API.

Rather than providing a complete API solution, I believe it will help to understand specific concepts like the connection setup process that runs behind any 3rd party Facebook Connection API. So, let’s start....


Pre-Requisites

Please follow these steps before you start the implementation-

  • Register with Facebook
  • Register your application with Facebook (Registering an application will give you API Key and Secret Key)
  • Go To http://www.facebook.com/developers/ and Register an Application (You have to just specify any name for your application e.g. “Test”)
  • Collect API Key and Secret. Both API Key and Secret consists of 32 alphanumeric.


Facebook API
Facebook provides a REST based API for developers to create applications which can be integrated with Facebook. Each REST URL signifies a different set of information object.

There is a little bit difference in the way a Web Application access this API from Desktop applications. I will not elaborate this as you will get sufficient information on Facebook Developer's Section.

The Java connector consists of 2 core modules- HTTP Handler and Signature Generator.

HTTP Handler

It sends POST HTTP requests to http://api.facebook.com/restserver.php for accessing Facebook API methods. Following code snippet sends and receives HTTP POST request/response-


URL FB_URL = new URL(“http://api.facebook.com/restserver.php”);

HttpURLConnection conn = (HttpURLConnection)FB_URL.openConnection();

conn.setRequestMethod("POST");

conn.setDoOutput(true);

conn.setDoInput(true);

conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");

conn.connect();


//Send Request Parameters

System.out.println ("Sending Request Parameters...");

OutputStream out = conn.getOutputStream();

out.write(reqParms.getBytes());

out.flush();


System.out.println ("Response Code="+conn.getResponseCode());

System.out.println ("Get Response...");

BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));

String line;

StringBuffer outputData = new StringBuffer();

while ((line = rd.readLine()) != null) {

// Process line...

outputData.append(line);

System.out.println(line);

}


reqParms is a string concatenation of HTTP POST request parameters e.g. api_key=API_KEY&v=1.0



Signature Generator

Following steps depicts implementation of the signature code generation algorithm (explained here)-


Step1- Define a String Array to hold API parameter-value pairs-

Define a String Array to hold all the HTTP parameter values to

be passed along with the REST URL-

http://api.facebook.com/restserver.php?parm1=value1&....

apiReqParms: is the String array of HTTP parameter values e.g.


String apiReqParms[] = {"method=auth.getSession","api_key=API_KEY"};



Step2- Sort the String Array

// Sort the apiReqParms Array Alphabetically

Arrays.sort(apiReqParms, String.CASE_INSENSITIVE_ORDER);



Step3- Concatenate all parameter-value pairs

// Concatenate all the parameter-value pairs and the API Secrete string

String reqParmsStr = "";

// Concate

for (int i = 0; i <>

reqParmsStr += apiReqParms[i];

}

reqParmsStr += SECRET;



Step4- Generate MD5

// Generate the MD5 Hash of the string generated in Step3

java.security.MessageDigest md = java.security.MessageDigest.getInstance("MD5");

md.update(reqParmsStr.getBytes());

byte keyB[] = md.digest();



Step5- Generate Signature

/*

* Generate Hexadecimal Code of the 16 byte hash obtained in Step4.

* The generated Hex code is the signature to be used for connectivity.

*/

String signature = getHexCode(keyB);


public String getHexCode(byte byteA[]){

byte dig = 0;

//Capital letters doesn't work with Facebook API

char hexCode[] = {'0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f'};

String hexVal = "";

byte msn,

lsn;

for(int i=0; i

dig = byteA[i];

msn = (byte)((dig >> 4)&0x0F);//Most Significant Nibble

lsn = (byte)(dig&0x0F);//Least Significant Nibble

hexVal = hexVal + hexCode[msn] + hexCode[lsn];

}

return hexVal;

}



Once you cover all the above 5 steps you will get a workable 16 byte MD5 Hash (in Hexadecimal) which can be used for API access.


Session Key Generation

There is a concept of Infinite Session in Facebook which allows applications to use and stay online forever until corresponding user explicitly logged out. By default Facebook gives One-Time Session Key.

Following steps depectics the process to generate infinite session key-

Step1: Access following URL with your API_KEY using the browser-

http://www.facebook.com/code_gen.php?v=1.0&api_key=API_KEY


Step2: Note the Authentication Token returned in Step1 (consistes of 6 characters).


Step3: Call auth.getsession function of REST API by passing Auth_Token (obtained from Step2) as input parameter to generate the Session Key (consists of 32 characters).


Step4: Use the Session Key obtained from Step3 in your application.


Once you have the Session Key, your application will be able to connect to Facebook server. Now as you are able to successfully connect to Facebook server, you can use the HTTP Handler module to access different Facebook API methods and need to develop an XML parser to extract output of these method invocation.


So you are all set to develope the next killing Facebook App...All the best :-)

I hope this small piece of work will help people who wants to explore the anatomy of Facebook API connection setup. Any feedback and comments are greatly appreciated....


Reference

Labels:

Comments

Post a Comment

Popular posts from this blog

Android Parcelable Example

Few days back I had a requirement to send a ArrayList of my Custom Class Objects through Android Intent , I guess most of you also find this requirement now and then. I never thought it can be that tricky. There are built in functions in Intent to send ArrayList of primitive objects e.g. String, Integer, but when it comes to Custom Data Handling Objects, BOOM … you need to take that extra pain! Android has defined a new light weight IPC ( Inter Process Communication ) data structure called Parcel , where you can flatten your objects in byte stream, same as J2SDK’s Serialization concept. So let’s come back to my original requirement, I had a Data Handling class, which groups together a set of information- public class ParcelData {       int id;       String name;       String desc;       String[] cities = {"suwon", "delhi"}; } I want an ArrayList<ParcelData> of Data Handling objec...
62 comments
Read more

Call Control in Android

This tutorial is for those who want to control Phone Call in Android OS. Programmatic approach to Accept or Reject call without user intervention. Kindly note, this approach uses Java Reflection to call methods of an internal class of Android Telephony Framework and might not work with all versions of Android OS. The core concept has been explained in this Android open code . 1st thing 1st, Give the permission . You need to define 3 User Permissions to handle call related functionality- android.permission.READ_PHONE_STATE android.permission.MODIFY_PHONE_STATE (For answerRingingCall() method) android.permission.CALL_PHONE (For endCall() method) Define a Receiver... Create a Receiver which accepts broadcasts with intent action android.intent.action.PHONE_STATE, define following in the Manifest- [receiver android:name=".PhoneCall"]         [intent-filter]             [action android:name="android.in...
147 comments
Read more

Android Looper and Toast from WorkerThread

Have you ever tried to launch Android Toast message from worker thread? Probably you are wondering why the heck it is giving this error- java.lang.RuntimeException: Can't create handler inside thread that has not called Looper.prepare() In this article we are going to explore reason behind the above exception and try to understand how Looper works in Android. At the end, I am going to explain one approach to run Toast from a worker thread, but before that we need to understand how Looper works. If you already know in/out of Looper, you can skip below section and directly move to the solution part. Looper is a very basic wrapper class which attach a MessageQueue to a Thread and manage this queue. MessageQueue is a structure to sequentialize simultaneous processing requests of a Thread.  In Android, message/request processing classes like Handler uses Looper to manage their respective MessageQueue. Looper = Thread + MessageQueue Android Looper Life Cycle: As you can see in the abo...
6 comments
Read more

Overlay on Android Layout

This will help you to create custom Layout and add Overlay on a LinearLayout. The concept can be reused on other Layout classes i.e. RelativeLayout, FrameLayout etc. I have added a popup Selection Palette, containing "Map Pin" and "List" icons. You can minimize the popup by clicking on the section in Green on the left side bottom corner of the screen.   How can I do that- You need to follow 4 steps- 1. Override LinearLayout Create a Class MyLinearLayout.java which should overwrite LinearLayout 2. Drawing You need to overwrite dispatchDraw (Canvas canvas) method. It gives control to the whole screen. Make sure you set android:layout_height="fill_parent" for the associated layout definition in XML. You can draw anything and anywhere on the canvas. dispatchDraw (Canvas canvas) gets called only after underlying views are drawn, so whatever you draw comes in the foreground.   3. Event Handling You need to overwrite dispatchTouchEvent (MotionEvent e...
12 comments
Read more

Android Custom TextView

Have you ever tried to add custom behavior to in-build Android Text View or create custom attributes? If yes, this article is going to help you. Here we'll create Single Custom TextView with support for custom attributes to display First and Last Name in different font and colors. During this process we'll learn following topics- 1. How to override default Views in Android 2. How to define custom Layout Attributes in Android So, Let's get started... Following sections explains necessary changes required in Java code and XML layout files. Create Custom Text View (MyTextView.java) 1. Override Android's default TextView   2. Implement Constructors. If you want custom attributes, override Constructor having Attributes in argument. 3. Override onMeasure(): Calculate required width and height, based on Text Size and selected Font. Once calculation is complete, set updated measure using setMeasuredDimension (reqWidth, reqHeight) Note: It’s really important to define the corr...
12 comments
Read more

Google SpreadSheet Library for Android

You might have already tried using Google's GData Lib to access SpreadSheet from Android, and after few hours of try, you start Google for any alternate solution. I have also spent number of hours without any solution. So, I have developed SpreadSheet client Lib [ works on Android :-) ] and ideally work on any Java platform- http://code.google.com/p/google-spreadsheet-lib-android/ Latest version: 2.1 (Added support for List Feed. Please visit above link to get more info.) Supported Features: 1. Create/Delete Spreadsheet 2. List all stored Spreadsheets 3. Add/Delete WorkSheet into/from a given SpreadSheet 4. List all Worksheets of a given Spreadsheet 5. Add Records into WorkSheet/SpreadSheet (It supports Table based record handling) 6. Retrieve Record from WorkSheet/SpreadSheet ( Structured Query support) 7. Retrieve Record as List Feed from Worksheet 8. Update/Delete Records 9. Share ShreadSheet with user/group/domain. 10. Conditional data retrieval- ...
117 comments
Read more

Android Fragment

Fragment is being hanging out since Andriod 3.0, but with the release of 4.0, it has become an obvious choice for Android Application development for both Tabs and Smart phones. Few people think, fragment is a " Superman " which can add any kind of UI layout/style/decoration. But that is not true, rather than being an UI layout or decoration enhancer, Fragment is a very important concept to manage segments of your UI component code base . Prior to Fragment, developers were able manage UI flow only at the Activity level. All UI components were Views (mentioned in XML layout and part of Activity) and there was no way to manage these components separately. As a result all view management code were in a single file i.e. Activity class. With fragment approach, we can now remove View management code from Activity and place them in their respective Java classes. So, a pretty neat approach for code management. Here I'll explain various concepts of Fragment with an example appli...
8 comments
Read more

HashMap Internal

I always wanted to implement the logic behind the famous data structure of Java , HashMap and here it comes. Though it’s not the complete implementation considering all optimization scenarios, but it will highlight the basic algorithm behind the HashMap . So let’s start, this implementation will use my LinkedList implementation (Reason: for this implementation I thought to write everything from the scratch apart from primitive data types. Sounds weird? May be ;-) ). You may refer my earlier post on LinkedList , as I’m going to use it. HashMap is a key-value pair data structure, where you retrieve value by passing key. To optimize the search of key, a concept of Bucket (an Array of Java Objects) has been introduced. This is used, so that if search hits this Bucket , corresponding value element is instantly retrieved, otherwise it iterates sequentially through the Linked List associated with each Bucket element. So you can say if all HashMap elements get fit into the Bucket, retrieving...
12 comments
Read more

Accessing Yahoo Finance API

Since last few days I was wondering the right set of Web Service to read Country wise Stock Exchange index information . I found a bunch of scattered information, but no straight forward answer. It seems there are not many "reliable" and "flexible" options and Yahoo Finance is one of the top of this class. Though Yahoo Finance is very powerful, some how its very less documented and it seems Yahoo doesn't care much about this wonderful web service and expect Developers to do some kind of "hacking". The only online resource that I (and most of you as well ) found is one 3rd party web site- http://www.gummy-stuff.org/Yahoo-data.htm and it seems they know much more than what Yahoo dose..;-) Anyway let me continue and share my experience and information to help budding developer who wants to use Yahoo Finance Web Service in their Mobile, Web o r Desktop s olution. There are 2 set of APIs to access Yahoo Finance details- YQL based Web Service : Th...
3 comments
Read more

Eclipse EGIT, Download Code, Attach Framework code & Debug

This article explains procedure to download Android source (few important Apps and Framework base code) using Eclipse EGit plugin and then attach framework code to debug important framework classes (e.g. Activity etc.). Install EGit Download Source from GIT Repository Attach Framework code Debug Download EGit Plug-in EGit is a GIT plugin for Eclipse which helps to mange GIT clone, Check-ins, Sync etc. from your Eclipse workspace. Eclipse (Version: 3.7.x) -> Help -> Install New Software -> "Add" - " http://download.eclipse.org/egit/updates ". Once the plug-in installation is successful, you'll find a new Eclipse View perspective- "Git Repository Exploring"    Download Android source To download code from Android GIT repository, we need to create "local Git clone". Each local clone is associated with Remote Clone URL.   https://android.googlesource.com/ lists Git Repository URLs for different sections of An...
1 comment
Read more