Flex upload and download with Blazeds

With Actionscript 3 and Flashplayer 10 you can now use the new FileReference features. For example you download and upload a file with RemoteObjects ( Blazeds / LifeCycle ). In the early days you had to use a upload and download servlets.
To use the new FileReference features please read these two articles flexexamples.com and using flashplayer 10

Here are some screenshots of the flex application.
First we can upload a file. The datagrid show the status of the uploaded files.

Off course we can download some files from a remote server. First we need to get a list of the remote files. For this we need to press the Get remote files button.

We can select a file and press the Retrieve File Button. When the status is ready we can save this file by pressing the Save File Button.

Here you can download the Flex source code

The code of the upload panel

<?xml version="1.0" encoding="utf-8"?>
<mx:Panel xmlns:mx="http://www.adobe.com/2006/mxml"
layout="vertical" width="100%"  height="100%"
title="Upload Files">


<mx:Script>
 <![CDATA[
  import mx.rpc.AsyncToken;
  import mx.rpc.events.FaultEvent;
  import mx.rpc.events.ResultEvent;
  
  private var refUploadFile:FileReference;

  private var UploadFiles:Array = new Array();
 
 
  // Called to add file(s) for upload
  private function addFiles():void {
   refUploadFile = new  FileReference();
     refUploadFile.browse();
     refUploadFile.addEventListener(Event.SELECT,onFileSelect);
     refUploadFile.addEventListener(Event.COMPLETE,onFileComplete);
  }

  // Called when a file is selected
  private function onFileSelect(event:Event):void {
   UploadFiles.push({  name:refUploadFile.name,
        size:formatFileSize(refUploadFile.size),
        status:"initial"});
   listFiles.dataProvider  = UploadFiles;
   listFiles.selectedIndex = UploadFiles.length - 1;
   
               refUploadFile.load();
               for ( var i:int = 0 ; i <  UploadFiles.length ; i++ ) {
                 if( UploadFiles[i].name == refUploadFile ) {
                  UploadFiles[i].status = "loaded";
       listFiles.dataProvider  = UploadFiles;
                  break;
                 }
               }
  }

  // Called to format number to file size
  private function formatFileSize(numSize:Number):String {
   var strReturn:String;
   numSize = Number(numSize / 1000);
   strReturn = String(numSize.toFixed(1) + " KB");
   if (numSize > 1000) {
    numSize = numSize / 1000;
    strReturn = String(numSize.toFixed(1) + " MB");
    if (numSize > 1000) {
     numSize = numSize / 1000;
     strReturn = String(numSize.toFixed(1) + " GB");
    }
   }   
   return strReturn;
  }

    private function onFileComplete(event:Event):void
    {
      refUploadFile = event.currentTarget as FileReference;
      var data:ByteArray = new ByteArray();
      refUploadFile.data.readBytes(data,0,refUploadFile.data.length);
              
      var token:AsyncToken = AsyncToken(
                                remoteUpload.doUpload(data, refUploadFile.name)
                                );
     
            token.kind = refUploadFile.name;
                        
               for ( var i:int = 0 ; i <  UploadFiles.length ; i++ ) {
                 if( UploadFiles[i].name == refUploadFile ) {
                  UploadFiles[i].status = "upload";
       listFiles.dataProvider  = UploadFiles;
                  break;
                 }
               }
    }

    private function uploadResultHandler(event:ResultEvent):void
    {
               for ( var i:int = 0 ; i <  UploadFiles.length ; i++ ) {
                 if( UploadFiles[i].name == event.token.kind ) {
                  UploadFiles[i].status = "finished";
       listFiles.dataProvider  = UploadFiles;
                  break;
                 }
               }
    }

    private function faultResultHandler(event:FaultEvent):void
    {
               for ( var i:int = 0 ; i <  UploadFiles.length ; i++ ) {
                 if( UploadFiles[i].name == event.token.kind ) {
                  UploadFiles[i].status = "error";
       listFiles.dataProvider  = UploadFiles;
                  break;
                 }
               }
    }

 
 ]]>
</mx:Script>

