Package com.facilita.fc.eggPlant

Class ConnectionProperties

    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectionProperties()
      Instantiates a new ConnectionProperties object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMetaTag​(java.lang.String key, java.lang.String value)
      Add a user-defined tag associated with devices as recorded in eggCloud.
      void addParameter​(java.lang.String key, java.lang.String value)
      Add an additional parameter to add to the Connect command.
      java.lang.String[] getAdditionalArgs()
      Get an array of additional arguments to send.
      int getColorDepth()
      Get the color depth of the SUT in the Viewer window: 8, 16, 32.
      ConnectionType getConnectionType()
      Get the connection method to use to connect to the SUT.
      int getHeight()
      For RDP connection types only, specifies the height of the Viewer window in pixels.
      java.lang.String getManufacturer()
      Get the manufacturer of the device as recorded in eggCloud; e.g., Apple.
      java.util.Set<java.lang.String> getMetaTags()
      Get the user-defined meta tags that have been added.
      java.lang.String getMetaTagValue​(java.lang.String key)
      Get the value of a user-defined meta tag.
      java.lang.String getModel()
      Get the model of the device as recorded in eggCloud; e.g., iPhone.
      java.lang.String getName()
      Get the hostname, IP address, or Connection List Display Name.
      java.lang.String getOS()
      Get the operating system of the device as recorded in eggCloud; e.g., iOS.
      java.lang.String getOSVersion()
      Get the operating system version as recorded in eggCloud; e.g., 6.0.2.
      java.util.Set<java.lang.String> getParameters()
      Get the additional parameters that have been added.
      java.lang.String getParameterValue​(java.lang.String key)
      Get the value of the specified parameter.
      java.lang.String getPasscode()
      Get the encrypted password.
      java.lang.String getPassword()
      Get the password for the VNC server if you're making a VNC connection, or the Windows user password if you're making an RDP connection.
      int getPort()
      Get the port number used by the server on the SUT.
      int getRetryTimeout()  
      java.lang.String getSshHost()
      Get the hostname or IP address of a computer hosting an SSH connection.
      java.lang.String getSshPassword()
      Get the password to the user account on the SSH server.
      java.lang.String getSshUser()
      Get the user account on the SSH host
      java.lang.String getUsername()
      Get the Windows username when connecting via RDP.
      int getWidth()
      For RDP connection types only, specifies the width of the Viewer window in pixels.
      boolean retryOnFailure()  
      void setAdditionalArgs​(java.lang.String[] _additionalArgs)
      Set an array of additional arguments to send
      void setColorDepth​(int _colorDepth)
      Set the color depth of the SUT in the Viewer window: 8, 16, 32.
      void setConnectionType​(ConnectionType _type)
      Set the connection method to use to connect to the SUT.
      void setHeight​(int _height)
      For RDP connection types only, specifies the height of the Viewer window in pixels.
      void setManufacturer​(java.lang.String _manufacturer)
      Set the manufacturer of the device as recorded in eggCloud; e.g., Apple.
      void setModel​(java.lang.String _model)
      Set the model of the device as recorded in eggCloud; e.g., iPhone.
      void setName​(java.lang.String name)
      Set the hostname, IP address, or Connection List Display Name.
      void setOS​(java.lang.String _os)
      Set the operating system of the device as recorded in eggCloud; e.g., iOS.
      void setOSVersion​(java.lang.String _osVersion)
      Set the operating system version as recorded in eggCloud; e.g., 6.0.2.
      void setPasscode​(java.lang.String _passcode)
      Set the encrypted password.
      void setPassword​(java.lang.String _password)
      Set the password for the VNC server if you're making a VNC connection, or the Windows user password if you're making an RDP connection.
      void setPort​(int _port)
      Set the port number used by the server on the SUT.
      void setRetryOnFailure​(boolean _retryOnFailure)  
      void setRetryTimeout​(int _retryTimeout)  
      void setSshHost​(java.lang.String _sshHost)
      Set the hostname or IP address of a computer hosting an SSH connection.
      void setSshPassword​(java.lang.String _sshPassword)
      Set the password to the user account on the SSH server.
      void setSshUser​(java.lang.String _sshUser)
      Set the user account on the SSH host
      void setUsername​(java.lang.String _username)
      Set the Windows username when connecting via RDP.
      void setWidth​(int _width)
      For RDP connection types only, specifies the width of the Viewer window in pixels.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ConnectionProperties

        public ConnectionProperties()
        Instantiates a new ConnectionProperties object.

    • Method Detail

      • getName

        public java.lang.String getName()
        Get the hostname, IP address, or Connection List Display Name.
        Returns:
        The hostname, IP address, or Connection List Display Name.
        See Also:
        setName(String)

      • retryOnFailure

        public boolean retryOnFailure()

      • setRetryOnFailure

        public void setRetryOnFailure​(boolean _retryOnFailure)

      • getRetryTimeout

        public int getRetryTimeout()

      • setRetryTimeout

        public void setRetryTimeout​(int _retryTimeout)

      • setName

        public void setName​(java.lang.String name)
        Set the hostname, IP address, or Connection List Display Name.
        Parameters:
        name - The hostname, IP address, or Connection List Display Name.
        See Also:
        getName()

      • getPort

        public int getPort()
        Get the port number used by the server on the SUT. (Default value: 5900.)
        Returns:
        The port number used by the server on the SUT. (Default value: 5900.)
        See Also:
        setPort(int)

      • setPort

        public void setPort​(int _port)
        Set the port number used by the server on the SUT. (Default value: 5900.)
        Parameters:
        _port - The port number used by the server on the SUT. (Default value: 5900.)
        See Also:
        getPort()

      • getUsername

        public java.lang.String getUsername()
        Get the Windows username when connecting via RDP.
        Returns:
        The Windows username when connecting via RDP.
        See Also:
        setUsername(String)

      • setUsername

        public void setUsername​(java.lang.String _username)
        Set the Windows username when connecting via RDP.
        Parameters:
        _username - The Windows username when connecting via RDP.
        See Also:
        getUsername()

      • getPassword

        public java.lang.String getPassword()
        Get the password for the VNC server if you're making a VNC connection, or the Windows user password if you're making an RDP connection. (Default value: None. Note, however, that RDP connections require a password.)
        Returns:
        The password for the VNC server if you're making a VNC connection, or the Windows user password if you're making an RDP connection. (Default value: None. Note, however, that RDP connections require a password.)
        See Also:
        setPassword(String)

      • setPassword

        public void setPassword​(java.lang.String _password)
        Set the password for the VNC server if you're making a VNC connection, or the Windows user password if you're making an RDP connection. (Default value: None. Note, however, that RDP connections require a password.)
        Parameters:
        _password - The password for the VNC server if you're making a VNC connection, or the Windows user password if you're making an RDP connection. (Default value: None. Note, however, that RDP connections require a password.)
        See Also:
        getPassword()

      • getSshHost

        public java.lang.String getSshHost()
        Get the hostname or IP address of a computer hosting an SSH connection.
        Returns:
        The hostname or IP address of a computer hosting an SSH connection.
        See Also:
        setSshHost(String)

      • setSshHost

        public void setSshHost​(java.lang.String _sshHost)
        Set the hostname or IP address of a computer hosting an SSH connection.
        Parameters:
        _sshHost - The hostname or IP address of a computer hosting an SSH connection.
        See Also:
        getSshHost()

      • getSshUser

        public java.lang.String getSshUser()
        Get the user account on the SSH host
        Returns:
        The user account on the SSH host
        See Also:
        setSshUser(String)

      • setSshUser

        public void setSshUser​(java.lang.String _sshUser)
        Set the user account on the SSH host
        Parameters:
        _sshUser - The user account on the SSH host
        See Also:
        getSshUser()

      • getSshPassword

        public java.lang.String getSshPassword()
        Get the password to the user account on the SSH server.
        Returns:
        The password to the user account on the SSH server.
        See Also:
        setSshPassword(String)

      • setSshPassword

        public void setSshPassword​(java.lang.String _sshPassword)
        Set the password to the user account on the SSH server.
        Parameters:
        _sshPassword - The password to the user account on the SSH server.
        See Also:
        getSshPassword()

      • getColorDepth

        public int getColorDepth()
        Get the color depth of the SUT in the Viewer window: 8, 16, 32. (Default value: The native color depth of the SUT.)
        Returns:
        The color depth of the SUT in the Viewer window: 8, 16, 32. (Default value: The native color depth of the SUT.)
        See Also:
        setColorDepth(int)

      • setColorDepth

        public void setColorDepth​(int _colorDepth)
        Set the color depth of the SUT in the Viewer window: 8, 16, 32. (Default value: The native color depth of the SUT.)
        Parameters:
        _colorDepth - The color depth of the SUT in the Viewer window: 8, 16, 32. (Default value: The native color depth of the SUT.)
        See Also:
        getColorDepth()

      • getConnectionType

        public ConnectionType getConnectionType()
        Get the connection method to use to connect to the SUT. RDP connects on port 3389 by default. (Default value: VNC.)
        Returns:
        The connection method to use to connect to the SUT. RDP connects on port 3389 by default. (Default value: VNC.)
        See Also:
        setConnectionType(ConnectionType)

      • setConnectionType

        public void setConnectionType​(ConnectionType _type)
        Set the connection method to use to connect to the SUT. RDP connects on port 3389 by default. (Default value: VNC.)
        Parameters:
        _type - The connection method to use to connect to the SUT. RDP connects on port 3389 by default. (Default value: VNC.)
        See Also:
        getConnectionType()

      • getHeight

        public int getHeight()
        For RDP connection types only, specifies the height of the Viewer window in pixels. (Default value: 768.)
        Returns:
        For RDP connection types only, specifies the height of the Viewer window in pixels. (Default value: 768.)
        See Also:
        setHeight(int)

      • setHeight

        public void setHeight​(int _height)
        For RDP connection types only, specifies the height of the Viewer window in pixels. (Default value: 768.)
        Parameters:
        _height - For RDP connection types only, specifies the height of the Viewer window in pixels. (Default value: 768.)
        See Also:
        getHeight()

      • getWidth

        public int getWidth()
        For RDP connection types only, specifies the width of the Viewer window in pixels. (Default value: 1024.)
        Returns:
        For RDP connection types only, specifies the width of the Viewer window in pixels. (Default value: 1024.)
        See Also:
        setWidth(int)

      • setWidth

        public void setWidth​(int _width)
        For RDP connection types only, specifies the width of the Viewer window in pixels. (Default value: 1024.)
        Parameters:
        _width - For RDP connection types only, specifies the width of the Viewer window in pixels. (Default value: 1024.)
        See Also:
        getWidth()

      • getAdditionalArgs

        public java.lang.String[] getAdditionalArgs()
        Get an array of additional arguments to send.
        Returns:
        an array of additional arguments to send.
        See Also:
        setAdditionalArgs(String[])

      • setAdditionalArgs

        public void setAdditionalArgs​(java.lang.String[] _additionalArgs)
        Set an array of additional arguments to send
        Parameters:
        _additionalArgs - an array of additional arguments to send
        See Also:
        getAdditionalArgs()

      • getPasscode

        public java.lang.String getPasscode()
        Get the encrypted password. Use this if you want to avoid putting plaintext passwords into your scripts.
        Returns:
        the encrypted password
        See Also:
        setPasscode(String), getPassword()

      • setPasscode

        public void setPasscode​(java.lang.String _passcode)
        Set the encrypted password. Use this if you want to avoid putting plaintext passwords into your scripts.
        Parameters:
        _passcode - the encrypted password
        See Also:
        getPasscode(), setPassword(String)

      • getManufacturer

        public java.lang.String getManufacturer()
        Get the manufacturer of the device as recorded in eggCloud; e.g., Apple.
        Returns:
        The manufacturer of the device as recorded in eggCloud; e.g., Apple.
        See Also:
        setManufacturer(String)

      • setManufacturer

        public void setManufacturer​(java.lang.String _manufacturer)
        Set the manufacturer of the device as recorded in eggCloud; e.g., Apple.
        Parameters:
        _manufacturer - The manufacturer of the device as recorded in eggCloud; e.g., Apple.
        See Also:
        getManufacturer()

      • getModel

        public java.lang.String getModel()
        Get the model of the device as recorded in eggCloud; e.g., iPhone.
        Returns:
        The model of the device as recorded in eggCloud; e.g., iPhone.
        See Also:
        setModel(String)

      • setModel

        public void setModel​(java.lang.String _model)
        Set the model of the device as recorded in eggCloud; e.g., iPhone.
        Parameters:
        _model - The model of the device as recorded in eggCloud; e.g., iPhone.
        See Also:
        getModel()

      • getOS

        public java.lang.String getOS()
        Get the operating system of the device as recorded in eggCloud; e.g., iOS.
        Returns:
        The operating system of the device as recorded in eggCloud; e.g., iOS.
        See Also:
        setOS(String)

      • setOS

        public void setOS​(java.lang.String _os)
        Set the operating system of the device as recorded in eggCloud; e.g., iOS.
        Parameters:
        _os - The operating system of the device as recorded in eggCloud; e.g., iOS.
        See Also:
        getOS()

      • getOSVersion

        public java.lang.String getOSVersion()
        Get the operating system version as recorded in eggCloud; e.g., 6.0.2.
        Returns:
        The operating system version as recorded in eggCloud; e.g., 6.0.2.
        See Also:
        setOSVersion(String)

      • setOSVersion

        public void setOSVersion​(java.lang.String _osVersion)
        Set the operating system version as recorded in eggCloud; e.g., 6.0.2.
        Parameters:
        _osVersion - The operating system version as recorded in eggCloud; e.g., 6.0.2.
        See Also:
        getOSVersion()

      • addMetaTag

        public void addMetaTag​(java.lang.String key,
                       java.lang.String value)
        Add a user-defined tag associated with devices as recorded in eggCloud.
        Parameters:
        key - the name of the tag
        value - the value of the tag
        See Also:
        getMetaTags(), getMetaTagValue(String)

      • getMetaTagValue

        public java.lang.String getMetaTagValue​(java.lang.String key)
        Get the value of a user-defined meta tag.
        Parameters:
        key - the name of the meta tag
        Returns:
        the value of the meta tag
        See Also:
        addMetaTag(String, String), getMetaTags()

      • addParameter

        public void addParameter​(java.lang.String key,
                         java.lang.String value)
        Add an additional parameter to add to the Connect command.
        Parameters:
        key - The name of the parameter
        value - The value of the parameter
        See Also:
        getParameters(), getParameterValue(String)

      • getParameterValue

        public java.lang.String getParameterValue​(java.lang.String key)
        Get the value of the specified parameter.
        Parameters:
        key - the parameter to get
        Returns:
        the value of the parameter.
        See Also:
        addParameter(String, String), getParameters()