Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use AppiumNewSessionCommandPayload class of io.appium.java_client.remote package

Best io.appium code snippet using io.appium.java_client.remote.AppiumNewSessionCommandPayload

AppiumDriver.java

Source:AppiumDriver.java

...19import static io.appium.java_client.remote.MobileCapabilityType.PLATFORM_NAME;20import static org.apache.commons.lang3.StringUtils.isBlank;21import io.appium.java_client.internal.CapabilityHelpers;22import io.appium.java_client.remote.AppiumCommandExecutor;23import io.appium.java_client.remote.AppiumNewSessionCommandPayload;24import io.appium.java_client.remote.MobileCapabilityType;25import io.appium.java_client.remote.options.BaseOptions;26import io.appium.java_client.service.local.AppiumDriverLocalService;27import io.appium.java_client.service.local.AppiumServiceBuilder;28import org.openqa.selenium.Capabilities;29import org.openqa.selenium.ImmutableCapabilities;30import org.openqa.selenium.MutableCapabilities;31import org.openqa.selenium.SessionNotCreatedException;32import org.openqa.selenium.WebDriverException;33import org.openqa.selenium.remote.CapabilityType;34import org.openqa.selenium.remote.DriverCommand;35import org.openqa.selenium.remote.ErrorHandler;36import org.openqa.selenium.remote.ExecuteMethod;37import org.openqa.selenium.remote.HttpCommandExecutor;38import org.openqa.selenium.remote.RemoteWebDriver;39import org.openqa.selenium.remote.Response;40import org.openqa.selenium.remote.html5.RemoteLocationContext;41import org.openqa.selenium.remote.http.HttpClient;42import org.openqa.selenium.remote.http.HttpMethod;43import java.lang.reflect.Field;44import java.net.URL;45import java.util.Arrays;46import java.util.Collections;47import java.util.Map;48/**49 * Default Appium driver implementation.50 */51public class AppiumDriver extends RemoteWebDriver implements52        ExecutesMethod,53        ComparesImages,54        ExecutesDriverScript,55        LogsEvents,56        HasBrowserCheck,57        HasSettings {58    private static final ErrorHandler errorHandler = new ErrorHandler(new ErrorCodesMobile(), true);59    // frequently used command parameters60    private final URL remoteAddress;61    protected final RemoteLocationContext locationContext;62    private final ExecuteMethod executeMethod;63    /**64     * Creates a new instance based on command {@code executor} and {@code capabilities}.65     *66     * @param executor     is an instance of {@link HttpCommandExecutor}67     *                     or class that extends it. Default commands or another vendor-specific68     *                     commands may be specified there.69     * @param capabilities take a look at {@link Capabilities}70     */71    public AppiumDriver(HttpCommandExecutor executor, Capabilities capabilities) {72        super(executor, capabilities);73        this.executeMethod = new AppiumExecutionMethod(this);74        locationContext = new RemoteLocationContext(executeMethod);75        super.setErrorHandler(errorHandler);76        this.remoteAddress = executor.getAddressOfRemoteServer();77    }78    public AppiumDriver(URL remoteAddress, Capabilities capabilities) {79        this(new AppiumCommandExecutor(MobileCommand.commandRepository, remoteAddress),80                capabilities);81    }82    public AppiumDriver(URL remoteAddress, HttpClient.Factory httpClientFactory,83                        Capabilities capabilities) {84        this(new AppiumCommandExecutor(MobileCommand.commandRepository, remoteAddress,85                httpClientFactory), capabilities);86    }87    public AppiumDriver(AppiumDriverLocalService service, Capabilities capabilities) {88        this(new AppiumCommandExecutor(MobileCommand.commandRepository, service),89                capabilities);90    }91    public AppiumDriver(AppiumDriverLocalService service, HttpClient.Factory httpClientFactory,92                        Capabilities capabilities) {93        this(new AppiumCommandExecutor(MobileCommand.commandRepository, service, httpClientFactory),94                capabilities);95    }96    public AppiumDriver(AppiumServiceBuilder builder, Capabilities capabilities) {97        this(builder.build(), capabilities);98    }99    public AppiumDriver(AppiumServiceBuilder builder, HttpClient.Factory httpClientFactory,100                        Capabilities capabilities) {101        this(builder.build(), httpClientFactory, capabilities);102    }103    public AppiumDriver(HttpClient.Factory httpClientFactory, Capabilities capabilities) {104        this(AppiumDriverLocalService.buildDefaultService(), httpClientFactory,105                capabilities);106    }107    public AppiumDriver(Capabilities capabilities) {108        this(AppiumDriverLocalService.buildDefaultService(), capabilities);109    }110    /**111     * Changes platform name if it is not set and returns merged capabilities.112     *113     * @param originalCapabilities the given {@link Capabilities}.114     * @param defaultName          a {@link MobileCapabilityType#PLATFORM_NAME} value which has115     *                             to be set up116     * @return {@link Capabilities} with changed platform name value or the original capabilities117     */118    protected static Capabilities ensurePlatformName(119            Capabilities originalCapabilities, String defaultName) {120        String currentName = (String) originalCapabilities.getCapability(PLATFORM_NAME);121        return isBlank(currentName)122                ? originalCapabilities.merge(new ImmutableCapabilities(PLATFORM_NAME, defaultName))123                : originalCapabilities;124    }125    /**126     * Changes automation name if it is not set and returns merged capabilities.127     *128     * @param originalCapabilities the given {@link Capabilities}.129     * @param defaultName          a {@link MobileCapabilityType#AUTOMATION_NAME} value which has130     *                             to be set up131     * @return {@link Capabilities} with changed mobile automation name value or the original capabilities132     */133    protected static Capabilities ensureAutomationName(134            Capabilities originalCapabilities, String defaultName) {135        String currentAutomationName = CapabilityHelpers.getCapability(136                originalCapabilities, AUTOMATION_NAME, String.class);137        if (isBlank(currentAutomationName)) {138            String capabilityName = originalCapabilities.getCapabilityNames()139                    .contains(AUTOMATION_NAME) ? AUTOMATION_NAME : APPIUM_PREFIX + AUTOMATION_NAME;140            return originalCapabilities.merge(new ImmutableCapabilities(capabilityName, defaultName));141        }142        return originalCapabilities;143    }144    /**145     * Changes platform and automation names if they are not set146     * and returns merged capabilities.147     *148     * @param originalCapabilities the given {@link Capabilities}.149     * @param defaultPlatformName  a {@link MobileCapabilityType#PLATFORM_NAME} value which has150     *                             to be set up151     * @param defaultAutomationName The default automation name to set up for this class152     * @return {@link Capabilities} with changed platform/automation name value or the original capabilities153     */154    protected static Capabilities ensurePlatformAndAutomationNames(155            Capabilities originalCapabilities, String defaultPlatformName, String defaultAutomationName) {156        Capabilities capsWithPlatformFixed = ensurePlatformName(originalCapabilities, defaultPlatformName);157        return ensureAutomationName(capsWithPlatformFixed, defaultAutomationName);158    }159    @Override160    public ExecuteMethod getExecuteMethod() {161        return executeMethod;162    }163    /**164     * This method is used to get build version status of running Appium server.165     *166     * @return map containing version details167     */168    public Map<String, Object> getStatus() {169        //noinspection unchecked170        return (Map<String, Object>) execute(DriverCommand.STATUS).getValue();171    }172    /**173     * This method is used to add custom appium commands in Appium 2.0.174     *175     * @param httpMethod the available {@link HttpMethod}.176     * @param url        The url to URL template as https://www.w3.org/TR/webdriver/#endpoints.177     * @param methodName The name of custom appium command.178     */179    public void addCommand(HttpMethod httpMethod, String url, String methodName) {180        switch (httpMethod) {181            case GET:182                MobileCommand.commandRepository.put(methodName, MobileCommand.getC(url));183                break;184            case POST:185                MobileCommand.commandRepository.put(methodName, MobileCommand.postC(url));186                break;187            case DELETE:188                MobileCommand.commandRepository.put(methodName, MobileCommand.deleteC(url));189                break;190            default:191                throw new WebDriverException(String.format("Unsupported HTTP Method: %s. Only %s methods are supported",192                        httpMethod,193                        Arrays.toString(HttpMethod.values())));194        }195        ((AppiumCommandExecutor) getCommandExecutor()).refreshAdditionalCommands();196    }197    public URL getRemoteAddress() {198        return remoteAddress;199    }200    @Override201    protected void startSession(Capabilities capabilities) {202        Response response = execute(new AppiumNewSessionCommandPayload(capabilities));203        if (response == null) {204            throw new SessionNotCreatedException(205                    "The underlying command executor returned a null response.");206        }207        Object responseValue = response.getValue();208        if (responseValue == null) {209            throw new SessionNotCreatedException(210                    "The underlying command executor returned a response without payload: "211                            + response);212        }213        if (!(responseValue instanceof Map)) {214            throw new SessionNotCreatedException(215                    "The underlying command executor returned a response with a non well formed payload: "216                            + response);...