<mx:RemoteObject id="remoteUpload" destination="FileUtils"
 result="uploadResultHandler(event)"
 fault="faultResultHandler(event)"/>


<mx:Canvas width="100%" height="100%">
 <mx:DataGrid id="listFiles" left="0" top="0" bottom="0" right="0"
  allowMultipleSelection="true" verticalScrollPolicy="on"
  draggableColumns="false" resizableColumns="false" sortableColumns="false">
  <mx:columns>
   <mx:DataGridColumn headerText="File" width="150" dataField="name" wordWrap="true"/>
   <mx:DataGridColumn headerText="Size" width="50" dataField="size" textAlign="right"/>
   <mx:DataGridColumn headerText="Status" width="50" dataField="status" textAlign="right"/>
  </mx:columns>
 </mx:DataGrid>
</mx:Canvas>
<mx:ControlBar horizontalAlign="center" verticalAlign="middle">
 <mx:Button id="btnAdd" toolTip="Add file(s)" click="addFiles()"
  label="Upload Files" width="150"/>
</mx:ControlBar>
</mx:Panel>

The code of the download panel

<?xml version="1.0" encoding="utf-8"?>
<mx:Panel xmlns:mx="http://www.adobe.com/2006/mxml" layout="vertical"
width="100%" height="100%" title="Download Files">

<mx:Script>
 <![CDATA[
  import mx.collections.ArrayCollection;
  import mx.rpc.events.FaultEvent;
  import mx.rpc.events.ResultEvent;
  import mx.rpc.AsyncToken;

  private var UploadFiles:Array = new Array();
  private var UploadFilesColl:ArrayCollection = new ArrayCollection();
  private var fileData:ByteArray = new ByteArray();
  private var fileName:String;

 
    private function uploadResultHandler(event:ResultEvent):void
    {
      if ( event.token.kind == "remoteFileList") {
              UploadFilesColl = event.result as ArrayCollection;
              for ( var i:int = 0 ; i <  UploadFilesColl.length ; i++ ) {
                UploadFiles.push({  name:UploadFilesColl[i]
                                 ,  status:"initial"});
              }
              listFiles.dataProvider = UploadFiles;
             } else  {
                fileData = event.result as ByteArray;
                fileName = event.token.kind;
                for ( var b:int = 0 ; b <  UploadFiles.length ; b++ ) {
                 if( UploadFiles[b].name == event.token.kind ) {
                  UploadFiles[b].status = "Ready";
       listFiles.dataProvider  = UploadFiles;
                  break;
                 }
               }

             }
    }

    private function faultResultHandler(event:FaultEvent):void
    {
    }

    private function saveFile(event:Event):void
    {
      var fileReference:FileReference = new FileReference();
      fileReference.save(fileData,fileName);
    }

    private function getRemoteFiles(event:Event):void
    {
      var token:AsyncToken = AsyncToken(remoteDownload.getDownloadList());
            token.kind = "remoteFileList";
    }

    private function getDownload(event:Event):void
    {
      var token:AsyncToken = AsyncToken(
          remoteDownload.doDownload(listFiles.selectedItem.name));
            token.kind = listFiles.selectedItem.name;
    }
 ]]>
</mx:Script>


<mx:RemoteObject id="remoteDownload" destination="FileUtils"
 result="uploadResultHandler(event)"
 fault="faultResultHandler(event)"/>


<mx:Canvas width="100%" height="100%">
 <mx:DataGrid id="listFiles" left="0" top="0" bottom="0" right="0"
  verticalScrollPolicy="on"
  draggableColumns="false" resizableColumns="false" sortableColumns="false">
  <mx:columns>
   <mx:DataGridColumn headerText="File" width="150" dataField="name" wordWrap="true"/>
   <mx:DataGridColumn headerText="Status" width="50" dataField="status" textAlign="right"/>
  </mx:columns>

 </mx:DataGrid>
</mx:Canvas>
<mx:ControlBar horizontalAlign="center" verticalAlign="middle">
 <mx:Button id="btnList" toolTip="List remote files"
  width="150"
  label="Get Remote Files"
  click="getRemoteFiles(event)"/>
 <mx:Button id="btnRetrieve" toolTip="Retrieve file"
   width="150" click="getDownload(event)" label="Retrieve File"/>
 <mx:Button id="btnSave" toolTip="Save file"
   width="150" click="saveFile(event)" label="Save File"/>
