Java tutorial
/** * The software subject to this notice and license includes both human readable * source code form and machine readable, binary, object code form. The NCI OCR * Software was developed in conjunction with the National Cancer Institute * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent * government employees are authors, any rights in such works shall be subject * to Title 17 of the United States Code, section 105. * * This NCI OCR Software License (the License) is between NCI and You. You (or * Your) shall mean a person or an entity, and all other entities that control, * are controlled by, or are under common control with the entity. Control for * purposes of this definition means (i) the direct or indirect power to cause * the direction or management of such entity, whether by contract or otherwise, * or (ii) ownership of fifty percent (50%) or more of the outstanding shares, * or (iii) beneficial ownership of such entity. * * This License is granted provided that You agree to the conditions described * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up, * no-charge, irrevocable, transferable and royalty-free right and license in * its rights in the NCI OCR Software to (i) use, install, access, operate, * execute, copy, modify, translate, market, publicly display, publicly perform, * and prepare derivative works of the NCI OCR Software; (ii) distribute and * have distributed to and by third parties the NCI OCR Software and any * modifications and derivative works thereof; and (iii) sublicense the * foregoing rights set out in (i) and (ii) to third parties, including the * right to license such rights to further third parties. For sake of clarity, * and not by way of limitation, NCI shall have no right of accounting or right * of payment from You or Your sub-licensees for the rights granted under this * License. This License is granted at no charge to You. * * Your redistributions of the source code for the Software must retain the * above copyright notice, this list of conditions and the disclaimer and * limitation of liability of Article 6, below. Your redistributions in object * code form must reproduce the above copyright notice, this list of conditions * and the disclaimer of Article 6 in the documentation and/or other materials * provided with the distribution, if any. * * Your end-user documentation included with the redistribution, if any, must * include the following acknowledgment: This product includes software * developed by 5AM and the National Cancer Institute. If You do not include * such end-user documentation, You shall include this acknowledgment in the * Software itself, wherever such third-party acknowledgments normally appear. * * You may not use the names "The National Cancer Institute", "NCI", or "5AM" * to endorse or promote products derived from this Software. This License does * not authorize You to use any trademarks, service marks, trade names, logos or * product names of either NCI or 5AM, except as required to comply with the * terms of this License. * * For sake of clarity, and not by way of limitation, You may incorporate this * Software into Your proprietary programs and into any third party proprietary * programs. However, if You incorporate the Software into third party * proprietary programs, You agree that You are solely responsible for obtaining * any permission from such third parties required to incorporate the Software * into such third party proprietary programs and for informing Your * sub-licensees, including without limitation Your end-users, of their * obligation to secure any required permissions from such third parties before * incorporating the Software into such third party proprietary software * programs. In the event that You fail to obtain such permissions, You agree * to indemnify NCI for any claims against NCI by such third parties, except to * the extent prohibited by law, resulting from Your failure to obtain such * permissions. * * For sake of clarity, and not by way of limitation, You may add Your own * copyright statement to Your modifications and to the derivative works, and * You may provide additional or different license terms and conditions in Your * sublicenses of modifications of the Software, or any derivative works of the * Software as a whole, provided Your use, reproduction, and distribution of the * Work otherwise complies with the conditions stated in this License. * * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package gov.nih.nci.firebird.commons.selenium2.test; import java.io.File; import org.openqa.selenium.WebDriver; import org.openqa.selenium.chrome.ChromeDriver; import org.openqa.selenium.firefox.FirefoxBinary; import org.openqa.selenium.firefox.FirefoxDriver; import org.openqa.selenium.firefox.FirefoxProfile; import org.openqa.selenium.firefox.UnableToCreateProfileException; import org.openqa.selenium.ie.InternetExplorerDriver; import org.openqa.selenium.safari.SafariDriver; import com.google.inject.AbstractModule; import com.google.inject.Provider; import com.google.inject.Provides; import com.google.inject.Singleton; import com.google.inject.name.Named; /** * Provides dependencies / configuration for Selenium WebDriver. WebDrivers for various browsers are accessed as @Named * injections. Requesting @Named("selenium.driver") returns the driver configured by the property selenium.driver.type. * Requires that the following named String properties are provided by another Guice module: * * <ul> * <li> * selenium.driver.type - Identifies which driver to return when requesting @Named("selenium.driver"). Supported values are: * chrome, firefox, iexplore, safari * </li> * <li> * selenium.firefox.profile.location - the absolute path to a Firefox profile file. Value may be blank if not providing a profile. * </li> * <li> * server.protocol - the protocol used to access your application (typically "http" or "https"). * </li> * <li> * server.hostname - the hostname used to access the application * </li> * <li> * server.port - the port used to access the application (standard ports are 80 and 443). * </li> * <p> * Other dependencies to be aware of: * * <p> * The Chrome WebDriver requires installation of chromedriver on the PATH * (available here <a href="http://code.google.com/p/chromedriver">http://code.google.com/p/chromedriver</a>). * * <p> * The Safari WebDriver requires build and installation of a custom extension to Safari. Details can be found * here: <a href="http://code.google.com/p/selenium/wiki/SafariDriver">http://code.google.com/p/selenium/wiki/SafariDriver</a>. */ public class WebDriverModule extends AbstractModule { @Override protected void configure() { // all configuration handled in provides methods } @Provides @Singleton @Named("selenium.chrome.driver") public WebDriver provideChromeDriver() { final WebDriver driver = new ChromeDriver(); closeDriverOnShutdown(driver); return driver; } @Provides @Singleton @Named("selenium.firefox.driver") public WebDriver provideFirefoxDriver(@Named("selenium.firefox.profile.location") String profileLocation, @Named("selenium.firefox.binary.location") String binaryLocation) { FirefoxProfile profile = null; FirefoxBinary binary = null; try { File profileDir = new File(profileLocation); profile = new FirefoxProfile(profileDir); } catch (UnableToCreateProfileException e) { } File binaryDir = new File(binaryLocation); if (binaryDir.exists()) { binary = new FirefoxBinary(binaryDir); } WebDriver driver = new FirefoxDriver(binary, profile); closeDriverOnShutdown(driver); return driver; } @Provides @Singleton @Named("selenium.iexplore.driver") public WebDriver provideInternetExplorerDriver() { final WebDriver driver = new InternetExplorerDriver(); closeDriverOnShutdown(driver); return driver; } @Provides @Singleton @Named("selenium.safari.driver") public WebDriver provideSafariDriver() { final WebDriver driver = new SafariDriver(); closeDriverOnShutdown(driver); return driver; } @Provides @Singleton @Named("selenium.driver") public WebDriver provideDriver(@Named("selenium.driver.type") String driverType, @Named("selenium.chrome.driver") Provider<WebDriver> chromeDriverProvider, @Named("selenium.firefox.driver") Provider<WebDriver> firefoxDriverProvider, @Named("selenium.iexplore.driver") Provider<WebDriver> internetExplorerDriverProvider, @Named("selenium.safari.driver") Provider<WebDriver> safariDriverProvider) { if ("chrome".equals(driverType)) { return chromeDriverProvider.get(); } else if ("firefox".equals(driverType)) { return firefoxDriverProvider.get(); } else if ("iexplore".equals(driverType)) { return internetExplorerDriverProvider.get(); } else if ("safari".equals(driverType)) { return safariDriverProvider.get(); } else { throw new IllegalArgumentException("Illegal value for selenium.driver.type: " + driverType); } } private void closeDriverOnShutdown(final WebDriver driver) { Runtime.getRuntime().addShutdownHook(new Thread() { @Override public void run() { driver.close(); } }); } @Provides @Singleton @Named("selenium.base.url") public String provideSeleniumBaseUrl(@Named("server.protocol") String protocol, @Named("server.hostname") String hostname, @Named("server.port") int port) { return protocol + "://" + hostname + ":" + port; } }