Enum GeneralServerFlag

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALLOW_INSECURE
      Allow a list of features which are considered insecure and must be turned on explicitly by system administrators.
      ASYNC_TRACE
      Add long stack traces to log entries.
      BASEPATH
      Base path to use as the prefix for all webdriver routes running on this server.
      CALLBACK_ADDRESS
      callback IP Address (default: same as address).
      CALLBACK_PORT
      callback port (default: same as port).
      CONFIGURATION_FILE
      Configuration JSON file to register Appium with selenium grid.
      DEBUG_LOG_SPACING
      Add exaggerated spacing in logs to help with visual inspection.
      DENY_INSECURE
      Specify a list of features which will never be allowed to run, even if --relaxed-security is turned on, and even if feature names are listed with --allow-insecure.
      DRIVERARGS
      Set the default desired client arguments for a driver.
      DRIVERS
      A comma-separated list of installed driver names that should be active for this server.
      ENABLE_HEAP_DUMP
      Enables NodeJS memory dumps collection feature.
      LOCAL_TIMEZONE
      Use local timezone for timestamps.
      LOG_LEVEL
      The message log level to be shown.
      LOG_NO_COLORS
      Don’t use colors in console output.
      LOG_TIMESTAMP
      Show timestamps in console output.
      NO_PERMS_CHECKS
      Bypass Appium’s checks to ensure we can read/write necessary files.
      PLUGINARGS
      Set the default desired client arguments for a plugin.
      PLUGINS
      Plugins are little programs which can be added to an Appium installation and activated, for the purpose of extending or modifying the behavior of pretty much any aspect of Appium.
      PRE_LAUNCH
      Pre-launch the application before allowing the first session (Requires –app and, for Android, –app-pkg and –app-activity).
      RELAXED_SECURITY
      Disable additional security checks.
      ROBOT_ADDRESS
      IP Address of robot.
      ROBOT_PORT
      Port for robot.
      SESSION_OVERRIDE
      Enables session override (clobbering).
      SHELL
      Enter REPL mode.
      SHOW_CONFIG
      Show info about the Appium server configuration and exit.
      STRICT_CAPS
      Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device.
      TEMP_DIRECTORY
      Absolute path to directory Appium can use to manage temporary files, like built-in iOS apps it needs to move around.
      WEB_HOOK
      Also send log output to this HTTP listener.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getArgument()  
      static GeneralServerFlag valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static GeneralServerFlag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • CALLBACK_ADDRESS

        public static final GeneralServerFlag CALLBACK_ADDRESS
        callback IP Address (default: same as address). Sample: --callback-address 127.0.0.1
      • CALLBACK_PORT

        public static final GeneralServerFlag CALLBACK_PORT
        callback port (default: same as port). Sample: --callback-port 4723
      • SESSION_OVERRIDE

        public static final GeneralServerFlag SESSION_OVERRIDE
        Enables session override (clobbering). Default: false
      • PRE_LAUNCH

        public static final GeneralServerFlag PRE_LAUNCH
        Pre-launch the application before allowing the first session (Requires –app and, for Android, –app-pkg and –app-activity). Default: false
      • LOG_LEVEL

        public static final GeneralServerFlag LOG_LEVEL
        The message log level to be shown. Sample: --log-level debug
      • LOG_TIMESTAMP

        public static final GeneralServerFlag LOG_TIMESTAMP
        Show timestamps in console output. Default: false
      • LOCAL_TIMEZONE

        public static final GeneralServerFlag LOCAL_TIMEZONE
        Use local timezone for timestamps. Default: false
      • LOG_NO_COLORS

        public static final GeneralServerFlag LOG_NO_COLORS
        Don’t use colors in console output. Default: false
      • WEB_HOOK

        public static final GeneralServerFlag WEB_HOOK
        Also send log output to this HTTP listener. Sample: --webhook localhost:9876
      • CONFIGURATION_FILE

        public static final GeneralServerFlag CONFIGURATION_FILE
        Configuration JSON file to register Appium with selenium grid. Sample: --nodeconfig /abs/path/to/nodeconfig.json
      • ROBOT_ADDRESS

        public static final GeneralServerFlag ROBOT_ADDRESS
        IP Address of robot. Sample: --robot-address 0.0.0.0
      • ROBOT_PORT

        public static final GeneralServerFlag ROBOT_PORT
        Port for robot. Sample: --robot-port 4242
      • SHOW_CONFIG

        public static final GeneralServerFlag SHOW_CONFIG
        Show info about the Appium server configuration and exit. Default: false
      • NO_PERMS_CHECKS

        public static final GeneralServerFlag NO_PERMS_CHECKS
        Bypass Appium’s checks to ensure we can read/write necessary files. Default: false
      • STRICT_CAPS

        public static final GeneralServerFlag STRICT_CAPS
        Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device. Default: false
      • TEMP_DIRECTORY

        public static final GeneralServerFlag TEMP_DIRECTORY
        Absolute path to directory Appium can use to manage temporary files, like built-in iOS apps it needs to move around. On *nix/Mac defaults to /tmp, on Windows defaults to C:\Windows\Temp.
      • DEBUG_LOG_SPACING

        public static final GeneralServerFlag DEBUG_LOG_SPACING
        Add exaggerated spacing in logs to help with visual inspection. Default: false
      • ASYNC_TRACE

        public static final GeneralServerFlag ASYNC_TRACE
        Add long stack traces to log entries. Recommended for debugging only. Default: false
      • RELAXED_SECURITY

        public static final GeneralServerFlag RELAXED_SECURITY
        Disable additional security checks. Only enable it if all the clients are in the trusted network. Default: false
      • ENABLE_HEAP_DUMP

        public static final GeneralServerFlag ENABLE_HEAP_DUMP
        Enables NodeJS memory dumps collection feature.
      • ALLOW_INSECURE

        public static final GeneralServerFlag ALLOW_INSECURE
        Allow a list of features which are considered insecure and must be turned on explicitly by system administrators. Default: [] Sample: --allow-insecure=foo,bar
      • DENY_INSECURE

        public static final GeneralServerFlag DENY_INSECURE
        Specify a list of features which will never be allowed to run, even if --relaxed-security is turned on, and even if feature names are listed with --allow-insecure. Default: [] Sample: --deny-insecure=foo,bar
      • PLUGINS

        public static final GeneralServerFlag PLUGINS
        Plugins are little programs which can be added to an Appium installation and activated, for the purpose of extending or modifying the behavior of pretty much any aspect of Appium. Plugins are available with Appium as of Appium 2.0. To activate all plugins, you can use the single string "all" as the value (e.g --plugins=all) Default: [] Sample: --plugins=device-farm,images
      • DRIVERS

        public static final GeneralServerFlag DRIVERS
        A comma-separated list of installed driver names that should be active for this server. All drivers will be active by default. Default: [] Sample: --drivers=uiautomator2,xcuitest
      • BASEPATH

        public static final GeneralServerFlag BASEPATH
        Base path to use as the prefix for all webdriver routes running on this server. Sample: --base-path=/wd/hub
      • PLUGINARGS

        public static final GeneralServerFlag PLUGINARGS
        Set the default desired client arguments for a plugin. Default: [] Sample: [ '{"images":{"foo1": "bar1", "foo2": "bar2"}}' | /path/to/pluginArgs.json ]
      • DRIVERARGS

        public static final GeneralServerFlag DRIVERARGS
        Set the default desired client arguments for a driver. Default: [] Sample: [ '{"xcuitest": {"foo1": "bar1", "foo2": "bar2"}}' | /path/to/driverArgs.json ]
    • Method Detail

      • values

        public static GeneralServerFlag[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (GeneralServerFlag c : GeneralServerFlag.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static GeneralServerFlag valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null