</mx:ControlBar>



</mx:Panel>

The java code

package nl.ordina.flex;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;

import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;

import java.util.ArrayList;
import java.util.List;

public class FileUtils {


   public String  doUpload(byte[] bytes, String fileName) throws Exception
   {
       fileName = System.getProperty("java.io.tmpdir") + "/" + fileName;
       File f = new File(fileName);
       FileOutputStream fos = new FileOutputStream(f);
       fos.write(bytes);
       fos.close();
       return "success";
   }

   public List  getDownloadList()
   {
       File dir = new File(System.getProperty('java.io.tmpdir'));
       String[] children = dir.list();
       List dirList = new ArrayList();
       if (children == null) {
              // Either dir does not exist or is not a directory
          } else {
              for (int i=0; i<children.length; i++) {
                  // Get filename of file or directory
                  dirList.add( children[i]);
              }
          }
       return dirList;
   }

   public byte[] doDownload(String fileName)
   {
       FileInputStream fis;
       byte[] data =null;
       FileChannel fc;

       try {
           fis = new FileInputStream(System.getProperty("java.io.tmpdir") + "/" + fileName);
           fc = fis.getChannel();
           data = new byte[(int)(fc.size())];
           ByteBuffer bb = ByteBuffer.wrap(data);
           fc.read(bb);
       } catch (FileNotFoundException e) {
           // TODO
       } catch (IOException e) {
           // TODO
       }
       return data;
   }
}

Cairngorm Flex MVC is now opensource

Cairngorm is MVC framework which you can use in Adobe Flex or Adobe AIR. In Flex you can put all your code in one mxml but this makes hard to develop and maintain when the project has a particular size. Adobe has developed Cairngorm for it's own projects and it is very positif they released it to the opensource community. Adobe already released BlazeDS, so what's next?
You can download Cairngorm from here.
Here is a cairngorm example application which gives you a nice overview what Cairngorm does. This is a login application. Use admin as username and password.

MVC in Flex

In Flex you can put all your code in one mxml. Off course this works perfectly but is not easy to maintain and all the components are tidely connected. The Model View Controller design pattern can help you to split up the flex application so we have loosely coupled and cleaner components. These components can be easily reused without breaking up the whole application. With MVC design pattern helps you to make a big flex application without having a code nightmare.
Here is an example of a simple mxml application where the label get it's data directly from the list.

<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
 <mx:List id="list"  >
  <mx:dataProvider>
   <mx:Array>
    <mx:Object label="one"/>
    <mx:Object label="two"/>
   </mx:Array>
  </mx:dataProvider>
 </mx:List>
    <mx:Label text="{list.selectedItem.label}"/>
</mx:Application>

Let's change this Flex application in an Model View Controller application. I know this is an overkill for this example but in the large application you will benefit from this approach. Create an new component List1 in the new folder view.

<?xml version="1.0" encoding="utf-8"?>
<mx:List xmlns:mx="http://www.adobe.com/2006/mxml">
  <mx:dataProvider>
  <mx:Array>
   <mx:Object label="one"/>
   <mx:Object label="two"/>
  </mx:Array>
 </mx:dataProvider> 
</mx:List>

Do the same for the Label and name this component Label1. Store Label1 in the view folder.

<?xml version="1.0" encoding="utf-8"?>
<mx:Label xmlns:mx="http://www.adobe.com/2006/mxml">
   <mx:text>empty</mx:text>
</mx:Label>

We can use these components after adding a namespace to the application mxml.

<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
 xmlns:view="view.*">
 <view:List1/>
 <view:Label1/>
</mx:Application>

This time we have the same application but there is no interaction between the components. We can change this by fire an event when the list is changed. This event can be captured by the controller which stores the new list value in the model. Events make these components loosely coupled. The label component can retrieve the new list value from the model or actionscriptcan monitor the list value of the model so when it is changed, it can update a local variable.
Create a new event and fire this event when the list component is changed.
Let's create a new actionsript class ChangeEventClass which extends from Event. Store this class in the event folder. We want to pass the new value of the list to the other classes. So we need to build a custom event.

