org.openqa.selenium.safari

Class SafariOptions

java.lang.Object

org.openqa.selenium.safari.SafariOptions

public class SafariOptions
extends java.lang.Object

Class to manage options specific to SafariDriver.

Example usage:

 SafariOptions options = new SafariOptions()
 options.setUseCleanSession(true);

 // For use with SafariDriver:
 SafariDriver driver = new SafariDriver(options);

 // For use with RemoteWebDriver:
 DesiredCapabilities capabilities = DesiredCapabilities.safari();
 capabilities.setCapability(SafariOptions.CAPABILITY, options);
 RemoteWebDriver driver = new RemoteWebDriver(
     new URL("http://localhost:4444/wd/hub"), capabilities);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SafariOptions.Option

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPABILITY Key used to store SafariOptions in a DesiredCapabilities object.
private int	port
private boolean	useCleanSession

Constructor Summary

Constructors

Constructor and Description
SafariOptions()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
static SafariOptions	fromCapabilities(org.openqa.selenium.Capabilities capabilities) Construct a SafariOptions instance from given capabilites.
private static SafariOptions	fromJsonMap(java.util.Map<?,?> options) Parse a Map and reconstruct the SafariOptions.
int	getPort()
boolean	getUseCleanSession()
int	hashCode()
void	setPort(int port) Set the port the SafariDriverServer should be started on.
void	setUseCleanSession(boolean useCleanSession) Instruct the SafariDriver to delete all existing session data when starting a new session.
(package private) org.openqa.selenium.remote.DesiredCapabilities	toCapabilities() Returns DesiredCapabilities for Safari with these options included as capabilities.
com.google.gson.JsonObject	toJson() Converts this instance to its JSON representation.

Methods inherited from class java.lang.Object

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

Field Detail

CAPABILITY

public static final java.lang.String CAPABILITY

Key used to store SafariOptions in a DesiredCapabilities object.

See Also:

Constant Field Values

port

private int port

See Also:

setPort(int)

useCleanSession

private boolean useCleanSession

See Also:

setUseCleanSession(boolean)

Constructor Detail

SafariOptions

public SafariOptions()

Method Detail

fromCapabilities

public static SafariOptions fromCapabilities(org.openqa.selenium.Capabilities capabilities)
                                      throws org.openqa.selenium.WebDriverException

Construct a SafariOptions instance from given capabilites. When the CAPABILITY capability is set, all other capabilities will be ignored!

Parameters:

capabilities - Desired capabilities from which the options are derived.

Returns:

SafariOptions

Throws:

org.openqa.selenium.WebDriverException - If an error occurred during the reconstruction of the options

setPort

public void setPort(int port)

Set the port the SafariDriverServer should be started on. Defaults to 0, in which case the server selects a free port.

Parameters:

port - The port the SafariDriverServer should be started on, or 0 if the server should select a free port.

setUseCleanSession

public void setUseCleanSession(boolean useCleanSession)

Instruct the SafariDriver to delete all existing session data when starting a new session. This includes browser history, cache, cookies, HTML5 local storage, and HTML5 databases.

Warning: Since Safari uses a single profile for the current user, enabling this capability will permanently erase any existing session data.

Parameters:

useCleanSession - If true, the SafariDriver will erase all existing session data.

getPort

public int getPort()

Returns:

The port the SafariDriverServer should be started on. If 0, the server should select a free port.

See Also:

setPort(int)

getUseCleanSession

public boolean getUseCleanSession()

Returns:

Whether the SafariDriver should erase all session data before launching Safari.

See Also:

setUseCleanSession(boolean)

toJson

public com.google.gson.JsonObject toJson()
                                  throws java.io.IOException

Converts this instance to its JSON representation.

Returns:

The JSON representation of the options.

Throws:

java.io.IOException - If an error occurred while reading the Safari extension files.

fromJsonMap

private static SafariOptions fromJsonMap(java.util.Map<?,?> options)
                                  throws java.io.IOException

Parse a Map and reconstruct the SafariOptions. A temporary directory is created to hold all Safari extension files.

Parameters:

options - A Map derived from the output of toJson().

Returns:

A SafariOptions instance associated with these extensions.

Throws:

java.io.IOException - If an error occurred while writing the safari extensions to a temporary directory.

toCapabilities

org.openqa.selenium.remote.DesiredCapabilities toCapabilities()

Returns DesiredCapabilities for Safari with these options included as capabilities. This does not copy the object. Further changes will be reflected in the returned capabilities.

Returns:

DesiredCapabilities for Safari with these extensions.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object