Home
Categories
Dictionary
Download
Project Details
Changes Log
Who We Are
FAQ
License

Embed Client



The Embed Client integrates a Client and a Server in the same application, and specifies the behavior of the Client User Application through an XML file. The UA - CDS communication is configured using an XML file specifying both the widgets and Layers properties which will be set (or received) by the Client. This XML file can conform to two different schemas:

Starting the Embed Client

The embedClient.jar jar file has a main class with a static main method allowing to start the Embedded Client, with optionally a Server. Starting the Embedded Client is very similar to start the Client or the Server:
  • If started with the "-config=<configuration file>" argument, the Embedded Client will use the associated configuration file
  • If started without the "-config" argument, the Embedded Client will ask for a configuration file
The configuration file is the same as the one used for the Client and the Server launcher. The properties of this file will be used by the associated Client and the optional Server. Some properties are specific to the Embedded Client itself.

For example:
      java -jar embedClient.jar -config=<configuration File>
With <configuration File> being the properties File defining the configuration (used by the Embedded Client itself, the associated Client, and the optional Server).

Configuration properties

The Embed Client applicaztion has several specific configuration properties:
  • embed.providerClass: uses the built-in default Data provider class
  • embed.hasServer: will start an associated Server with the Embedded Client
  • embed.providerConfs: the XML file specifying the provider configuration
  • embed.XMLFormat: specifies that the format for the XML file specifying the provider configuration is the ARINC 661 UACDS Interface format
  • embed.ui: specifies the UI framework to use to start the Server. By default the Swing framework will be used, and this property can have the following values:
    • "javafx" for the JavaFX framework
    • "swing" for the Swing framework

Example

Example of a configuration properties file:
      graphics=DefGraphics.xml
      ui=LookAndFeel.xml
      pictures=DefPictures.xml
      lf=javaFX
      supplement=4
      serverInputPort=8080
      serverOutputPort=8081
      serverInputSize=50000
      serverOutputSize=200
      server.autoVisible=true
      windowManager=windows
      server.windows=../sampleFiles/simpleWindow.xml
      logServerArea=true
      server.computeLayerSize=true
      embed.providerClass=default
      embed.hasServer=true
      embed.providerConfs=uacdsBareProviderConfig.xml
      embed.XMLFormat=uacds
      embed.ui=javafx

See also


Categories: client | user

Copyright 2016-2017 Dassault Aviation. All Rights Reserved. Documentation and source under the LGPL v2 licence