com.epam.reportportal.utils.properties

Enum ListenerProperty

java.lang.Object

java.lang.Enum<ListenerProperty>

com.epam.reportportal.utils.properties.ListenerProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ListenerProperty>

public enum ListenerProperty
extends java.lang.Enum<ListenerProperty>

Describe properties names

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_KEY
ASYNC_REPORTING
BASE_URL ReportPortal instance URL
BATCH_PAYLOAD_LIMIT
BATCH_SIZE_LOGS
BTS_ISSUE_FAIL Fail tests marked with Issue annotation if they passed.
BTS_ISSUE_URL Bug Tracking System URL Pattern for Issues to use along with ExternalIssue annotation.
BTS_PROJECT Bug Tracking System Project name to use along with ExternalIssue annotation.
BTS_URL Bug Tracking System base URL to use along with ExternalIssue annotation.
CALLBACK_REPORTING_ENABLED
CLIENT_JOIN_LAUNCH_TIMEOUT_UNIT
CLIENT_JOIN_LAUNCH_TIMEOUT_VALUE Timeout of waiting for the Primary launch to start.
CLIENT_JOIN_LOCK_PORT
CLIENT_JOIN_LOCK_TIMEOUT_UNIT
CLIENT_JOIN_LOCK_TIMEOUT_VALUE Lock timeout.
CLIENT_JOIN_MODE Run ReportPortal client in multiple client mode.
CLIENT_JOIN_MODE_VALUE
CLIENT_JOIN_TIMEOUT_UNIT
CLIENT_JOIN_TIMEOUT_VALUE General Launch Lock timeout value.
DESCRIPTION
ENABLE
FILE_LOCK_NAME
FILE_SYNC_NAME
HTTP_CALL_TIMEOUT_UNIT
HTTP_CALL_TIMEOUT_VALUE
HTTP_CONNECT_TIMEOUT_UNIT
HTTP_CONNECT_TIMEOUT_VALUE
HTTP_LOGGING Enable / Disable raw HTTP requests logging
HTTP_PROXY_PASSWORD Password for proxy, works only if HTTP_PROXY_URL and HTTP_PROXY_USER are set
HTTP_PROXY_URL A URL of a http proxy to connect to the endpoint
HTTP_PROXY_USER A username for used proxy, works only if HTTP_PROXY_URL is set
HTTP_READ_TIMEOUT_UNIT
HTTP_READ_TIMEOUT_VALUE
HTTP_WRITE_TIMEOUT_UNIT
HTTP_WRITE_TIMEOUT_VALUE
IO_POOL_SIZE
IS_CONVERT_IMAGE
KEYSTORE_PASSWORD
KEYSTORE_RESOURCE
LAUNCH_ATTRIBUTES
LAUNCH_NAME
LAUNCH_UUID Use predefined Launch UUID.
LAUNCH_UUID_CREATION_SKIP Do not create new launch and report to predefined Launch UUID.
LAUNCH_UUID_PRINT Print Launch UUID after start in a format: `ReportPortal Launch UUID: {UUID}`.
LAUNCH_UUID_PRINT_OUTPUT Launch UUID printing stream.
MODE
PROJECT_NAME
REPORTING_TIMEOUT
RERUN
RERUN_OF
RX_BUFFER_SIZE
SKIPPED_AS_ISSUE
TRUNCATE_ATTRIBUTE_LIMIT
TRUNCATE_FIELDS
TRUNCATE_ITEM_NAME_LIMIT
TRUNCATE_REPLACEMENT
UUID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPropertyName()
boolean	isRequired()
static ListenerProperty	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ListenerProperty[]	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

BASE_URL

public static final ListenerProperty BASE_URL

ReportPortal instance URL

HTTP_PROXY_URL

public static final ListenerProperty HTTP_PROXY_URL

A URL of a http proxy to connect to the endpoint

HTTP_PROXY_USER

public static final ListenerProperty HTTP_PROXY_USER

A username for used proxy, works only if HTTP_PROXY_URL is set

HTTP_PROXY_PASSWORD

public static final ListenerProperty HTTP_PROXY_PASSWORD

Password for proxy, works only if HTTP_PROXY_URL and HTTP_PROXY_USER are set

HTTP_LOGGING

public static final ListenerProperty HTTP_LOGGING

Enable / Disable raw HTTP requests logging

HTTP_CALL_TIMEOUT_VALUE

public static final ListenerProperty HTTP_CALL_TIMEOUT_VALUE

HTTP_CALL_TIMEOUT_UNIT

public static final ListenerProperty HTTP_CALL_TIMEOUT_UNIT

HTTP_CONNECT_TIMEOUT_VALUE

public static final ListenerProperty HTTP_CONNECT_TIMEOUT_VALUE

HTTP_CONNECT_TIMEOUT_UNIT

public static final ListenerProperty HTTP_CONNECT_TIMEOUT_UNIT

HTTP_READ_TIMEOUT_VALUE

public static final ListenerProperty HTTP_READ_TIMEOUT_VALUE

HTTP_READ_TIMEOUT_UNIT

public static final ListenerProperty HTTP_READ_TIMEOUT_UNIT

HTTP_WRITE_TIMEOUT_VALUE

public static final ListenerProperty HTTP_WRITE_TIMEOUT_VALUE

HTTP_WRITE_TIMEOUT_UNIT

public static final ListenerProperty HTTP_WRITE_TIMEOUT_UNIT

PROJECT_NAME

public static final ListenerProperty PROJECT_NAME

LAUNCH_NAME

public static final ListenerProperty LAUNCH_NAME

LAUNCH_UUID

public static final ListenerProperty LAUNCH_UUID

Use predefined Launch UUID.

LAUNCH_UUID_CREATION_SKIP

