Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use getAdditionalCommands method of io.appium.java_client.remote.AppiumCommandExecutor class

Best io.appium code snippet using io.appium.java_client.remote.AppiumCommandExecutor.getAdditionalCommands

AppiumCommandExecutor.java

Source:AppiumCommandExecutor.java

...113            superclass = superclass.getSuperclass();114        }115        throw new WebDriverException(recentException);116    }117    protected Map<String, CommandInfo> getAdditionalCommands() {118        //noinspection unchecked119        return getPrivateFieldValue("additionalCommands", Map.class);120    }121    protected CommandCodec<HttpRequest> getCommandCodec() {122        //noinspection unchecked123        return getPrivateFieldValue("commandCodec", CommandCodec.class);124    }125    protected void setCommandCodec(CommandCodec<HttpRequest> newCodec) {126        setPrivateFieldValue("commandCodec", newCodec);127    }128    protected void setResponseCodec(ResponseCodec<HttpResponse> codec) {129        setPrivateFieldValue("responseCodec", codec);130    }131    protected HttpClient getClient() {132        //noinspection unchecked133        return getPrivateFieldValue("client", HttpClient.class);134    }135    private Response createSession(Command command) throws IOException {136        if (getCommandCodec() != null) {137            throw new SessionNotCreatedException("Session already exists");138        }139        ProtocolHandshake handshake = new ProtocolHandshake() {140            @SuppressWarnings("unchecked")141            public Result createSession(HttpClient client, Command command)142                    throws IOException {143                Capabilities desiredCapabilities = (Capabilities) command.getParameters().get("desiredCapabilities");144                Capabilities desired = desiredCapabilities == null ? new ImmutableCapabilities() : desiredCapabilities;145                //the number of bytes before the stream should switch to buffering to a file146                int threshold = (int) Math.min(Runtime.getRuntime().freeMemory() / 10, Integer.MAX_VALUE);147                FileBackedOutputStream os = new FileBackedOutputStream(threshold);148                try {149                    CountingOutputStream counter = new CountingOutputStream(os);150                    Writer writer = new OutputStreamWriter(counter, UTF_8);151                    NewAppiumSessionPayload payload = NewAppiumSessionPayload.create(desired);152                    payload.writeTo(writer);153                    try (InputStream rawIn = os.asByteSource().openBufferedStream();154                         BufferedInputStream contentStream = new BufferedInputStream(rawIn)) {155                        Method createSessionMethod = this.getClass().getSuperclass()156                                .getDeclaredMethod("createSession", HttpClient.class, InputStream.class, long.class);157                        createSessionMethod.setAccessible(true);158                        Optional<Result> result = (Optional<Result>) createSessionMethod159                                .invoke(this, client, contentStream, counter.getCount());160                        return result.map(result1 -> {161                            Result toReturn = result.get();162                            getLogger(ProtocolHandshake.class.getName())163                                    .info(format("Detected dialect: %s", toReturn.getDialect()));164                            return toReturn;165                        }).orElseThrow(() -> new SessionNotCreatedException(166                                format("Unable to create a new remote session. Desired capabilities = %s", desired)));167                    } catch (NoSuchMethodException | IllegalAccessException e) {168                        throw new SessionNotCreatedException(format("Unable to create a new remote session. "169                                        + "Make sure your project dependencies config does not override "170                                        + "Selenium API version %s used by java-client library.",171                                Config.main().getValue("selenium.version", String.class)), e);172                    } catch (InvocationTargetException e) {173                        String message = "Unable to create a new remote session.";174                        if (e.getCause() != null) {175                            if (e.getCause() instanceof WebDriverException) {176                                message += " Please check the server log for more details.";177                            }178                            message += format(" Original error: %s", e.getCause().getMessage());179                        }180                        throw new SessionNotCreatedException(message, e);181                    }182                } finally {183                    os.reset();184                }185            }186        };187        ProtocolHandshake.Result result = handshake188                .createSession(getClient(), command);189        Dialect dialect = result.getDialect();190        setCommandCodec(dialect.getCommandCodec());191        getAdditionalCommands().forEach(this::defineCommand);192        setResponseCodec(dialect.getResponseCodec());193        return result.createResponse();194    }195    @Override196    public Response execute(Command command) throws WebDriverException {197        if (DriverCommand.NEW_SESSION.equals(command.getName())) {198            serviceOptional.ifPresent(driverService -> {199                try {200                    driverService.start();201                } catch (IOException e) {202                    throw new WebDriverException(e.getMessage(), e);203                }204            });205        }206        Response response;207        try {208            response = NEW_SESSION.equals(command.getName()) ? createSession(command) : super.execute(command);209        } catch (Throwable t) {210            Throwable rootCause = Throwables.getRootCause(t);211            if (rootCause instanceof ConnectException212                    && rootCause.getMessage().contains("Connection refused")) {213                throw serviceOptional.map(service -> {214                    if (service.isRunning()) {215                        return new WebDriverException("The session is closed!", rootCause);216                    }217                    return new WebDriverException("The appium server has accidentally died!", rootCause);218                }).orElseGet((Supplier<WebDriverException>) () ->219                        new WebDriverException(rootCause.getMessage(), rootCause));220            }221            throwIfUnchecked(t);222            throw new WebDriverException(t);223        } finally {224            if (DriverCommand.QUIT.equals(command.getName())) {225                serviceOptional.ifPresent(DriverService::stop);226            }227        }228        if (DriverCommand.NEW_SESSION.equals(command.getName())229                && getCommandCodec() instanceof W3CHttpCommandCodec) {230            setCommandCodec(new AppiumW3CHttpCommandCodec());231            getAdditionalCommands().forEach(this::defineCommand);232        }233        return response;234    }235}...

AppiumSteps.java

Source:AppiumSteps.java

...184					public Response execute(Command command) throws WebDriverException {185						if (DriverCommand.NEW_SESSION.equals(command.getName())) {186							setCommandCodec((CommandCodec<HttpRequest>) ClassUtil.getField("commandCodec", executor));187							setResponseCodec((ResponseCodec<HttpResponse>) ClassUtil.getField("responseCodec", executor));188							getAdditionalCommands().forEach(this::defineCommand);189							Response response = new Response(((QAFExtendedWebDriver) driver).getSessionId());190							response.setValue(JSONUtil.toMap(JSONUtil.toString(capabilities.asMap())));191							response.setStatus(ErrorCodes.SUCCESS);192							response.setState(ErrorCodes.SUCCESS_STRING);193							return response;194						} else {195							return super.execute(command);196						}197					}198				};199				if (capabilities.getPlatform().is(Platform.ANDROID)) {200					return new AndroidDriver<WebElement>(appiumCommandExecutor, capabilities);201				}202				if (capabilities.getPlatform().is(Platform.IOS)) {...

EventFiringAppiumCommandExecutor.java

Source:EventFiringAppiumCommandExecutor.java

...96        } catch (NoSuchFieldException | IllegalAccessException e) {97            throw new WebDriverException(e);98        }99    }100    private Map<String, CommandInfo> getAdditionalCommands() {101        // noinspection unchecked102        return getPrivateFieldValue("additionalCommands", Map.class);103    }104    private CommandCodec<HttpRequest> getCommandCodec() {105        // noinspection unchecked106        return getPrivateFieldValue("commandCodec", CommandCodec.class);107    }108    private void setCommandCodec(CommandCodec<HttpRequest> newCodec) {109        setPrivateFieldValue("commandCodec", newCodec);110    }111    @Override112    public Response execute(Command command) throws WebDriverException {113        if (DriverCommand.NEW_SESSION.equals(command.getName())) {114            serviceOptional.ifPresent(driverService -> {115                try {116                    driverService.start();117                } catch (IOException e) {118                    throw new WebDriverException(e.getMessage(), e);119                }120            });121        }122        Response response;123        try {124            for (IDriverCommandListener listener : listeners) {125                listener.beforeEvent(command);126            }127            response = super.execute(command);128            for (IDriverCommandListener listener : listeners) {129                listener.afterEvent(command);130            }131        } catch (Throwable t) {132            Throwable rootCause = Throwables.getRootCause(t);133            if (rootCause instanceof ConnectException134                    && rootCause.getMessage().contains("Connection refused")) {135                throw serviceOptional.map(service -> {136                    if (service.isRunning()) {137                        return new WebDriverException("The session is closed!", rootCause);138                    }139                    return new WebDriverException("The appium server has accidentally died!", rootCause);140                }).orElseGet((Supplier<WebDriverException>) () -> new WebDriverException(rootCause.getMessage(), rootCause));141            }142            // [VD] never enable throwIfUnchecked as it generates RuntimeException and corrupt TestNG main thread!   143            // throwIfUnchecked(t);144            throw new WebDriverException(t);145        } finally {146            if (DriverCommand.QUIT.equals(command.getName())) {147                serviceOptional.ifPresent(DriverService::stop);148            }149        }150        if (DriverCommand.NEW_SESSION.equals(command.getName())151                && getCommandCodec() instanceof W3CHttpCommandCodec) {152            setCommandCodec(new AppiumW3CHttpCommandCodec());153            getAdditionalCommands().forEach(this::defineCommand);154        }155        return response;156    }157    public List<IDriverCommandListener> getListeners() {158        return listeners;159    }160    public void setListeners(List<IDriverCommandListener> listeners) {161        this.listeners = listeners;162    }163}...

CustomAppiumCommandExecutor.java

Source:CustomAppiumCommandExecutor.java

...82        }83        DriverHelper.setPrivateFieldValue(this, FIELD_COMMAND_CODEC, commandCodec);84        DriverHelper.setPrivateFieldValue(this, FIELD_RESPONSE_CODEC,85                agentClient.getSession().getDialect().getResponseCodec());86        getAdditionalCommands().forEach(this::defineCommand);87    }88    @Override89    public Response execute(final Command command) throws WebDriverException {90        return execute(command, false);91    }92    /**93     * Extended command execution method.94     * Allows skipping reporting for "internal" commands, for example:95     * - Taking screenshot for manual step reporting.96     * - Inspecting element type to determine whether redaction is required.97     * @param command       Command to execute98     * @param skipReporting Flag to control reporting99     * @return Command execution response.100     */...

