1 package com.atlassian.selenium;
2
3 /**
4 * A class that should be implemented by all users of the Atlassian-Selenium library.
5 * Implementations
6 *
7 * @since v3.12
8 */
9 public interface SeleniumConfiguration
10 {
11 /**
12 * The address of the node hosting the selenium
13 * server.
14 */
15 String getServerLocation();
16
17 /**
18 * The port the selenium server is listening on
19 */
20 int getServerPort();
21
22 /**
23 * The browser start string to be passed to Selenium
24 */
25 String getBrowserStartString();
26
27 /**
28 * Gets firefox profile location
29 */
30 String getFirefoxProfileTemplate();
31
32 /**
33 * The starting url for the browser
34 */
35 String getBaseUrl();
36
37 /**
38 * Whether the framework should start the selenium server
39 */
40 boolean getStartSeleniumServer();
41
42 /**
43 * The time that various utility classes will wait after performing some Selenium
44 * action like the mouseOver method in the {@link SeleniumClient}.
45 */
46 long getActionWait();
47
48 /**
49 * The maximum time various utility clasess will wait for a page to load.
50 * Ideally this value should be used where ever a test waits for a page to load.
51 */
52 long getPageLoadWait();
53
54 /**
55 * The time in milliseconds between condition checks.
56 * @see {@link SeleniumAssertions#byTimeout(Condition)}
57 */
58 long getConditionCheckInterval();
59
60 /**
61 * Only applies if Selenium Server is started by the Atlassian Selenium Framework
62 * Will run the selenium server in single browser window or split between a command
63 * window and a test window
64 */
65 boolean getSingleWindowMode();
66
67 /**
68 * File location where the performance report based on the time in wait for conditions
69 * should be created. Report won't be generated if this returns a null value.
70 * @return
71 */
72 String getPerformanceReportLocation();
73
74 /**
75 * Determines whether the performance report will include all events (using the locator
76 * or some other auto-generated value as a key) or just those events where an explicit
77 * key has been provided.
78 * @return
79 */
80 boolean getShowAutoGeneratedPerformanceEvents();
81 }