Interface IDriverPool

    • Method Summary

      All Methods Static Methods Instance Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      static Device getDefaultDevice()
      Deprecated.
      default Device getDevice()
      Get device registered to default driver.
      default Device getDevice​(java.lang.String name)
      Get device registered to named driver.
      default Device getDevice​(org.openqa.selenium.WebDriver drv)
      Get device registered to driver.
      default org.openqa.selenium.WebDriver getDriver()
      Get default driver.
      default org.openqa.selenium.WebDriver getDriver​(Device device)
      Get driver registered to device.
      default org.openqa.selenium.WebDriver getDriver​(java.lang.String name)
      Get driver by name.
      default org.openqa.selenium.WebDriver getDriver​(java.lang.String name, org.openqa.selenium.remote.DesiredCapabilities capabilities)
      Get driver by name and DesiredCapabilities.
      default org.openqa.selenium.WebDriver getDriver​(java.lang.String name, org.openqa.selenium.remote.DesiredCapabilities capabilities, java.lang.String seleniumHost)
      Get driver by name.
      static org.openqa.selenium.WebDriver getDriver​(org.openqa.selenium.remote.SessionId sessionId)
      Get driver by sessionId.
      default java.util.concurrent.ConcurrentHashMap<java.lang.String,​CarinaDriver> getDrivers()
      Return all drivers registered in the DriverPool for this thread including on Before Suite/Class/Method stages
      static Device getNullDevice()
      Return nullDevice object to avoid NullPointerException and tons of verification across carina-core modules.
      default boolean isDeviceRegistered()
      Verify if device is registered in the Pool
      default boolean isDriverRegistered​(java.lang.String name)
      Verify if driver is registered in the DriverPool
      default void quitDriver()
      Quit default driver
      default void quitDriver​(java.lang.String name)
      Quit driver by name
      default void quitDrivers​(TestPhase.Phase... phase)
      Quit current drivers by phase(s).
      static Device registerDevice​(Device device)
      Register device information for current thread by MobileFactory and clear SysLog for Android only
      default void removeCapabilities()
      Remove custom capabilities.
      default org.openqa.selenium.WebDriver restartDriver()
      Restart default driver
      default org.openqa.selenium.WebDriver restartDriver​(boolean isSameDevice)
      Restart default driver on the same device
      default void setCapabilities​(org.openqa.selenium.remote.DesiredCapabilities caps)
      Set custom capabilities.
    • Field Detail

      • POOL_LOGGER

        static final org.slf4j.Logger POOL_LOGGER
      • driversMap

        static final java.util.concurrent.ConcurrentHashMap<CarinaDriver,​java.lang.Integer> driversMap
      • driversPool

        static final java.util.Set<CarinaDriver> driversPool
      • currentDevice

        static final java.lang.ThreadLocal<Device> currentDevice
      • nullDevice

        static final Device nullDevice
      • customCapabilities

        static final java.lang.ThreadLocal<org.openqa.selenium.remote.DesiredCapabilities> customCapabilities
    • Method Detail

      • getDriver

        default org.openqa.selenium.WebDriver getDriver()
        Get default driver. If no default driver discovered it will be created.
        Returns:
        default WebDriver
      • getDriver

        default org.openqa.selenium.WebDriver getDriver​(java.lang.String name)
        Get driver by name. If no driver discovered it will be created using default capabilities.
        Parameters:
        name - String driver name
        Returns:
        WebDriver
      • getDriver

        default org.openqa.selenium.WebDriver getDriver​(java.lang.String name,
                                                        org.openqa.selenium.remote.DesiredCapabilities capabilities)
        Get driver by name and DesiredCapabilities.
        Parameters:
        name - String driver name
        capabilities - DesiredCapabilities capabilities
        Returns:
        WebDriver
      • getDriver

        default org.openqa.selenium.WebDriver getDriver​(java.lang.String name,
                                                        org.openqa.selenium.remote.DesiredCapabilities capabilities,
                                                        java.lang.String seleniumHost)
        Get driver by name. If no driver discovered it will be created using custom capabilities and selenium server.
        Parameters:
        name - String driver name
        capabilities - DesiredCapabilities
        seleniumHost - String
        Returns:
        WebDriver
      • getDriver

        static org.openqa.selenium.WebDriver getDriver​(org.openqa.selenium.remote.SessionId sessionId)
        Get driver by sessionId.
        Parameters:
        sessionId - - session id to be used for searching a desired driver
        Returns:
        default WebDriver
      • getDriver

        default org.openqa.selenium.WebDriver getDriver​(Device device)
        Get driver registered to device. If no device discovered null will be returned.
        Parameters:
        device - Device
        Returns:
        WebDriver
      • restartDriver

        default org.openqa.selenium.WebDriver restartDriver()
        Restart default driver
        Returns:
        WebDriver
      • restartDriver

        default org.openqa.selenium.WebDriver restartDriver​(boolean isSameDevice)
        Restart default driver on the same device
        Parameters:
        isSameDevice - boolean restart driver on the same device or not
        Returns:
        WebDriver
      • quitDriver

        default void quitDriver()
        Quit default driver
      • quitDriver

        default void quitDriver​(java.lang.String name)
        Quit driver by name
        Parameters:
        name - String driver name
      • quitDrivers

        default void quitDrivers​(TestPhase.Phase... phase)
        Quit current drivers by phase(s). "Current" means assigned to the current test/thread.
        Parameters:
        phase - Comma separated driver phases to quit
      • setCapabilities

        default void setCapabilities​(org.openqa.selenium.remote.DesiredCapabilities caps)
        Set custom capabilities.
        Parameters:
        caps - capabilities
      • removeCapabilities

        default void removeCapabilities()
        Remove custom capabilities.
      • isDriverRegistered

        default boolean isDriverRegistered​(java.lang.String name)
        Verify if driver is registered in the DriverPool
        Parameters:
        name - String driver name
        Returns:
        boolean
      • getDrivers

        default java.util.concurrent.ConcurrentHashMap<java.lang.String,​CarinaDriver> getDrivers()
        Return all drivers registered in the DriverPool for this thread including on Before Suite/Class/Method stages
        Returns:
        ConcurrentHashMap of driver names and Carina WebDrivers
      • getDevice

        default Device getDevice()
        Get device registered to default driver. If no default driver discovered nullDevice will be returned.
        Returns:
        default Device
      • getDevice

        default Device getDevice​(java.lang.String name)
        Get device registered to named driver. If no driver discovered nullDevice will be returned.
        Parameters:
        name - String driver name
        Returns:
        Device
      • getDevice

        default Device getDevice​(org.openqa.selenium.WebDriver drv)
        Get device registered to driver. If no driver discovered nullDevice will be returned.
        Parameters:
        drv - WebDriver
        Returns:
        Device
      • registerDevice

        static Device registerDevice​(Device device)
        Register device information for current thread by MobileFactory and clear SysLog for Android only
        Parameters:
        device - String Device device
        Returns:
        Device device
      • getDefaultDevice

        @Deprecated
        static Device getDefaultDevice()
        Deprecated.
        Return last registered device information for current thread.
        Returns:
        Device device
      • getNullDevice

        static Device getNullDevice()
        Return nullDevice object to avoid NullPointerException and tons of verification across carina-core modules.
        Returns:
        Device device
      • isDeviceRegistered

        default boolean isDeviceRegistered()
        Verify if device is registered in the Pool
        Returns:
        boolean