Package eu.ill.webx

Class WebXClientConfiguration

java.lang.Object
eu.ill.webx.WebXClientConfiguration
public class WebXClientConfiguration extends Object
Provides client connection configuration. Used for requesting a new session (login) or connection to a running one (sessionId) Standalone session passes directly to a standalone WebX Engine

  • Method Details

    • ForLogin

      public static WebXClientConfiguration ForLogin(String username, String password, Integer screenWidth, Integer screenHeight, String keyboardLayout)
      Returns a configuration containing login details, screen size and keyboard layout. This will result in a new session being created by the WebX Router (if there isn't one already running for the user).
      Parameters:
      username - The username
      password - The password
      screenWidth - Desired screen width for a new X11 session
      screenHeight - Desired screen height for a new X11 session
      keyboardLayout - The requested keyboard layout
      Returns:
      The WebXClientConfiguration

    • ForLogin

      public static WebXClientConfiguration ForLogin(String username, String password, Integer screenWidth, Integer screenHeight)
      Returns a configuration containing login details, screen size. Keyboard layout is fixed at "gb". This will result in a new session being created by the WebX Router (if there isn't one already running for the user).
      Parameters:
      username - The username
      password - The password
      screenWidth - Desired screen width for a new X11 session
      screenHeight - Desired screen height for a new X11 session
      Returns:
      The WebXClientConfiguration

    • ForLogin

      public static WebXClientConfiguration ForLogin(String username, String password)
      Returns a configuration containing login details default screen size (1920x1024) and keyboard layout ("gb") are used. This will result in a new session being created by the WebX Router (if there isn't one already running for the user).
      Parameters:
      username - The username
      password - The password
      Returns:
      The WebXClientConfiguration

    • ForExistingSession

      public static WebXClientConfiguration ForExistingSession(String sessionId)
      Returns a configuration containing a sessionId. The WebX Router will attempt to connect to an existing session with an identical Id.
      Parameters:
      sessionId - Session Id of a running session.
      Returns:
      The WebXClientConfiguration

    • ForStandaloneSession

      public static WebXClientConfiguration ForStandaloneSession()
      Returns a configuration for a standalone session.
      Returns:
      The WebXClientConfiguration

    • getUsername

      public String getUsername()
      Returns the username
      Returns:
      The username

    • getPassword

      public String getPassword()
      Returns the password
      Returns:
      The password

    • getScreenWidth

      public Integer getScreenWidth()
      Returns the screen width
      Returns:
      The screen width

    • getScreenHeight

      public Integer getScreenHeight()
      Returns the screen height
      Returns:
      The screen height

    • getKeyboardLayout

      public String getKeyboardLayout()
      Returns the keyboard layout
      Returns:
      The keyboard layout

    • getSessionId

      public String getSessionId()
      Returns the session Id
      Returns:
      The session Id