Skip to main content

Using GAE as a OData service for the data layer

One of the many challenges of software development is to allow your application to save its data into a reliable repository from anywhere in the world. With Google App Engine (GAE) and its cloud service, you can put the data layer of your application in the cloud and still use your preferred programming language to create your business and presentation layers. By exposing your GAE database using OData (http://www.odata.org/), you get a flexible way of storing and retrieving your data from any desktop client or mobile application including C# based applications. The best thing is that GAE offers free quotas unlike Microsoft Azure's offerings.

One OData library that I know works in GAE is odata-py ( http://code.google.com/p/odata-py/). After downloading the latest version (using SVN), you can start using the sample GAE application that comes with it. There is however, one small fix you need to make. Modify core.py to prevent an exception when getting the Key from the url when the key is missing; so in the parse_request_url method, instead of match.group('key')[1:-1] make it read:

      key_match = match.group('key')
      if (key_match and isinstance(key_match, str)):
            key = key_match[1:-1]   # strip quotes for URLs with the form http://app/odata.svc/Model('key')
      else:
            key = ''

One way to access the odata service from C#, is to add a service reference in Visual Studio to http://localhost:8080/odata.svc ( 8080 is the default port for GAE development) or to your realgaeapp.appspot.com/odata.svc. Basically the service definition lives in odata.svc in your GAE app. Visual Stuio will generate a proxy for your data service. The following is a sample on how to use the sample service from a C# console app:

static void Main(string[] args)
        {
            GAEODATAService.model.default_container proxy = new GAEODATAService.model.default_container(new Uri("http://localhost:8080/odata.svc"));
            //Uncomment below lines to add a Pet
            proxy.AddToPet(new Pet() { key = "0", name = "Lilo", weight_in_pounds = 10, type = "cat" }); //must be one of set(['bird', 'dog', 'cat'])
            proxy.SaveChanges();
          
            var all_pets = proxy.Pet;
            foreach (var pet in all_pets)
            {
                Console.Out.WriteLine("Pet {0}, weight: {1}, type: {2}", pet.name, pet.weight_in_pounds, pet.type);
            }
            Console.ReadLine();
        }

As you can see from the example, GAE's High Replication Datastore becomes your reliable, fast and free (if you stay below the free quota) data layer for your .NET application. With odata in GAE, you can create your rich desktop or mobile application and have it distributed as a click-once install (which you could possibly host as a static file in GAE), and not be afraid of loosing your user's data because the data is coming and going to the cloud. This way your business and presentation logic get offloaded from your overburdened servers to the user's computer or phone.

It is also important to note that not all the application are data centered CRUDs like the example above, but you can also program your GAE data layer to handle custom web methods.

Comments

Unknown said…
The information that you provided was thorough and helpful. I will have to share your article with others.

OData Development

Popular posts from this blog

Power Automate: SFTP action "Test connection failed"

When I added an SFTP create file action to my Power Automate flow ( https://flow.microsoft.com ) , I got the following error in the action step, within the designer: "Test connection failed" To troubleshoot the Power Automate connection, I had to: go the Power Automate portal then "Data"->"Connections"  the sftp connection was there, I clicked on the ellipsis, and entered the connection info It turns out, that screen provides more details about the connection error. In my case, it was complaining that "SSH host key finger-print xxx format is not supported. It must be in 'MD5' format". I had provided the sha fingerprint that WinScp shows. Instead, I needed to use the MD5 version of the fingerprint. To get that, I had to run in command line (I was in a folder that had openssh in it): ssh -o FingerprintHash=md5 mysftpsite.com To get the fingerprint in MD5 format. I took the string (without the "MD5:" part of the string) and put ...

How to create online multiplayer HTML5 games in Contruct2

  Construct2 can use websockets to send and receive messages between games. By using socket-io , we can use a Node.js script as the server and my modification to the socket-io plugin for Construct2 to allow the games to synchronize data between them in real-time. There are two parts to this design: the Node.js server and the Construct2 clients (the games playing). The main part of building an online multiplayer HTML5 game is to plan: how the clients will communicate how often and what to communicate how much of the logic will go into the server and how much to the client. In my sample game, I chose to have each client own a player and have the server just relay messages: Use string messages in the form TypeOfMessage, Parameter1, Paremeter2, Parater3, etc to communicate. Have the clients send their player position about 16 times a second. Whenever their player shoots, the client needs to send a message immediately. Almost all of the game logic will...

How to use Windows SSO with OpenXava

One of the nice things about the .NET web environment is the dead easy way to implement Single Sign On in your web apps through Active Directory authentication. In the Java world there are multiple alternatives to use Windows’ Single Sign On with Java based web apps. One of those alternatives is Waffle . Waffle allows your Java web app to authenticate against Active Directory groups (and users). The only caveat is that your web server needs to be running in Windows, which kind of makes sense. In this article, you will learn the steps required to have your OpenXava web application use Waffle to authenticate your Windows users. The first step is to download Waffle from their site and then copy the JAR files outlined in https://github.com/dblock/waffle/blob/master/Docs/tomcat/TomcatSingleSignOnValve.md to the OpenXava’s tomcat server. In your OpenXava project, create servlets.xml in the Web-inf, containing the following: <!-- the role name (the domain gorup) must be e...