Class ConnectionConfig


  • public final class ConnectionConfig
    extends Object
    Connection configuration used to connect to LiveView server.
    • Constructor Detail

      • ConnectionConfig

        public ConnectionConfig()
    • Method Detail

      • getConnectionMonitor

        public ProgressMonitor getConnectionMonitor()
        The api uses this method to retrieve the progress monitor specified by the user.
        Returns:
        the monitor
      • setConnectionMonitor

        public ConnectionConfig setConnectionMonitor​(ProgressMonitor monitor)
        Sets the monitor to use by the api
        Parameters:
        monitor - the monitor to set
      • getDisplayUri

        public URI getDisplayUri()
        Get the display uri
        Returns:
        the sanitized uri
        Throws:
        LiveViewException
      • getUsername

        public String getUsername()
        Get the username to connect with
        Returns:
        the username
      • getPassword

        public String getPassword()
        Get the password to connect with
        Returns:
        the password
      • setCompress

        public ConnectionConfig setCompress​(boolean compress)
        Enable or disable compression on this connection
        Parameters:
        compress - true to enable compression or false otherwise
        Since:
        7.5
      • isCompress

        public boolean isCompress()
        Get the compression state of this connection
        Returns:
        true if traffic on this connection is being compressed and false otherwise
        Since:
        7.5
      • setCapabilities

        public ConnectionConfig setCapabilities​(EnumSet<LiveViewClientCapability> capabilities)
        Set the ClientCapabilities that are supported by this client. The default is that you support all the ones that exist in the version of the Java API that you're using. However, if there are capabilities that exist but you don't want to support them, specify it here.
        Parameters:
        capabilities -
        Since:
        LiveView 1.6.1
      • getListener

        public ConnectionListener getListener()
        Get the connection listener
        Returns:
        the listener