Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! 
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);...
AppiumNewSessionCommandPayload.java
Source:AppiumNewSessionCommandPayload.java
...22import org.openqa.selenium.remote.CommandPayload;23import java.util.Map;24import static io.appium.java_client.internal.CapabilityHelpers.APPIUM_PREFIX;25import static org.openqa.selenium.remote.DriverCommand.NEW_SESSION;26public class AppiumNewSessionCommandPayload extends CommandPayload {27 private static final AcceptedW3CCapabilityKeys ACCEPTED_W3C_PATTERNS = new AcceptedW3CCapabilityKeys();28 /**29 * Appends "appium:" prefix to all non-prefixed non-standard capabilities.30 *31 * @param possiblyInvalidCapabilities user-provided capabilities mapping.32 * @return Fixed capabilities mapping.33 */34 private static Map<String, Object> makeW3CSafe(Capabilities possiblyInvalidCapabilities) {35 return Require.nonNull("Capabilities", possiblyInvalidCapabilities)36 .asMap().entrySet().stream()37 .collect(ImmutableMap.toImmutableMap(entry -> ACCEPTED_W3C_PATTERNS.test(entry.getKey())38 ? entry.getKey()39 : APPIUM_PREFIX + entry.getKey(),40 Map.Entry::getValue));41 }42 /**43 * Overrides the default new session behavior to44 * only handle W3C capabilities.45 *46 * @param capabilities User-provided capabilities.47 */48 public AppiumNewSessionCommandPayload(Capabilities capabilities) {49 super(NEW_SESSION, ImmutableMap.of(50 "capabilities", ImmutableSet.of(makeW3CSafe(capabilities)),51 "desiredCapabilities", capabilities52 ));53 }54}
AppiumNewSessionCommandPayload
Using AI Code Generation
1import org.openqa.selenium.remote.DesiredCapabilities;2import org.openqa.selenium.remote.http.HttpClient;3import org.openqa.selenium.remote.http.HttpMethod;4import org.openqa.selenium.remote.http.HttpRequest;5import org.openqa.selenium.remote.http.HttpResponse;6import org.openqa.selenium.remote.http.HttpTransport;7import org.openqa.selenium.remote.internal.ApacheHttpClient;8import org.openqa.selenium.remote.internal.OkHttpClient;9import io.appium.java_client.remote.AppiumNewSessionCommandPayload;10import io.appium.java_client.remote.AppiumServerFlag;11import io.appium.java_client.remote.MobileCapabilityType;12import io.appium.java_client.remote.MobilePlatform;13import java.net.URL;14import java.util.HashMap;15import java.util.Map;16public class AppiumNewSessionCommandPayloadExample {17 public static void main(String[] args) throws Exception {18 DesiredCapabilities capabilities = new DesiredCapabilities();19 capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, MobilePlatform.ANDROID);20 capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");21 capabilities.setCapability(MobileCapabilityType.APP_PACKAGE, "com.example.android.contactmanager");22 capabilities.setCapability(MobileCapabilityType.APP_ACTIVITY, ".ContactManager");23 capabilities.setCapability(MobileCapabilityType.NEW_COMMAND_TIMEOUT, 60);24 Map<String, Object> optionalParams = new HashMap<>();25 optionalParams.put(AppiumServerFlag.SESSION_OVERRIDE, true);26 optionalParams.put(AppiumServerFlag.LOG_LEVEL, "error");27 AppiumNewSessionCommandPayload payload = new AppiumNewSessionCommandPayload(capabilities, optionalParams);28 HttpRequest request = payload.getHttpRequest();29 HttpTransport transport = new OkHttpClient.Factory().create();
AppiumNewSessionCommandPayload
Using AI Code Generation
1import io.appium.java_client.remote.AppiumNewSessionCommandPayload;2public class AppiumNewSessionCommandPayloadExample {3 public static void main(String[] args) {4 .builder()5 .withPlatformName("Android")6 .withPlatformVersion("7.0")7 .withDeviceName("Android Emulator")8 .withAutomationName("UiAutomator2")9 .withApp("
AppiumNewSessionCommandPayload
Using AI Code Generation
1AppiumNewSessionCommandPayload payload = new AppiumNewSessionCommandPayload();2payload.setAppiumVersion("1.7.2");3payload.setPlatformName("iOS");4payload.setPlatformVersion("11.2");5payload.setDeviceName("iPhone 8");6payload.setAutomationName("XCUITest");7payload.setApp("
AppiumNewSessionCommandPayload
Using AI Code Generation
1import io.appium.java_client.remote.AppiumCommandExecutor;2import io.appium.java_client.remote.AppiumNewSessionPayload;3import io.appium.java_client.remote.AppiumResponse;4import io.appium.java_client.remote.AppiumSessionId;5import org.openqa.selenium.remote.Response;6import java.net.MalformedURLException;7import java.net.URL;8import java.util.HashMap;9import java.util.Map;10public class AppiumNewSessionCommandPayload {11 public static void main(String[] args) throws MalformedURLException {12 Map<String, Object> params = new HashMap<>();13 params.put("platformName", "Android");14 params.put("deviceName", "emulator-5554");15 params.put("appPackage", "com.android.calculator2");16 params.put("appActivity", "com.android.calculator2.Calculator");17 AppiumNewSessionPayload appiumNewSessionPayload = new AppiumNewSessionPayload(params);
AppiumNewSessionCommandPayload
Using AI Code Generation
1import io.appium.java_client.remote.AppiumNewSessionCommandPayload;2import io.appium.java_client.remote.AndroidMobileCapabilityType;3import io.appium.java_client.remote.MobileCapabilityType;4import io.appium.java_client.remote.MobilePlatform;5import org.openqa.selenium.remote.DesiredCapabilities;6DesiredCapabilities capabilities = new DesiredCapabilities();7capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, MobilePlatform.ANDROID);8capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");9capabilities.setCapability(AndroidMobileCapabilityType.APP_PACKAGE, "com.example.android.contactmanager");10capabilities.setCapability(AndroidMobileCapabilityType.APP_ACTIVITY, ".ContactManager");11capabilities.setCapability(MobileCapabilityType.NEW_COMMAND_TIMEOUT, "60");12capabilities.setCapability(MobileCapabilityType.FULL_RESET, "true");13capabilities.setCapability(MobileCapabilityType.NO_RESET, "false");14capabilities.setCapability(MobileCapabilityType.SUPPORTS_ALERTS, "true");15capabilities.setCapability(MobileCapabilityType.SUPPORTS_JAVASCRIPT, "true");16capabilities.setCapability(MobileCapabilityType.SUPPORTS_LOCATION_CONTEXT, "true");17capabilities.setCapability(MobileCapabilityType.SUPPORTS_NETWORK_CONNECTION, "true");18capabilities.setCapability(MobileCapabilityType.SUPPORTS_REMOTE_BROWSER, "true");19capabilities.setCapability(MobileCapabilityType.SUPPORTS_SCREEN_RECORDING, "true");20capabilities.setCapability(MobileCapabilityType.SUPPORTS_WEB_STORAGE, "true");21capabilities.setCapability(MobileCapabilityType.TAKES_SCREENSHOT, "true");22AppiumNewSessionCommandPayload payload = new AppiumNewSessionCommandPayload();23payload.setPlatformName(MobilePlatform.ANDROID);24payload.setDeviceName("Android Emulator");25payload.setAppPackage("com.example.android.contactmanager");26payload.setAppActivity(".ContactManager");27payload.setNewCommandTimeout("60");28payload.setFullReset("true");29payload.setNoReset("false");30payload.setSupportsAlerts("true");31payload.setSupportsJavascript("true");32payload.setSupportsLocationContext("true");33payload.setSupportsNetworkConnection("true");34payload.setSupportsRemoteBrowser("true");35payload.setSupportsScreenRecording("true");36payload.setSupportsWebStorage("true");37payload.setTakesScreenshot("true");
AppiumNewSessionCommandPayload
Using AI Code Generation
1AppiumNewSessionCommandPayload payload = new AppiumNewSessionCommandPayload();2payload.setPlatformName("Android");3payload.setDeviceName("Android Emulator");4payload.setApp("C:\\Users\\myUser\\Downloads\\ApiDemos-debug.apk");5payload.setAutomationName("UiAutomator2");6DesiredCapabilities capabilities = new DesiredCapabilities();7capabilities.setCapability("appium:capabilities", payload);
AppiumNewSessionCommandPayload
Using AI Code Generation
1import io.appium.java_client.remote.AppiumNewSessionCommandPayload;2import java.io.IOException;3import org.openqa.selenium.remote.DesiredCapabilities;4public class AppiumNewSessionCommandPayloadExample {5 public static void main(String[] args) throws IOException {6 DesiredCapabilities capabilities = new DesiredCapabilities();7 capabilities.setCapability("platformName", "Android");8 capabilities.setCapability("app", "C:\\Users\\user\\Downloads\\selendroid-test-app-0.17.0.apk");9 capabilities.setCapability("appActivity", "io.selendroid.testapp.HomeScreenActivity");10 capabilities.setCapability("appPackage", "io.selendroid.testapp");11 capabilities.setCapability("deviceName", "emulator-5554");12 capabilities.setCapability("platformVersion", "8.0");13 capabilities.setCapability("automationName", "UiAutomator2");14 AppiumNewSessionCommandPayload payload = new AppiumNewSessionCommandPayload();15 payload.setCapabilities(capabilities);16 System.out.println(payload.toString());17 }18}19{"capabilities":{"firstMatch":[{"platformName":"Android","app":"C:\Users\user\Downloads\selendroid-test-app-0.17.0.apk","appActivity":"io.selendroid.testapp.HomeScreenActivity","appPackage":"io.selendroid.testapp","deviceName":"emulator-5554","platformVersion":"8.0","automationName":"UiAutomator2"}]}}20const { AppiumNewSessionCommandPayload } = require('appium-java-client');21const { DesiredCapabilities } = require('selenium-webdriver');22const capabilities = new DesiredCapabilities();23capabilities.set('platformName', 'Android');24capabilities.set('app', 'C:\\Users\\user\\Downloads\\selendroid-test-app-0.17.0.apk');25capabilities.set('appActivity', 'io.selendroid.testapp.HomeScreenActivity');26capabilities.set('appPackage', 'io.selendroid.testapp');27capabilities.set('deviceName', 'emulator-5554');28capabilities.set('platformVersion', '8.0');29capabilities.set('automationName', 'UiAutomator2');30const payload = new AppiumNewSessionCommandPayload();31payload.setCapabilities(capabilities);
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.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run io.appium automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
