Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion, Adobe Flex

ColdFusion: Article

CFDJ Feature: Working with Web Services in Adobe Flex 2

Flex class introspection to gain strong typing

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

Transfer objects let two separate systems trade descriptive data objects without fear that either system will mistype the data or change the variable names. Transfer objects are an explicit agreement on how data will be encapsulated. They make integration easier because everyone can separate and build their system knowing what variable names and types will be traded. When someone modifies his version of the transfer object, the compile process should catch the changes and alert the file locations to fix the problems.

Flex automatically does the work of transferring a class type when using remote objects (one of the many reasons to use remote objects). However, when using SOAP Web Services, strong typing is broken because the class associations aren't automatically transferred to internal Flex classes. It's unfortunate, and leaves a bit of a gap when trying to use strong typing and compile-time error checking.

What's the value of strong typing? It makes it easier to debug the application. Instead of complaining at some obscure point when a user clicks on a certain button in the middle of a complicated workflow, it breaks during the compile process where the problem can be easily found and fixed. What could have been a two- hour search for a misnamed variable becomes a five-minute change.

The problem here though is how to get the untyped SOAP objects created by Flex into typed objects that Flex knows about - internal implementations of the transfer objects. The values themselves are typed, but there's no association between this data and the transfer object. Further, Flex can't be told that x SOAP object is actually of type y class. For example, trying to cast an incoming Web Service object into a user-defined TO class will cause a runtime error:

public var dpHistory:HistoryTo = event.result.HistoryTo as HistoryTo;

or

public var dpHistory:HistoryTo = HistoryTo(event.result.HistoryTo);

When I started trying to use strong typing of classes on the Flex side, I tried to do the transition by writing a custom transfer function for each type of class I had. For example:

var dpHistory:ArrayCollection = new ArrayCollection;
var tempObj:HistoryTo;
For (var i=0;i<webServiceReturn.result.HistoryTos.length; i++) {
tempObj = new HistoryTo;
tempobj.message = webServiceReturn.result.HistoryTos.getItemAt(i).message;
tempobj.objectName = webServiceReturn.result.HistoryTos.getItemAt(i).objectName;
.......
dpHistory.addItem(tempObj);
}

What a pain! It's error prone and doesn't allow for reuse. It's boring and adds to the amount of upkeep you have to do if anything changes. In the beginning, I avoided using transfer objects simply because that I didn't want to go through the pain of actually coding up every one of my Web Service returns like this. There are a lot of benefits to be gained by using transfer objects, but using the methodology above was horrible getting to them.

To me, the drawbacks (i.e., less code reuse, more duplicate coding, etc.) appeared to outweigh the benefits. Sure, these functions can be written up and saved as an ActionScript file somewhere and included when needed, but it looked like one transfer function was needed per transfer object. And that can be a real pain, especially in a large project with numerous transfer objects.

I figured there had to be a better way. After hunting around a bit, I came up with a solution that worked for my project. All that was needed was a generic object transfer utility to translate the incoming objects into typed classes that are created on the Flex side. Once the transfer objects have been written on the Flex side, then class introspection can be used to dynamically populate the values from untyped Web Service objects. Let me show you how I did it.

First off, create a transfer object class. One of the beautiful things about Flex is the automatic getters and setters for public variables on classes. This means that creating a transfer object can be very simple. Flex is flexible enough to use explicit getters and setters as public properties or to take public properties/variables and create automatic getters and setters for them. Creating custom transfer objects then becomes a breeze and literally takes just a few minutes to put together.

For example, a simple class might be a history display class:

package comp.myProject.to    {
public class HistoryTo {

       public var creationDate:Date = new Date;
       public var message:String = new String;
       public var objectName:String = new String;
       public var objectType:String = new String;

       public function HistoryTo() {
       }

    }
}

Once the custom class (transfer object) has been created on the Flex side, it can be used to store variables. Flex Builder knows about this class and can display hinting on the class names, warn when a property name has been misspelled, and make sure that the properties and values maintain their type across the application. The biggest challenge is filling the class with the proper information.

With a plain object or dynamic class, getting the dynamic values contained inside is done by looping through its properties (dynamic properties are values added to a dynamic class at runtime, like adding variables to a plain object). For example:

    for (item in myObject) {
       // do something here
       myVar = myObject[item];
}

Unfortunately, classes don't support this method for finding static properties. This is where class introspection comes to the rescue. Class introspection returns a listing of all static properties of a class and the types of those properties. Best of all, class introspection is actually very easy in Flex. For example, there's a function in Flex that returns an XML structure of all the class properties:

    import flash.utils.describeType;

var classInfo:XML = describeType(HistoryTo);

The function describeType returns an XML structure that can be looped over to get a listing of the public static properties, class methods, class name, and class base reference (if it extends a class). The function describeType won't return dynamic properties, private properties, or private functions. In the example, the classInfo variable now contains an XML object that can be looped through and/or treated like any other XML-type data source. For instance, it could output the results in a tree (a la the old object inspector for Flex 1.5). In this case, it can be used to loop through the Flex-side transfer classes, pull out the variables and types, check them against the Web Service objects, and transfer the Web Service object values to the appropriate class variables.

The root node contains the name of the class and the name of the class that it extends (if any):

var className:String = [email protected];

To get the list of public variables on the class is relatively simple as well.

The classInfo..variable contains an array of variable names and variable types. Looping through them allows for assignment from one variable to the next:

var vName:String;
var vType:String;

for each (var v:XML in classInfo..variable) {
    // set the xml name and type options to strings for easy comparison
vName = [email protected];
    vType = [email protected];
//do something here
}


More Stories By John Hirschi

Jon Hirschi is a Senior Web Developer at eBay Inc. specializing in content and knowledge management systems. He has been using ColdFusion since version 4.0.

Comments (4) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
Joel Marks 12/20/06 06:43:54 PM EST

Is this utility only meant for Cold Fusion because I tried to test it out using a regular Axis web service and the translators only return null.

Thanks

n d 08/27/06 03:26:23 PM EDT

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

n d 08/27/06 12:11:43 PM EDT

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

n d 08/27/06 11:35:16 AM EDT

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

@ThingsExpo Stories
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Conference Guru has been named “Media Sponsor” of the 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. A valuable conference experience generates new contacts, sales leads, potential strategic partners and potential investors; helps gather competitive intelligence and even provides inspiration for new products and services. Conference Guru works with conference organizers to pass great deals to gre...
The Internet of Things will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform. In his session at @ThingsExpo, Craig Sproule, CEO of Metavine, demonstrated how to move beyond today's coding paradigm and shared the must-have mindsets for removing complexity from the develop...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.