An application server sends his status at startup, when it stops or when an important error occured. That's the way the system can know when an offline server is online again or when a server needs to be registered.

Application Servers send periodically their system information so the status of each server is known. This is used for the session load balancing for instance.

The monitoring contains the CPU and RAM load. But also running applications for each sessions.

Application Servers send a request when a user want create invite someone.

Application Servers send, for each session, their status each time it changes.

When a user is launching a session, he is redirected with a token to an Application Server. To verify the user identity and get the session information, the Application Server sending this token to to the Session Manager. If it's valid, it gets information as XML content.

Used for Windows applications

Gets the icon for an application so it can display it on the user desktop. The application server uses a cache system so an application icon is only asked once by a server.

Used for Virtual and Windows applications

Gets the application information from the id argument to create the application shortcut on the user's desktop.

The Session Manager asks for the server status periodically to update its status, and detect down or broken states.

The Session Manager asks for each session status periodically to detect servers/sessions craches.

Session Manager asks for the server monitoring when it detects too old cache information.

Gets installed applications on the system.

Force a specific session to exit without notifying the user.

Get the server version. On Windows, gets the Windows long version. On Linux, get the content of /etc/issue.

Gets the server type.

Extracts the icon associated with an application.

Used to install/remove applications.

Gets job id from action request.

the server provides some informations about the session. The used content type is XML. Here is the XML used format:

The root node is called session and contains 3 attributes:

The root node also contains a child node called aps which have 4 attributes:

Here is an example:

<?xml version="1.0" encoding="utf-8"?>
<session mode="desktop" shareable="true" persistent="false">
  <aps protocol="http" server="aps.ulteo.com" port="80" location="/applicationserver" />
</session>
          

Thanks to the previous informations, it's possible to build the base url to call the other webservices like that: protocol://server:portlocation.

When whatsup.php give a session ready, the client has to call this one to get all the access to join the session: SSH port/login/password, VNC port/password ...

XML format:

Here is an example:

<?xml version="1.0" encoding="utf-8"?>
<session>
  <parameters width="1674" height="920" share_desktop="true" view_only="No"/>
  <ssh host="aps.ulteo.com" user="SSH3" passwd="3064396264626635">
    <port>443</port>
    <port>993</port>
    <port>995</port>
  </ssh>
  <vnc port="5901" passwd="43bc4beb567bdaec">
    <quality compression_level="1" restricted_colors="no" jpeg_image_quality="9" encoding="Tight"/>
  </vnc>
</session>
          

The webservice provide the list of available applications for the current session.

The XML root node is applications and only contains child nodes called application.

An application node only contains attributes:

Here is an example:

<?xml version="1.0" encoding="utf-8"?>
<applications>
  <application id="8" name="Firefox Web Browser"/>
  <application id="9" name="GIMP Image Editor"/>
</applications>
          

This webservice can be called when users close the session window to force the session to exit instead of waiting the timeout trigger.

This is useful on session sharing for instance to be sure that when the client exits, all users sharing the session cannot still access it.

invite.php is called when the session owner wants to invite someone. The Application Server ask to the Session Manager to create the invitation and send the email.

The passive mode is a view of the session where you cannot move the mouse cursor or type keys on your keyboard. It's a view only mode.

This webserice is the way to transport the print jobs from the session to the client.

On ApS servers, there is a PDF printer that spools files in the session directory. When there is a new file, whatsup.php detects it, extracts the timestamp and alerts the client. Then the client has just to request a print with the timestamp to get the print job and use a mean to print localy (printing applet).

This webservice is called when whatsup returned 0 as session status. Startsession sets the session status to 1.

The XML root node is error the request didn't work.

If the command succeed, the XML root node is access and contains one attribute id that is the application instance.

This webservice can take some time to answer (maximum 20 seconds)

Here is an example:

<?xml version="1.0" encoding="utf-8"?>
<access id="gkFwi"/>
          

This webservice is called to order a suspend of the current session.

This is available only if the session is persistent.

The webservice has several uses. First of all, it's used to know that the user is still connected (a kind of ping timeout process). Secondly, it allows the client to know session status changes. Finally, it is used to know when a new pdf file is ready for download and print.

The client calls this webservice every 10 seconds top.

XML format:

Here is an example:

<?xml version="1.0" encoding="utf-8"?>
<session status="2">
	<applications>
		<running job="gKjKg" app_id="15" status="2"/>
		<running job="trV5v" app_id="9" status="2"/>
	</applications>
	<sharing count="1">
		<share email="someone@ulteo.com" mode="passive" joined="1" alive="1"/>
	</sharing>
</session>