home *** CD-ROM | disk | FTP | other *** search
/ Thomson (Residential) / TGSTPv7203.iso / mac / HIW / xml / mod_devicefinder.xml < prev    next >
Extensible Markup Language  |  2008-02-11  |  8KB  |  155 lines
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE fsm SYSTEM "fsm.dtd">
  3. <!-- 
  4.     Devicefinder module. Shows a progress page and searches for devices.
  5.     If more than one device is found, the select device page is shown.
  6.     Authentication of the device is handled.
  7.     The found devices are associated with their respective adaptormanager,
  8.     if not connected through ethernet.
  9.  
  10.     Input properties:
  11.     - timeout: time in seconds to look for devices. Default 5.
  12.   - serialFilter: Regexp to filter search on serial number. Default '*'
  13.   - nameFilter: Regexp to filter search on device name. Default '*'
  14.   - interfaceFilter: Interface object to limit search to. Default none.
  15.   - adaptorManagerList: List of loaded adaptormanagers. Default empty.
  16.   - authenticationMode: [user|isp] Method of device authentication. (required)
  17.        'user': The user will be prompted for a password if the device is
  18.                       password protected.
  19.        'isp' : The given username and password are used for authentication,
  20.                no user interaction will occur.
  21.   - systemUserid: Username for isp authentication.
  22.   - systemPassword: Password for isp authentication.
  23.   
  24.     Output properties:
  25.   - device: The device that was found/selected, fully authenticated. Only
  26.       valid on exit 'foundDevice'.
  27.       
  28.   Exit events:
  29.   - foundDevice: A device was found and authenticated.
  30.   - foundNoDevices: No devices that matched the filters were found.
  31.   - authenticationFailed: The found device could not be authenticated.
  32.  
  33.   Modules referred:
  34.   - mod_selectdevice.xml
  35.   - mod_devicefinder_nogui.xml
  36.  
  37. -->
  38.  
  39. <fsm>
  40.   <property key="authenticationMode" required="yes"/>
  41.   <property key="systemUserid" required="yes" />
  42.   <property key="systemPassword" required="yes" />
  43.     <states>
  44.         <state type="pageFsm" name="searchDevices">
  45.           <!-- This module accepts the following input properties -->
  46.           <property key="authenticationMode" required="yes"/>
  47.           <property key="autoContinue" value="yes"/>
  48.           <property key="autoContinueTime" value="0"/>
  49.             <property key="systemUserid" required="yes" />
  50.             <property key="systemPassword" required="yes" />
  51.           <!-- states -->
  52.           <states>
  53.             <!-- shows the page -->
  54.             <state type="showMoviePage" name="showPageSearchDevices">
  55.                 <property key="registerPage" value="1"/>
  56.                 <property key="sweep" value="1"/>
  57.                 <property key="title" value="tr(Device Check)"/>
  58.                 <property key="subTitle" value="tr(Please wait, the wizard is checking your Thomson Gateway.)"/>
  59.                 <property key="info" value="tr(Checking your Thomson Gateway)"/>
  60.                 <property key="extraInfo" value="tr(Please wait, this can take a few minutes.)"/>
  61.                 <property key="movieFile" value="Images/devicecheck.mng"/>
  62.             </state>
  63.         <!-- does the actual work -->
  64.         <state file="mod_devicefinder_nogui.xml" name="devicefinder" weight="20"/>
  65.             <!-- authenticate with user provided username/password -->
  66.             <state type="deviceAuthHandler" name="deviceAuthHandler"/>
  67.           </states>
  68.           <!-- This module has the following output events -->
  69.           <events>
  70.             <event name="foundMultipleDevices"/>
  71.             <event name="foundNoDevices"/>
  72.             <event name="foundDevice"/>
  73.             <event name="authenticationFailed"/>
  74.           </events>
  75.           <!-- transitions -->
  76.           <transitions>
  77.             <transition startstate="showPageSearchDevices"/>
  78.         <!-- go to search -->
  79.         <transition fromstate="showPageSearchDevices" tostate="devicefinder" event="continue">
  80.           <propertymap target="timeout" function="$fsm.timeout"/>
  81.               <propertymap target="nameFilter" function="$fsm.nameFilter"/>
  82.               <propertymap target="serialFilter" function="$fsm.serialFilter"/>
  83.               <propertymap target="adaptorManagerList" function="$fsm.adaptorManagerList"/>
  84.           <propertymap target="interfaceFilter" function="$fsm.interfaceFilter"/>
  85.           <propertymap target="systemUserid" function="$fsm.systemUserid"/>
  86.           <propertymap target="systemPassword" function="$fsm.systemPassword"/>
  87.         </transition>
  88.         <!-- single device found, and authenticated, exit -->
  89.         <transition fromstate="devicefinder" toexit="foundDevice" event="foundDevice">
  90.           <!-- output --><propertymap target="fsm.device" function="$device"/>
  91.           <!-- output --><propertymap target="fsm.deviceList" function="$deviceList"/>
  92.         </transition>
  93.         <!-- multiple devices found, exit -->
  94.         <transition fromstate="devicefinder" toexit="foundMultipleDevices" event="foundMultipleDevices">
  95.           <!-- output --><propertymap target="fsm.deviceList" function="$deviceList"/>
  96.         </transition>
  97.         <!-- no devices found, exit -->
  98.         <transition fromstate="devicefinder" toexit="foundNoDevices" event="foundNoDevices"/>
  99.  
  100.         <!-- single found, but not authenticated, authenticate with user provided username/password -->
  101.         <transition fromstate="devicefinder" tostate="deviceAuthHandler" event="authenticationFailed">
  102.           <!-- output --><propertymap target="fsm.deviceList" function="$deviceList"/>
  103.           <!-- output --><propertymap target="fsm.device" function="$device"/>
  104.           <propertymap target="device" function="$device"/>
  105.           <propertymap target="authenticationMode" function="$fsm.authenticationMode"/>
  106.           <propertymap target="systemUserid" function="$fsm.systemUserid"/>
  107.           <propertymap target="systemPassword" function="$fsm.systemPassword"/>
  108.         </transition>
  109.         <!-- authentication succeeded, exit-->
  110.         <transition fromstate="deviceAuthHandler" toexit="foundDevice" event="authenticated">
  111.           <!-- output --><propertymap target="fsm.device" function="$device"/>
  112.         </transition>
  113.         
  114.         <!-- authentication failed or canceled by user-->
  115.             <transition fromstate="deviceAuthHandler" toexit="authenticationFailed" event="authenticationFailed|canceled"/>
  116.           </transitions>
  117.         </state><!-- searchDevices -->
  118.  
  119.     <!-- in case of multiple found devices, show page to select -->
  120.     <state file="mod_selectdevice.xml" name="pageSelectDevice"/>
  121.     </states>
  122.   <events>
  123.     <event name="foundNoDevices"/>
  124.     <event name="foundDevice"/>
  125.     <event name="authenticationFailed"/>
  126.   </events>
  127.   <!-- transitions -->
  128.   <transitions>
  129.     <transition startstate="searchDevices">
  130.       <propertymap target="authenticationMode" function="$fsm.authenticationMode"/>
  131.       <propertymap target="systemUserid" function="$fsm.systemUserid"/>
  132.       <propertymap target="systemPassword" function="$fsm.systemPassword"/>
  133.       <propertymap target="timeout" function="$fsm.timeout"/>
  134.       <propertymap target="nameFilter" function="$fsm.nameFilter"/>
  135.       <propertymap target="serialFilter" function="$fsm.serialFilter"/>
  136.       <propertymap target="adaptorManagerList" function="$fsm.adaptorManagerList"/>
  137.     </transition>
  138.     <transition fromstate="searchDevices" toexit="foundDevice" event="foundDevice">
  139.       <!-- output --><propertymap target="fsm.device" function="$device"/>
  140.     </transition>
  141.     <transition fromstate="searchDevices" toexit="foundNoDevices" event="foundNoDevices"/>
  142.     <transition fromstate="searchDevices" toexit="authenticationFailed" event="authenticationFailed"/>
  143.     <!-- select a device -->
  144.     <transition fromstate="searchDevices" tostate="pageSelectDevice" event="foundMultipleDevices">
  145.       <propertymap target="deviceList" function="$deviceList"/>
  146.       <propertymap target="authenticationMode" function="$fsm.authenticationMode"/>
  147.       <propertymap target="systemUserid" function="$fsm.systemUserid"/>
  148.       <propertymap target="systemPassword" function="$fsm.systemPassword"/>
  149.     </transition>
  150.     <transition fromstate="pageSelectDevice" toexit="foundDevice" event="finished">
  151.       <!-- output --><propertymap target="fsm.device" function="$selectedDevice"/>
  152.     </transition>
  153.     <transition fromstate="pageSelectDevice" toexit="authenticationFailed" event="authenticationFailed"/>
  154.     </transitions>
  155. </fsm>