package event
{
 import flash.events.Event;
 public class ChangeEventClass extends Event {

  public static const name:String = "changeEvName";
  public var newValue:String;
  public function ChangeEventClass( prop:String
                                  , type:String
                                  , bubbles:Boolean=false
                                  , cancelable:Boolean=false){
   newValue = prop;
   super(type, bubbles, cancelable);
  }
 }
}

Now we can change the list component where we use the change property to fire the new event. It is very important to set the bubbles parameter to true else the Controller class can not capture the event. Default only the parent component can listen for this event.

<?xml version="1.0" encoding="utf-8"?>
<mx:List xmlns:mx="http://www.adobe.com/2006/mxml" change="changeList(event);">
 <mx:Script>
  <![CDATA[
     import event.ChangeEventClass;
   
     private function changeList(event:Event):void {
    var eventObj:ChangeEventClass =
    new ChangeEventClass( selectedItem.label
            , ChangeEventClass.name
          , true);
    dispatchEvent(eventObj);
            }
  ]]>
 </mx:Script>

  <mx:dataProvider>
  <mx:Array>
   <mx:Object label="one"/>
   <mx:Object label="two"/>
  </mx:Array>
 </mx:dataProvider> 
</mx:List>

We want to capture this event and store the value in the model. Let's create the model first. The model has to be a singleton class so an other component can retrieve this value. Create a new actionscript class Global and put this class in the model folder. The listValue has to be bindable else we can not retrieve this value from the label component.

package model
{
 public class Global
 {
  public function Global(){
       if( instance != null ){
         throw( new Error( "there can be only one instance of global" ) );
         }
        }
      
        private static var instance:Global;

        [Bindable]
        public var listValue:String;

       public static function getInstance():Global{
         if( instance == null ){
          instance = new Global();
         }
         return instance;
       }
   }
}

The next step is to create a Controller class and put this class in the controller folder. In this class we will capture the list change event and store the new value in the model variable.

package controller
{
 import event.ChangeEventClass;
 import flash.events.Event;
 import model.Global;
 import mx.core.UIComponent;
 import mx.events.FlexEvent;
  
 public class Controller extends UIComponent{
   public function Controller() {
                   addEventListener( FlexEvent.CREATION_COMPLETE, setupEventListeners );
                  }
                  private function setupEventListeners( event:Event ):void {
      systemManager.addEventListener(ChangeEventClass.name,changeEvNameHandler);
                  }
   private function changeEvNameHandler(listEvent:ChangeEventClass):void {
                       Global.getInstance().listValue = listEvent.newValue;
   } 
 }
}

The application mxml will now look like this. We can import the Controller class to this mxml.

<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
 xmlns:view="view.*"
 xmlns:controller="controller.*">
 <controller:Controller/>
 <view:List1/>
 <view:Label1/>
</mx:Application>

We only have to change the label component so its retrieve its text value from the model class.

<?xml version="1.0" encoding="utf-8"?>
<mx:Label xmlns:mx="http://www.adobe.com/2006/mxml">
  <mx:Script>
   <![CDATA[
        import model.Global;
   ]]>
  </mx:Script>

  <mx:text>{Global.getInstance().listValue}</mx:text>
</mx:Label>

Or we can listen when the listValue changes in the model class.

<?xml version="1.0" encoding="utf-8"?>
<mx:Label xmlns:mx="http://www.adobe.com/2006/mxml">
  <mx:Script>
   <![CDATA[
     import model.Global;
     import mx.events.PropertyChangeEvent;
        import mx.binding.utils.ChangeWatcher;

        private var stateWatcher:ChangeWatcher = ChangeWatcher.watch( Global.getInstance()
                                                                    , "listValue"
                                                                    , handle_stateChange );
        private function handle_stateChange( event:PropertyChangeEvent ):void {
           text = Global.getInstance().listValue;
        }
   ]]>
  </mx:Script>
</mx:Label>

Now we have a MVC flex application.