AtsSystemProperties (ATS-CommonLibrary 4.0.2 API)

java.lang.Object
- com.axway.ats.common.systemproperties.AtsSystemProperties

```
public class AtsSystemProperties
extends Object
```
This class is used as a central place for working with ATS related system properties. It is good if all such system properties are prefixed with "ats."

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AGENT__COMPONENTS_FOLDER`
`static String`	`AGENT__MONITOR_INITIAL_POLL_DELAY`
`static String`	`AGENT__MONITOR_POLL_INTERVAL`
`static String`	`AGENT__REGISTER_FULL_AND_NET_ACTION_TIME_FOR_TEMPLATE_ACTIONS_KEY`
`static String`	`AGENT__TEMPLATE_ACTIONS_FOLDER`
`static String`	`AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_CONTENT`
`static String`	`AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_SIZE`
`static String`	`AGENT__TEMPLATE_ACTIONS_PROXY_PROPERTY`
`static String`	`AGENT_HOME_FOLDER`
`static String`	`CORE__JSCH_VERBOSE_MODE`
`static int`	`DEFAULT_AGENT_PORT_VALUE`
`static String`	`LOG__CLASSPATH_ON_START`
`static String`	`LOG__MONITOR_EVENTS_QUEUE`
`static String`	`SYSTEM_FILE_SEPARATOR`
`static String`	`SYSTEM_HTTP_PROXY_HOST`
`static String`	`SYSTEM_HTTP_PROXY_PORT`
`static String`	`SYSTEM_JAVA_HOME_DIR`
`static String`	`SYSTEM_LINE_SEPARATOR`
`static String`	`SYSTEM_OS_NAME`
`static String`	`SYSTEM_USER_HOME_DIR`
`static String`	`SYSTEM_USER_TEMP_DIR`
`static String`	`TEST_HARNESS__JUNIT_RUN_NAME`
`static String`	`TEST_HARNESS__TESTS_SOURCE_LOCATION`
`static String`	`UI_ENGINE__SWING_ROBOT_DELAY_BETWEEN_EVENTS`

Constructor Summary

Constructors
Constructor and Description

AtsSystemProperties()

Constructors
Constructor and Description
`AtsSystemProperties()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Integer`	`getAgentDefaultPort()`
`static Boolean`	`getPropertyAsBoolean(String key)` If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - an error is thrown If key is not found - null is returned.
`static Boolean`	`getPropertyAsBoolean(String key, Boolean defaultValue)` If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - default value is returned if provided, otherwise an error is thrown If key is not found - default value is returned if provided, otherwise null is returned.
`static Integer`	`getPropertyAsNonNegativeNumber(String key)` If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - an error is thrown If key is not found - null is returned.
`static Integer`	`getPropertyAsNonNegativeNumber(String key, Integer defaultValue)` If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - default value is returned if provided, otherwise an error is thrown If key is not found - default value is returned if provided, otherwise null is returned.
`static Integer`	`getPropertyAsNumber(String key)` Return a system property as an integer number.
`static Integer`	`getPropertyAsNumber(String key, Integer defaultValue)` Return a system property as an integer number
`static String`	`getPropertyAsString(String key)` Return a system property as a String.
`static String`	`getPropertyAsString(String key, String defaultValue)` Return a system property as a String if existing.
`static void`	`setAgentDefaultPort(int defaultAgentPort)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_AGENT_PORT_VALUE
```
public static final int DEFAULT_AGENT_PORT_VALUE
```
    See Also:
    
    Constant Field Values
  - AGENT_HOME_FOLDER
```
public static final String AGENT_HOME_FOLDER
```
    See Also:
    
    Constant Field Values
  - AGENT__MONITOR_POLL_INTERVAL
```
public static final String AGENT__MONITOR_POLL_INTERVAL
```
    See Also:
    
    Constant Field Values
  - AGENT__MONITOR_INITIAL_POLL_DELAY
```
public static final String AGENT__MONITOR_INITIAL_POLL_DELAY
```
    See Also:
    
    Constant Field Values
  - AGENT__COMPONENTS_FOLDER
