Package org.apache.guacamole.protocol

Class GuacamoleClientInformation

  • public class GuacamoleClientInformation
extends Object
    An abstract representation of Guacamole client information, including all information required by the Guacamole protocol during the preamble.

    • Constructor Detail

      • GuacamoleClientInformation

        public GuacamoleClientInformation()

    • Method Detail

      • getOptimalScreenWidth

        public int getOptimalScreenWidth()
        Returns the optimal screen width requested by the client, in pixels.
        Returns:
        The optimal screen width requested by the client, in pixels.

      • setOptimalScreenWidth

        public void setOptimalScreenWidth​(int optimalScreenWidth)
        Sets the client's optimal screen width.
        Parameters:
        optimalScreenWidth - The optimal screen width of the client.

      • getOptimalScreenHeight

        public int getOptimalScreenHeight()
        Returns the optimal screen height requested by the client, in pixels.
        Returns:
        The optimal screen height requested by the client, in pixels.

      • setOptimalScreenHeight

        public void setOptimalScreenHeight​(int optimalScreenHeight)
        Sets the client's optimal screen height.
        Parameters:
        optimalScreenHeight - The optimal screen height of the client.

      • getOptimalResolution

        public int getOptimalResolution()
        Returns the resolution of the screen if the optimal width and height are used, in DPI.
        Returns:
        The optimal screen resolution.

      • setOptimalResolution

        public void setOptimalResolution​(int optimalResolution)
        Sets the resolution of the screen if the optimal width and height are used, in DPI.
        Parameters:
        optimalResolution - The optimal screen resolution in DPI.

      • getAudioMimetypes

        public List<String> getAudioMimetypes()
        Returns the list of audio mimetypes supported by the client. To add or removed supported mimetypes, the list returned by this function can be modified.
        Returns:
        The set of audio mimetypes supported by the client.

      • getVideoMimetypes

        public List<String> getVideoMimetypes()
        Returns the list of video mimetypes supported by the client. To add or removed supported mimetypes, the list returned by this function can be modified.
        Returns:
        The set of video mimetypes supported by the client.

      • getImageMimetypes

        public List<String> getImageMimetypes()
        Returns the list of image mimetypes supported by the client. To add or removed supported mimetypes, the list returned by this function can be modified.
        Returns:
        The set of image mimetypes supported by the client.

      • getName

        public String getName()
        Returns the name of the Guacamole user as reported by the client, or null if the user name is not set.
        Returns:
        A string value of the human-readable name reported by the client.

      • getTimezone

        public String getTimezone()
        Return the timezone as reported by the client, or null if the timezone is not set. Valid timezones are specified in IANA zone key format, also known as Olson time zone database or TZ Database.
        Returns:
        A string value of the timezone reported by the client.

      • setName

        public void setName​(String name)
        Set the human-readable name of the user associated with this client.
        Parameters:
        name - The human-readable name of the user associated with this client.

      • setTimezone

        public void setTimezone​(String timezone)
        Set the string value of the timezone, or null if the timezone will not be provided by the client. Valid timezones are specified in IANA zone key format (aka Olson time zone database or tz database).
        Parameters:
        timezone - The string value of the timezone reported by the client, in tz database format, or null if the timezone is not provided by the client.