public static final ListenerProperty LAUNCH_UUID_CREATION_SKIP

Do not create new launch and report to predefined Launch UUID.

LAUNCH_UUID_PRINT

public static final ListenerProperty LAUNCH_UUID_PRINT

Print Launch UUID after start in a format: `ReportPortal Launch UUID: {UUID}`.

LAUNCH_UUID_PRINT_OUTPUT

public static final ListenerProperty LAUNCH_UUID_PRINT_OUTPUT

Launch UUID printing stream. Possible values: 'stdout', 'stderr'.

UUID

public static final ListenerProperty UUID

API_KEY

public static final ListenerProperty API_KEY

BATCH_SIZE_LOGS

public static final ListenerProperty BATCH_SIZE_LOGS

BATCH_PAYLOAD_LIMIT

public static final ListenerProperty BATCH_PAYLOAD_LIMIT

LAUNCH_ATTRIBUTES

public static final ListenerProperty LAUNCH_ATTRIBUTES

DESCRIPTION

public static final ListenerProperty DESCRIPTION

IS_CONVERT_IMAGE

public static final ListenerProperty IS_CONVERT_IMAGE

KEYSTORE_RESOURCE

public static final ListenerProperty KEYSTORE_RESOURCE

KEYSTORE_PASSWORD

public static final ListenerProperty KEYSTORE_PASSWORD

REPORTING_TIMEOUT

public static final ListenerProperty REPORTING_TIMEOUT

MODE

public static final ListenerProperty MODE

ENABLE

public static final ListenerProperty ENABLE

RERUN

public static final ListenerProperty RERUN

RERUN_OF

public static final ListenerProperty RERUN_OF

ASYNC_REPORTING

public static final ListenerProperty ASYNC_REPORTING

CALLBACK_REPORTING_ENABLED

public static final ListenerProperty CALLBACK_REPORTING_ENABLED

SKIPPED_AS_ISSUE

public static final ListenerProperty SKIPPED_AS_ISSUE

IO_POOL_SIZE

public static final ListenerProperty IO_POOL_SIZE

CLIENT_JOIN_MODE

public static final ListenerProperty CLIENT_JOIN_MODE

Run ReportPortal client in multiple client mode. In such mode RC client will share one launch ID between all clients on the machine. Such build systems as Gradle forks JVMs during parallel run, that leads to multiple launches on dashboard, so using that property should allow to merge them all in one.

CLIENT_JOIN_MODE_VALUE

public static final ListenerProperty CLIENT_JOIN_MODE_VALUE

FILE_LOCK_NAME

public static final ListenerProperty FILE_LOCK_NAME

FILE_SYNC_NAME

public static final ListenerProperty FILE_SYNC_NAME

CLIENT_JOIN_LOCK_PORT

public static final ListenerProperty CLIENT_JOIN_LOCK_PORT

CLIENT_JOIN_TIMEOUT_VALUE

public static final ListenerProperty CLIENT_JOIN_TIMEOUT_VALUE

General Launch Lock timeout value. For how long the primary launch will wait for secondary launches until finish and exit.

CLIENT_JOIN_TIMEOUT_UNIT

public static final ListenerProperty CLIENT_JOIN_TIMEOUT_UNIT

CLIENT_JOIN_LOCK_TIMEOUT_VALUE

public static final ListenerProperty CLIENT_JOIN_LOCK_TIMEOUT_VALUE

Lock timeout. For how long a launch instance will try to obtain a lock.

CLIENT_JOIN_LOCK_TIMEOUT_UNIT

public static final ListenerProperty CLIENT_JOIN_LOCK_TIMEOUT_UNIT

CLIENT_JOIN_LAUNCH_TIMEOUT_VALUE

public static final ListenerProperty CLIENT_JOIN_LAUNCH_TIMEOUT_VALUE

Timeout of waiting for the Primary launch to start. If the primary launch does not start within this timeout, the secondary launch will exit.

CLIENT_JOIN_LAUNCH_TIMEOUT_UNIT

public static final ListenerProperty CLIENT_JOIN_LAUNCH_TIMEOUT_UNIT

RX_BUFFER_SIZE

public static final ListenerProperty RX_BUFFER_SIZE

TRUNCATE_FIELDS

public static final ListenerProperty TRUNCATE_FIELDS

TRUNCATE_REPLACEMENT

public static final ListenerProperty TRUNCATE_REPLACEMENT

TRUNCATE_ITEM_NAME_LIMIT

public static final ListenerProperty TRUNCATE_ITEM_NAME_LIMIT

TRUNCATE_ATTRIBUTE_LIMIT

public static final ListenerProperty TRUNCATE_ATTRIBUTE_LIMIT

BTS_PROJECT

public static final ListenerProperty BTS_PROJECT

Bug Tracking System Project name to use along with ExternalIssue annotation. Should be the same as in corresponding integration.

BTS_URL

public static final ListenerProperty BTS_URL

Bug Tracking System base URL to use along with ExternalIssue annotation. Should be the same as in corresponding integration.

BTS_ISSUE_URL

public static final ListenerProperty BTS_ISSUE_URL

Bug Tracking System URL Pattern for Issues to use along with ExternalIssue annotation. Use {issue_id} and {bts_project} placeholders to mark a place where to put Issue ID and Bug Tracking System Project name. The result URL should point on the Issue.

BTS_ISSUE_FAIL

public static final ListenerProperty BTS_ISSUE_FAIL

Fail tests marked with Issue annotation if they passed. Default value: true. Designed to not miss the moment when the issue got fixed but test is still marked by annotation.

Method Detail

values

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

Returns:

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

valueOf

public static ListenerProperty 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

getPropertyName

public java.lang.String getPropertyName()

isRequired

public boolean isRequired()