```
public static final String AGENT__COMPONENTS_FOLDER
```
    See Also:
    
    Constant Field Values
  - AGENT__TEMPLATE_ACTIONS_PROXY_PROPERTY
```
public static final String AGENT__TEMPLATE_ACTIONS_PROXY_PROPERTY
```
    See Also:
    
    Constant Field Values
  - AGENT__REGISTER_FULL_AND_NET_ACTION_TIME_FOR_TEMPLATE_ACTIONS_KEY
```
public static final String AGENT__REGISTER_FULL_AND_NET_ACTION_TIME_FOR_TEMPLATE_ACTIONS_KEY
```
    See Also:
    
    Constant Field Values
  - AGENT__TEMPLATE_ACTIONS_FOLDER
```
public static final String AGENT__TEMPLATE_ACTIONS_FOLDER
```
    See Also:
    
    Constant Field Values
  - AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_SIZE
```
public static final String AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_SIZE
```
    See Also:
    
    Constant Field Values
  - AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_CONTENT
```
public static final String AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_CONTENT
```
    See Also:
    
    Constant Field Values
  - LOG__MONITOR_EVENTS_QUEUE
```
public static final String LOG__MONITOR_EVENTS_QUEUE
```
    See Also:
    
    Constant Field Values
  - LOG__CLASSPATH_ON_START
```
public static final String LOG__CLASSPATH_ON_START
```
    See Also:
    
    Constant Field Values
  - TEST_HARNESS__JUNIT_RUN_NAME
```
public static final String TEST_HARNESS__JUNIT_RUN_NAME
```
    See Also:
    
    Constant Field Values
  - TEST_HARNESS__TESTS_SOURCE_LOCATION
```
public static final String TEST_HARNESS__TESTS_SOURCE_LOCATION
```
    See Also:
    
    Constant Field Values
  - UI_ENGINE__SWING_ROBOT_DELAY_BETWEEN_EVENTS
```
public static final String UI_ENGINE__SWING_ROBOT_DELAY_BETWEEN_EVENTS
```
    See Also:
    
    Constant Field Values
  - CORE__JSCH_VERBOSE_MODE
```
public static final String CORE__JSCH_VERBOSE_MODE
```
    See Also:
    
    Constant Field Values
  - SYSTEM_LINE_SEPARATOR
```
public static final String SYSTEM_LINE_SEPARATOR
```
  - SYSTEM_FILE_SEPARATOR
```
public static final String SYSTEM_FILE_SEPARATOR
```
  - SYSTEM_OS_NAME
```
public static final String SYSTEM_OS_NAME
```
  - SYSTEM_USER_HOME_DIR
```
public static final String SYSTEM_USER_HOME_DIR
```
  - SYSTEM_USER_TEMP_DIR
```
public static final String SYSTEM_USER_TEMP_DIR
```
  - SYSTEM_JAVA_HOME_DIR
```
public static final String SYSTEM_JAVA_HOME_DIR
```
  - SYSTEM_HTTP_PROXY_HOST
```
public static final String SYSTEM_HTTP_PROXY_HOST
```
  - SYSTEM_HTTP_PROXY_PORT
```
public static final String SYSTEM_HTTP_PROXY_PORT
```
- Constructor Detail
  - AtsSystemProperties
```
public AtsSystemProperties()
```
- Method Detail
  - getAgentDefaultPort
```
public static Integer getAgentDefaultPort()
```
    Returns:
    
    the default ATS agent port number
  - setAgentDefaultPort
```
public static void setAgentDefaultPort(int defaultAgentPort)
```
    Parameters:
    
    defaultAgentPort - the new default ATS agent port number
  - getPropertyAsNumber
```
public static Integer getPropertyAsNumber(String key)
```
    Return a system property as an integer number. Return null if key is not present. Throw an exception if value is invalid
    
    Parameters:
    
    key - the name of the searched system property
    
    Returns:
    
    a number
  - getPropertyAsNumber
```
public static Integer getPropertyAsNumber(String key,
                                          Integer defaultValue)
```
    Return a system property as an integer number
    
    Parameters:
    
    key - the name of the searched system property
    
    defaultValue - default value in case the system property does not exist or is invalid
    
    Returns:
    
    a number
  - getPropertyAsBoolean
