Welcome!

Eclipse Authors: Pat Romanski, Elizabeth White, Liz McMillan, David H Deans, JP Morgenthal

Related Topics: Eclipse, Adobe Flex

Eclipse: Article

A Runtime Integration Approach to Application Development

Plug-in Integrator Pattern

Figure 2 shows the basic components of the application. The UI of the application is simple, with a list/tree in the left panel to show different objects to be edited/viewed. On the right there is the editor/viewer container that is implemented using the Plug-in Integrator Pattern. The figure also shows component plug-ins to the container as tabs in the top. To view the object data as a graph, the view can be added statically to the container or loaded by the configurator, but depending on the requirements, View2 (the raw data view) and View3(Stats View) are added at a later time to augment the application functionality. View3 also needs to propagate a message to the View1, asking it to graph the new stats rather than just the data in object-1.

In this application different views for an object type are injected to the container at runtime and the existing components are used to provide new functionality as and when necessary by integrating plug-ins at runtime.   

 

The XML configuration file for the above application is shown in Annexure-2. 
 
The “containerConfiguration” element shows the basic container configuration with attributes for the container’s class and plug-in interface definitions. It also shows the plug-in components added to the container as child element “pluginComponent”.

As per the current application, the application ships with one plug-in component and the other two are injected to the container at a later time. Refer to Figure 3 for details.

In this application the container implements the Plug-in Integrator Pattern and hence there is only one component deployed to the container when it’s first shipped. In Figure 3 the first deployed XML is shown in bold face. Afterward the two other component views are added to the container and their definition gets added to the configuration accordingly as shown in Figure 3. For an application implementing this pattern, new views and functionality can be added dynamically without any need for compiling the application. In the next section we will see how these plug-in components can be integrated together to provide elegant user-friendly functionality.


To deploy an individual component to the container, it’s first required to implement the plug-in interface being exposed by the container. In the present case its mx.core.IUIComponent, so any Flex UI component can be plugged into the present container. Let’s consider the case of View3 and see how it has plugged into the container, initialized and hooked on to the View1 for graphing support during runtime, without changing any line of code or recompiling. The basic code listing for View3 is shown below.

<mx:Canvas>
<mx:Script>
<![CDATA[
public function initStatData(series:ArrayCollection,length:int):void
{//logic to come up with stats data from passed in ones
}
public function raiseGraphEvent():void{
  //raise the GRAPH EVT here
  dispatchEvent(new GrapphEvent("draw",dataProvider));
}
]]>
</mx:Script>
<mx:DataGrid >
  <mx:dataProvider>
    <mx:ArrayCollection id="dataProvider" />
  </mx:dataProvider>
  <mx:columns>
  <mx:DataGridColumn headerText="Sum" dataField="col1"/>
    …..
  </mx:columns>
</mx:DataGrid>
<mx:Label text="Stats for:Object"/>
<mx:Button label="GraphIt" click="raiseGraphEvent()"/>
</mx:Canvas>
 
The component shown above is pretty simple. It shows the basic mathematical operations on each row of the data series being represented by object-1. The function initStatData(..) is responsible for initializing the component, whereas the raiseGraphEvent() function raises an event having the new mathematical data series as the new data to draw a graph.

 <pluginComponent id="333345678" name="View3">
    <property name="label">
        <value><![CDATA[Stats View]]></value>
    </property>
    <moduleURL>/an/external/module/url-view3</moduleURL>
    <initParam type="funcHookup" bindToContainerProperty="editingObject">
        <selfFunction name="initStatsData">
            <arg name="param1">
               <objectRef srcObject="editingObject">
                    <evaluate expr="dataSeries"/>
               </objectRef>
            </arg>
            <arg name="param2">
               <objectRef srcObject="editingObject">
                <evaluate expr="dataSeries.processLength"/>
               </objectRef>
            </arg>                           
        </selfFunction>
    </initParam>               
</pluginComponent>

The listing above shows the configuration for the View3 plug-in component. The moduleURL is the location of the external module that contains the component plug-in. The component is initialized using the function hookup, calling the function “initStatData” with correct parameters being evaluated from the container’s editing object. As this component just raises an event of type GraphEvent and doesn't listen to any event by itself, there is no msgMap element required in the configuration. But this event will be tied in the View1 msgMap so that when this event is raised as a result of the “GraphIt” button click, the View1 can be refreshed with the graph drawing the mathematical result series. Let’s see the msgMap configuration of View1 to see how is that accomplished.