getAdditionalCommands

Using AI Code Generation

1import io.appium.java_client.remote.AppiumCommandExecutor;2import org.openqa.selenium.remote.CommandInfo;3import org.openqa.selenium.remote.HttpCommandExecutor;4import org.openqa.selenium.remote.Response;5import java.net.URL;6import java.util.Map;7public class AppiumCommandExecutorTest {8    public static void main(String[] args) {9        try {

getAdditionalCommands

Using AI Code Generation

1package com.appium;2import java.io.IOException;3import java.net.URL;4import java.util.List;5import org.openqa.selenium.remote.CommandInfo;6import org.openqa.selenium.remote.HttpCommandExecutor;7import org.openqa.selenium.remote.Response;8import io.appium.java_client.remote.AppiumCommandExecutor;9import io.appium.java_client.remote.AppiumCommandExecutor.Command;10public class GetAdditionalCommands {11public static void main(String[] args) throws IOException {

getAdditionalCommands

Using AI Code Generation

1package appium;2import java.net.URL;3import java.util.List;4import java.util.Map;5import org.openqa.selenium.WebDriverException;6import org.openqa.selenium.remote.DesiredCapabilities;7import org.openqa.selenium.remote.HttpCommandExecutor;8import org.openqa.selenium.remote.Response;9import io.appium.java_client.remote.AppiumCommandExecutor;10import io.appium.java_client.remote.AppiumCommandExecutor.CommandInfo;11public class AppiumJavaClient {12	public static void main(String[] args) {13		try {14			DesiredCapabilities cap = new DesiredCapabilities();15			cap.setCapability("deviceName", "Nexus 5");16			cap.setCapability("platformName", "Android");17			cap.setCapability("platformVersion", "5.1");18			cap.setCapability("appPackage", "com.android.calculator2");19			cap.setCapability("appActivity", "com.android.calculator2.Calculator");20			cap.setCapability("appium-version", "1.3.7");21			cap.setCapability("automationName", "Appium");22			cap.setCapability("noReset", true);23			cap.setCapability("fullReset", false);

getAdditionalCommands

Using AI Code Generation

1package appium;2import java.io.IOException;3import java.util.Set;4import org.openqa.selenium.remote.Response;5import io.appium.java_client.remote.AppiumCommandExecutor;6public class GetAdditionalCommands {7	public static void main(String[] args) throws IOException {

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.