```
public static Boolean getPropertyAsBoolean(String key)
```
    If key is found and is parsed OK - the wanted value is returned.
    If key is found and fail parsing - an error is thrown If key is not found - null is returned.
    
    Parameters:
    
    key - the name of the searched system property
    
    Returns:
    
    a boolean value
  - getPropertyAsBoolean
```
public static Boolean getPropertyAsBoolean(String key,
                                           Boolean defaultValue)
```
    If key is found and is parsed OK - the wanted value is returned.
    If key is found and fail parsing - default value is returned if provided, otherwise an error is thrown If key is not found - default value is returned if provided, otherwise null is returned.
    
    Parameters:
    
    key - the name of the searched system property
    
    defaultValue - default value in case the system property does not exist or is invalid
    
    Returns:
    
    a boolean value
  - getPropertyAsNonNegativeNumber
```
public static Integer getPropertyAsNonNegativeNumber(String key)
```
    If key is found and is parsed OK - the wanted value is returned.
    If key is found and fail parsing - an error is thrown If key is not found - null is returned.
    
    Parameters:
    
    key - the name of the searched system property
    
    Returns:
    
    a number that is 0 or above
  - getPropertyAsNonNegativeNumber
```
public static Integer getPropertyAsNonNegativeNumber(String key,
                                                     Integer defaultValue)
```
    If key is found and is parsed OK - the wanted value is returned.
    If key is found and fail parsing - default value is returned if provided, otherwise an error is thrown If key is not found - default value is returned if provided, otherwise null is returned.
    
    Parameters:
    
    key - the name of the searched system property
    
    defaultValue - default value in case the system property does not exist or is invalid
    
    Returns:
    
    a number that is 0 or above
  - getPropertyAsString
```
public static String getPropertyAsString(String key)
```
    Return a system property as a String. Return null if not present.
    
    Parameters:
    
    key - the name of the searched system property
    
    Returns:
  - getPropertyAsString
```
public static String getPropertyAsString(String key,
                                         String defaultValue)
```
    Return a system property as a String if existing. Otherwise return defaultValue
    
    Parameters:
    
    key - the name of the searched system property
    
    defaultValue - default value to return if property not defined
    
    Returns:

Class AtsSystemProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_AGENT_PORT_VALUE

AGENT_HOME_FOLDER

AGENT__MONITOR_POLL_INTERVAL

AGENT__MONITOR_INITIAL_POLL_DELAY

AGENT__COMPONENTS_FOLDER

AGENT__TEMPLATE_ACTIONS_PROXY_PROPERTY

AGENT__REGISTER_FULL_AND_NET_ACTION_TIME_FOR_TEMPLATE_ACTIONS_KEY

AGENT__TEMPLATE_ACTIONS_FOLDER

AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_SIZE

AGENT__TEMPLATE_ACTIONS_MATCH_FILES_BY_CONTENT

LOG__MONITOR_EVENTS_QUEUE

LOG__CLASSPATH_ON_START

TEST_HARNESS__JUNIT_RUN_NAME

TEST_HARNESS__TESTS_SOURCE_LOCATION

UI_ENGINE__SWING_ROBOT_DELAY_BETWEEN_EVENTS

CORE__JSCH_VERBOSE_MODE

SYSTEM_LINE_SEPARATOR

SYSTEM_FILE_SEPARATOR

SYSTEM_OS_NAME

SYSTEM_USER_HOME_DIR

SYSTEM_USER_TEMP_DIR

SYSTEM_JAVA_HOME_DIR

SYSTEM_HTTP_PROXY_HOST

SYSTEM_HTTP_PROXY_PORT

Constructor Detail

AtsSystemProperties

Method Detail

getAgentDefaultPort

setAgentDefaultPort

getPropertyAsNumber

getPropertyAsNumber

getPropertyAsBoolean

getPropertyAsBoolean

getPropertyAsNonNegativeNumber

getPropertyAsNonNegativeNumber

getPropertyAsString

getPropertyAsString