us.johnmeyer.sitetest.credentials

Enum BrowserstackCredential.Mode

java.lang.Object

java.lang.Enum<BrowserstackCredential.Mode>

us.johnmeyer.sitetest.credentials.BrowserstackCredential.Mode

All Implemented Interfaces:

Serializable, Comparable<BrowserstackCredential.Mode>

Enclosing class:

BrowserstackCredential

public static enum BrowserstackCredential.Mode
extends Enum<BrowserstackCredential.Mode>

Enumeration enumerates supported ways to retrieve credential. Set the governing mode in constant BrowserstackCredential.DEFAULT_RETRIEVAL_MODE.

If viewing javadocs in a browser, click on the "Enum Constants" (enumeration members) to see details on how to use the mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
API For testing factory API call only.
CONSOLE_PROMPT Credential is requested at runtime via console.
DEFAULT Use default retrieval mode as hardcoded in BrowserstackCredential.java.
EMPTY For testing prompting only.
LOCAL_FILE Retrieve credential from a local file.
SOURCE_CONSTANT Credential is assigned inline in the code.

Method Summary

Modifier and Type	Method and Description
static BrowserstackCredential.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BrowserstackCredential.Mode[]	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

LOCAL_FILE

public static final BrowserstackCredential.Mode LOCAL_FILE

Retrieve credential from a local file. Credential is stored in {code}.bsc{/code} file in home directory. This is the default option. To use this option, create a file .bsc in the home directory with the following 2 lines:

  username = xxxxxxxxxxx
  automateKey = xxxxxxxxxxxxxxxxxxxxx
  

Replace the x's with the credentials supplied by Browserstack's Automate site.

See Also:

readme.

CONSOLE_PROMPT

public static final BrowserstackCredential.Mode CONSOLE_PROMPT

Credential is requested at runtime via console. Note: Does not work with Maven.

SOURCE_CONSTANT

public static final BrowserstackCredential.Mode SOURCE_CONSTANT

Credential is assigned inline in the code. Update the constants to provide the information.

DO NOT PUSH SOURCE OR COMPILED COMPONENTS TO ANY PUBLIC DATA STORE (GITHUB, S3, Google Drive, Dropbox, etc.) AFTER DEFINING CREDENTIALS INLINE.

Credential assignments are found in the code at: BrowserstackCredentialSecrets.CONSTANT_AUTOMATE_KEY and BrowserstackCredentialSecrets.CONSTANT_USER_NAME.

EMPTY

public static final BrowserstackCredential.Mode EMPTY

For testing prompting only.

API

public static final BrowserstackCredential.Mode API

For testing factory API call only.

DEFAULT

public static final BrowserstackCredential.Mode DEFAULT

Use default retrieval mode as hardcoded in BrowserstackCredential.java.

Method Detail

values

public static BrowserstackCredential.Mode[] 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 (BrowserstackCredential.Mode c : BrowserstackCredential.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BrowserstackCredential.Mode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null