The msgMap configuration of View1 shows that it’s mapping View3 (referenced using the pluginCompid) GraphEvent with id “draw” to map to a handler for an event called “SomeEvent”.

<msgMap id="123456789" handler="event">
<srcExtentionPoint>
        <srcMsg id="draw" pluginCompid="333345678" type="somepkg::GraphEvent"/>
    </srcExtentionPoint>
    <destHandler>
        <destMsg id="graphIt" type="some.pkg::SomeEvent">
            <object clazz="some.pkg::SomeEvent">
                <property name="any">
                    <objectRef srcObject="srcEvent">
                        <evaluate expr="an.exp.to.get.req.data"/>
                    </objectRef>
                </property>
            </object>
        </destMsg>
    </destHandler>
</msgMap>

As in View3 the event raised was a different type ”GraphEvent”; it is needed to map that event to “SomeEvent” before propagating so that the handler function can handle it accordingly. It’s also possible to map the View3 GraphEvent to directly map to a handler in the View1 handler function; this can be achieved via the following msgMap configuration setting of View1.

 <msgMap id="123456789" handler="function">
<srcExtentionPoint>
        <srcMsg id="draw" pluginCompid="333345678" type="somepkg::GraphEvent"/>
    </srcExtentionPoint>
    <destHandler>
        <destHandlerFunc name="graphIthandlerFunc">
            <arg name="param1">
                <object clazz="some.pkg::SomeEvent">
                    <property name="any">
                       <objectRef srcObject="srcEvent">
                        <evaluate expr="an.exp.to.get.req.data"/>
                       </objectRef>
                    </property>
                </object>                       
            </arg>                   
        </destHandlerFunc>
    </destHandler>
</msgMap>

To come up with the msgMap setting, it’s required to go through the API documentation of both the components (View1 and View3). The configuration setting it just an easy way to integrate the functionality exposed by both components to come up with new features. The above example just shows the flexibility of the system when the Plug-in Integrator Pattern is used and the configuration is loaded externally and can be built and maintained with ease.

The concept of “initParam” to initialize a component based on a container variable to execute any component function to initialize state provides an efficient and easy way to glue components as plug-ins to the container. Also the msgMap to map any message or function callback from a source component to a message or function handler in the destination component provides the ultimate flexibility and integration points to build enterprise-ready products just by assembling already released and tested components at runtime.

This article is just an overview of the concepts being used in the Plug-in Integrator Pattern. The implementation of the pattern is already being done in Flex but needs some dedicated papers in that subject to explain.

Conclusion
The Plug-in Integrator Pattern discussed here is good for big projects being executed by enterprises where there are several groups working on separate projects of their own, but it becomes a breeze to integrate components from these already-released and tested projects to build new applications. It also provides a new dimension to Flex programming where the components being written once can be integrated in different projects without any change, thus promoting the “write once, deploy anywhere” concept. This pattern can readily be used in other platforms and programming languages to build flexible robust systems in no time. It also differs from the methodology used in already successful plug-in projects such as Eclipse and Firefox where the plug-ins are build on compile-time dependencies; this approach provides a way to build a plug-in based application with runtime aggregation.

More Stories By Indroniel Deb Roy

Indroniel Deb Roy works as an UI Architect for BlueCoat Systems.He has more than 10 years of development experience in the fields of J2EE and Web Application development. In his past he worked in developing web applications for Oracle, Novell, Packeteer, Knova etc. He has a passion for innovation and works with various Web2.0 & J2EE technologies and recently started on Smart Phone & IPhone Development.

More Stories By Alex Nhu

Alex Nhu works as a manager, UI Development at Packeteer Inc. He has more than 11 years of work experience designing and architecting complex server-side J2EE and XML applications. He loves developing Web applications with Flex now after getting a taste of developing UI using other RIA platforms.

Comments (1)

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.


@ThingsExpo Stories
BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
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 ...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
"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...
When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
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.
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.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"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...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...