org.openqa.selenium.ie.InternetExplorerDriverService Maven / Gradle / Ivy
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package org.openqa.selenium.ie;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.remote.service.DriverService;
import java.io.File;
import java.io.IOException;
/**
* Manages the life and death of an IEDriverServer.
*/
public class InternetExplorerDriverService extends DriverService {
/**
* System property that defines the location of the IEDriverServer executable
* that will be used by the {@link #createDefaultService() default service}.
*/
public static final String IE_DRIVER_EXE_PROPERTY = "webdriver.ie.driver";
/**
* System property that defines the location of the file where IEDriverServer
* should write log messages to.
*/
public static final String IE_DRIVER_LOGFILE_PROPERTY = "webdriver.ie.driver.logfile";
/**
* System property that defines the detalization level the IEDriverServer logs.
*/
public static final String IE_DRIVER_LOGLEVEL_PROPERTY = "webdriver.ie.driver.loglevel";
/**
* System property that defines the implementation of the driver engine to use.
*/
public static final String IE_DRIVER_ENGINE_PROPERTY = "webdriver.ie.driver.engine";
/**
* System property that defines host to which will be bound IEDriverServer.
*/
public final static String IE_DRIVER_HOST_PROPERTY = "webdriver.ie.driver.host";
/**
* System property that defines path to which will be extracted IEDriverServer library.
*/
public final static String IE_DRIVER_EXTRACT_PATH_PROPERTY = "webdriver.ie.driver.extractpath";
/**
* System property that defines logging to stdout for IEDriverServer.
*/
public final static String IE_DRIVER_SILENT_PROPERTY = "webdriver.ie.driver.silent";
/**
*
* @param executable The IEDriverServer executable.
* @param port Which port to start the IEDriverServer on.
* @param args The arguments to the launched server.
* @param environment The environment for the launched server.
* @throws IOException If an I/O error occurs.
*/
private InternetExplorerDriverService(File executable, int port, ImmutableList args,
ImmutableMap environment) throws IOException {
super(executable, port, args, environment);
}
/**
* Configures and returns a new {@link InternetExplorerDriverService} using the default configuration. In
* this configuration, the service will use the IEDriverServer executable identified by the
* {@link #IE_DRIVER_EXE_PROPERTY} system property. Each service created by this method will
* be configured to use a free port on the current system.
*
* @return A new InternetExplorerDriverService using the default configuration.
*/
public static InternetExplorerDriverService createDefaultService() {
return new Builder().usingAnyFreePort().build();
}
/**
* Builder used to configure new {@link InternetExplorerDriverService} instances.
*/
public static class Builder extends DriverService.Builder<
InternetExplorerDriverService, InternetExplorerDriverService.Builder> {
private InternetExplorerDriverLogLevel logLevel;
private InternetExplorerDriverEngine engineImplementation;
private String host = null;
private File extractPath = null;
private Boolean silent = null;
private Boolean forceCreateProcess = null;
private String ieSwitches = null;
/**
* Configures the logging level for the driver server.
*
* @param logLevel A level of the log verbosity.
* @return A self reference.
*/
public Builder withLogLevel(InternetExplorerDriverLogLevel logLevel) {
this.logLevel = logLevel;
return this;
}
/**
* Configures the driver engine implementation for the driver server.
*
* @param engineImplementation The engine implementation to be used.
* @return A self reference.
*/
public Builder withEngineImplementation(InternetExplorerDriverEngine engineImplementation) {
this.engineImplementation = engineImplementation;
return this;
}
/**
* Configures the host to which the driver server bound.
*
* @param host A host name.
* @return A self reference.
*/
public Builder withHost(String host) {
this.host = host;
return this;
}
/**
* Configures path to which the driver server library will be extracted.
*
* @param extractPath A path.
* @return A self reference.
*/
public Builder withExtractPath(File extractPath) {
this.extractPath = extractPath;
return this;
}
/**
* Configures silence in stdout of the driver server by unlogged messages.
*
* @param silent To be silent in stdout ir not.
* @return A self reference.
*/
public Builder withSilent(Boolean silent) {
this.silent = silent;
return this;
}
@Override
protected File findDefaultExecutable() {
return findExecutable("IEDriverServer", IE_DRIVER_EXE_PROPERTY,
"https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver",
"http://selenium-release.storage.googleapis.com/index.html");
}
@Override
protected ImmutableList createArgs() {
if (getLogFile() == null) {
String logFilePath = System.getProperty(IE_DRIVER_LOGFILE_PROPERTY);
if (logFilePath != null) {
withLogFile(new File(logFilePath));
}
}
if (logLevel == null) {
String level = System.getProperty(IE_DRIVER_LOGLEVEL_PROPERTY);
if (level != null) {
logLevel = InternetExplorerDriverLogLevel.valueOf(level);
}
}
if (engineImplementation == null) {
String engineToUse = System.getProperty(IE_DRIVER_ENGINE_PROPERTY);
if (engineToUse != null) {
engineImplementation = InternetExplorerDriverEngine.valueOf(engineToUse);
}
}
if (host == null) {
String hostProperty = System.getProperty(IE_DRIVER_HOST_PROPERTY);
if (hostProperty != null) {
host = hostProperty;
}
}
if (extractPath == null) {
String extractPathProperty = System.getProperty(IE_DRIVER_EXTRACT_PATH_PROPERTY);
if (extractPathProperty != null) {
extractPath = new File(extractPathProperty);
}
}
if (silent == null) {
String silentProperty = System.getProperty(IE_DRIVER_SILENT_PROPERTY);
if (silentProperty != null) {
silent = Boolean.valueOf(silentProperty);
}
}
ImmutableList.Builder argsBuilder = ImmutableList.builder();
argsBuilder.add(String.format("--port=%d", getPort()));
if (getLogFile() != null) {
argsBuilder.add(String.format("--log-file=\"%s\"", getLogFile().getAbsolutePath()));
}
if (logLevel != null) {
argsBuilder.add(String.format("--log-level=%s", logLevel.toString()));
}
if (engineImplementation != null) {
argsBuilder.add(String.format("--implementation=%s", engineImplementation.toString()));
}
if (host != null) {
argsBuilder.add(String.format("--host=%s", host));
}
if (extractPath != null) {
argsBuilder.add(String.format("--extract-path=\"%s\"", extractPath.getAbsolutePath()));
}
if (silent != null && silent.equals(Boolean.TRUE)) {
argsBuilder.add("--silent");
}
return argsBuilder.build();
}
@Override
protected InternetExplorerDriverService createDriverService(File exe, int port,
ImmutableList args,
ImmutableMap environment) {
try {
return new InternetExplorerDriverService(exe, port, args, environment);
} catch (IOException e) {
throw new WebDriverException(e);
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy