org.finra.jtaf.ewd.session.SessionFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jtaf-extwebdriver Show documentation

ExtWebDriver is an enhancement to the WebDriver API, with features such as widget library, session management and extended functions

There is a newer version: 1.5.6

Show newest version

/*
 * (C) Copyright 2013 Java Test Automation Framework Contributors.
 *
 * Licensed 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.finra.jtaf.ewd.session;

import java.util.Map;

import org.finra.jtaf.ewd.ExtWebDriver;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.remote.DesiredCapabilities;

/**
 *
 * Interface for DefaultSessionsFactory
 *
 */
public interface SessionFactory {
    /**
     *
     * @return a map of strings
     */
    public Map createDefaultOptions();

    /**
     * Cleans up the session - closed all taks
     * @param options
     *            the options for cleaning up
     * @throws Exception
     */
    public void cleanup(Map options) throws Exception;

    /**
     *
     * @param options
     *            the options you want the capabilities instance to have
     * @return the capabilities of webdriver
     * @throws Exception
     */
    public DesiredCapabilities createCapabilities(Map options) throws Exception;

    /**
     *
     * @param options
     *            the options passed on to the webdriver instance
     * @param capabilities
     *            the capabilities you want webdriver to have
     * @return the instance of WebDriver not wrapped by our extended version
     * @throws Exception
     */
    public WebDriver createInnerDriver(Map options, DesiredCapabilities capabilities)
            throws Exception;

    /**
     *
     * @param options
     *            options for the session
     * @param wd
     *            the instance of WebDriver
     * @return the new session instance of ExtendedWebDriver
     */
    public ExtWebDriver createNewSession(Map options, WebDriver wd);
}