PropertyUtil (Hawkular APM::API 0.14.3.Final API)

java.lang.Object
- org.hawkular.apm.api.utils.PropertyUtil

```
public class PropertyUtil
extends Object
```
This class provides access to properties.

Author:

gbrown

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HAWKULAR_APM_AGENT_FILE_EXTENSION_WHITELIST` Comma separated list of whitelisted file extensions.
`static String`	`HAWKULAR_APM_AGENT_STATE_EXPIRY_INTERVAL` The time interval (in milliseconds) between checks for expired trace states in the agent.
`static String`	`HAWKULAR_APM_BUILDSTAMP` Property specifying the build stamp (or service version), to be used in a client-side library
`static String`	`HAWKULAR_APM_COLLECTOR_BATCHSIZE` The maximum number of traces to batch before sending to the server.
`static String`	`HAWKULAR_APM_COLLECTOR_BATCHTHREADS` The thread pool size for reporting a batch of traces to the server.
`static String`	`HAWKULAR_APM_COLLECTOR_BATCHTIME` The maximum time (in milliseconds) before sending a batch of traces to the server.
`static String`	`HAWKULAR_APM_CONFIG_REFRESH` The refresh interval to check for updates to the transaction configuration.
`static String`	`HAWKULAR_APM_CONFIG_RETRY_INTERVAL` The retry interval used by an application attempting to obtain the collector configuration.
`static String`	`HAWKULAR_APM_CORS_ACCESS_CONTROL_ALLOW_HEADERS` List of extra CORS Access-Control-Allow-Headers, this list is added to predefined list of allowed headers.
`static String`	`HAWKULAR_APM_CORS_ALLOWED_ORIGINS` List of allowed CORS origins.
`static String`	`HAWKULAR_APM_KAFKA_CONSUMER_AUTO_COMMIT_INTERVAL` The interval (in milliseconds) between consumer auto commits.
`static String`	`HAWKULAR_APM_KAFKA_CONSUMER_SESSION_TIMEOUT` The kafka consumer session timeout (in milliseconds).
`static String`	`HAWKULAR_APM_KAFKA_MAX_POLL_RECORDS` The maximum number of records to retrieve when polling a topic.
`static String`	`HAWKULAR_APM_KAFKA_POLLING_INTERVAL` The standard polling interval (in milliseconds) used by processors.
`static String`	`HAWKULAR_APM_KAFKA_PRODUCER_RETRIES` The maximum number of retries when a producer send fails.
`static String`	`HAWKULAR_APM_LOG_JUL` Client side boolean property to indicate whether to log to java.util.logging.
`static String`	`HAWKULAR_APM_LOG_LEVEL` Client side logging level.
`static String`	`HAWKULAR_APM_PASSWORD` The password to use for accessing the APM server.
`static String`	`HAWKULAR_APM_PROCESSOR_LAST_RETRY_DELAY` The interval between retrying the processing of a batch of failed events for the last time before giving up.
`static String`	`HAWKULAR_APM_PROCESSOR_MAX_RETRY_COUNT` The maximum number of retry attempts when processing a batch of events.
`static String`	`HAWKULAR_APM_PROCESSOR_RETRY_DELAY` The interval between retrying the processing of a batch of failed events.
`static String`	`HAWKULAR_APM_SERVICE_NAME` Property specifying the service name, to be used in a client-side library
`static String`	`HAWKULAR_APM_URI` The location of the APM server
`static String`	`HAWKULAR_APM_URI_PUBLISHER` If specified, the value for this property will override the HAWKULAR_APM_URI value when publishing trace fragments.
`static String`	`HAWKULAR_APM_URI_SERVICES` If specified, the value for this property will override the HAWKULAR_APM_URI value when accessing the services.
`static String`	`HAWKULAR_APM_USERNAME` The username to use for accessing the APM server.
`static String`	`HAWKULAR_PASSWORD` Password for authentication against Hawkular Services
`static String`	`HAWKULAR_TENANT`
`static String`	`HAWKULAR_URI` Location of the Hawkular Services
`static String`	`HAWKULAR_USERNAME` Username for authentication against Hawkular Services
`static String`	`KAFKA_PREFIX` The URI prefix to denote use of Kafka
`static String`	`OPENSHIFT_BUILD_NAME` Property specifying the env var name for the OpenShift build name.
`static String`	`OPENSHIFT_BUILD_NAMESPACE` Property specifying the env var name for the OpenShift build namespace.

Constructor Summary

Constructors
Constructor and Description

PropertyUtil()

Constructors
Constructor and Description
`PropertyUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getHostAddress()` This method returns the host IP address on which the application is running.
`static String`	`getHostName()` This method returns the hostname on which the application is running.
`static String`	`getKafkaZookeeper()` See `ENV_KAFKA_ZOOKEEPER`;
`static String`	`getProperty(String name)` This method returns the named property, first checking the system properties and if not found, checking the environment.
`static String`	`getProperty(String name, String def)` This method returns the named property, first checking the system properties and if not found, checking the environment.
`static boolean`	`getPropertyAsBoolean(String name)` This method returns the property as an integer value.
`static Integer`	`getPropertyAsInteger(String name)` This method returns the property as an integer value.
`static Integer`	`getPropertyAsInteger(String name, Integer def)` This method returns the property as an integer value.
`static boolean`	`hasProperty(String name)` This method determines whether a property exists, as a system property or environment variable.

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

- Field Detail
  - HAWKULAR_TENANT
```
public static final String HAWKULAR_TENANT
```
    See Also:
    
    Constant Field Values
  - HAWKULAR_URI
```
public static final String HAWKULAR_URI
```
    Location of the Hawkular Services
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_USERNAME
```
public static final String HAWKULAR_USERNAME
```
    Username for authentication against Hawkular Services
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_PASSWORD
```
public static final String HAWKULAR_PASSWORD
```
    Password for authentication against Hawkular Services
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_URI
```
public static final String HAWKULAR_APM_URI
```
    The location of the APM server
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_URI_SERVICES
```
public static final String HAWKULAR_APM_URI_SERVICES
```
    If specified, the value for this property will override the HAWKULAR_APM_URI value when accessing the services.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_URI_PUBLISHER
```
public static final String HAWKULAR_APM_URI_PUBLISHER
```
    If specified, the value for this property will override the HAWKULAR_APM_URI value when publishing trace fragments.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_USERNAME
```
public static final String HAWKULAR_APM_USERNAME
```
    The username to use for accessing the APM server.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_PASSWORD
```
public static final String HAWKULAR_APM_PASSWORD
```
    The password to use for accessing the APM server.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_CONFIG_RETRY_INTERVAL
```
public static final String HAWKULAR_APM_CONFIG_RETRY_INTERVAL
```
    The retry interval used by an application attempting to obtain the collector configuration.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_CONFIG_REFRESH
```
public static final String HAWKULAR_APM_CONFIG_REFRESH
```
    The refresh interval to check for updates to the transaction configuration.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_LOG_LEVEL
```
public static final String HAWKULAR_APM_LOG_LEVEL
```
    Client side logging level.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_LOG_JUL
```
public static final String HAWKULAR_APM_LOG_JUL
```
    Client side boolean property to indicate whether to log to java.util.logging.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_COLLECTOR_BATCHSIZE
```
public static final String HAWKULAR_APM_COLLECTOR_BATCHSIZE
```
    The maximum number of traces to batch before sending to the server.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_COLLECTOR_BATCHTIME
```
public static final String HAWKULAR_APM_COLLECTOR_BATCHTIME
```
    The maximum time (in milliseconds) before sending a batch of traces to the server.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_COLLECTOR_BATCHTHREADS
```
public static final String HAWKULAR_APM_COLLECTOR_BATCHTHREADS
```
    The thread pool size for reporting a batch of traces to the server.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_AGENT_STATE_EXPIRY_INTERVAL
```
public static final String HAWKULAR_APM_AGENT_STATE_EXPIRY_INTERVAL
```
    The time interval (in milliseconds) between checks for expired trace states in the agent.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_AGENT_FILE_EXTENSION_WHITELIST
```
public static final String HAWKULAR_APM_AGENT_FILE_EXTENSION_WHITELIST
```
    Comma separated list of whitelisted file extensions. All others will be ignored by the agent.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_PROCESSOR_MAX_RETRY_COUNT
```
public static final String HAWKULAR_APM_PROCESSOR_MAX_RETRY_COUNT
```
    The maximum number of retry attempts when processing a batch of events.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_PROCESSOR_RETRY_DELAY
```
public static final String HAWKULAR_APM_PROCESSOR_RETRY_DELAY
```
    The interval between retrying the processing of a batch of failed events.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_PROCESSOR_LAST_RETRY_DELAY
```
public static final String HAWKULAR_APM_PROCESSOR_LAST_RETRY_DELAY
```
    The interval between retrying the processing of a batch of failed events for the last time before giving up.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_KAFKA_POLLING_INTERVAL
```
public static final String HAWKULAR_APM_KAFKA_POLLING_INTERVAL
```
    The standard polling interval (in milliseconds) used by processors.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_KAFKA_MAX_POLL_RECORDS
```
public static final String HAWKULAR_APM_KAFKA_MAX_POLL_RECORDS
```
    The maximum number of records to retrieve when polling a topic.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_KAFKA_PRODUCER_RETRIES
```
public static final String HAWKULAR_APM_KAFKA_PRODUCER_RETRIES
```
    The maximum number of retries when a producer send fails.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_KAFKA_CONSUMER_AUTO_COMMIT_INTERVAL
```
public static final String HAWKULAR_APM_KAFKA_CONSUMER_AUTO_COMMIT_INTERVAL
```
    The interval (in milliseconds) between consumer auto commits.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_KAFKA_CONSUMER_SESSION_TIMEOUT
```
public static final String HAWKULAR_APM_KAFKA_CONSUMER_SESSION_TIMEOUT
```
    The kafka consumer session timeout (in milliseconds).
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_CORS_ALLOWED_ORIGINS
```
public static final String HAWKULAR_APM_CORS_ALLOWED_ORIGINS
```
    List of allowed CORS origins.
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_CORS_ACCESS_CONTROL_ALLOW_HEADERS
```
public static final String HAWKULAR_APM_CORS_ACCESS_CONTROL_ALLOW_HEADERS
```
    List of extra CORS Access-Control-Allow-Headers, this list is added to predefined list of allowed headers.
    
    See Also:
    
    Constant Field Values
  - KAFKA_PREFIX
```
public static final String KAFKA_PREFIX
```
    The URI prefix to denote use of Kafka
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_SERVICE_NAME
```
public static final String HAWKULAR_APM_SERVICE_NAME
```
    Property specifying the service name, to be used in a client-side library
    
    See Also:
    
    Constant Field Values
  - HAWKULAR_APM_BUILDSTAMP
```
public static final String HAWKULAR_APM_BUILDSTAMP
```
    Property specifying the build stamp (or service version), to be used in a client-side library
    
    See Also:
    
    Constant Field Values
  - OPENSHIFT_BUILD_NAME
```
public static final String OPENSHIFT_BUILD_NAME
```
    Property specifying the env var name for the OpenShift build name.
    
    See Also:
    
    Constant Field Values
  - OPENSHIFT_BUILD_NAMESPACE
```
public static final String OPENSHIFT_BUILD_NAMESPACE
```
    Property specifying the env var name for the OpenShift build namespace.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PropertyUtil
```
public PropertyUtil()
```
- Method Detail
  - hasProperty
```
public static boolean hasProperty(String name)
```
    This method determines whether a property exists, as a system property or environment variable.
    
    Parameters:
    
    name - The name
    
    Returns:
    
    Whether the property has been defined
  - getProperty
```
public static String getProperty(String name)
```
    This method returns the named property, first checking the system properties and if not found, checking the environment.
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The property, or null if not found
  - getProperty
```
public static String getProperty(String name,
                                 String def)
```
    This method returns the named property, first checking the system properties and if not found, checking the environment.
    
    Parameters:
    
    name - The name
    
    def - The default if not found
    
    Returns:
    
    The property, or the default value if not found
  - getPropertyAsInteger
```
public static Integer getPropertyAsInteger(String name)
```
    This method returns the property as an integer value.
    
    Parameters:
    
    name - The property name
    
    Returns:
    
    The property as an integer, or null if not found
  - getPropertyAsInteger
```
public static Integer getPropertyAsInteger(String name,
                                           Integer def)
```
    This method returns the property as an integer value.
    
    Parameters:
    
    name - The property name
    
    def - The optional default value
    
    Returns:
    
    The property as an integer, or null if not found
  - getPropertyAsBoolean
```
public static boolean getPropertyAsBoolean(String name)
```
    This method returns the property as an integer value.
    
    Returns:
    
    The property as a boolean, or false if not found
  - getHostName
```
public static String getHostName()
```
    This method returns the hostname on which the application is running.
    
    Returns:
    
    The host name
  - getHostAddress
```
public static String getHostAddress()
```
    This method returns the host IP address on which the application is running.
    
    Returns:
    
    The host IP address
  - getKafkaZookeeper
```
public static String getKafkaZookeeper()
```
    See ENV_KAFKA_ZOOKEEPER;

Class PropertyUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HAWKULAR_TENANT

HAWKULAR_URI

HAWKULAR_USERNAME

HAWKULAR_PASSWORD

HAWKULAR_APM_URI

HAWKULAR_APM_URI_SERVICES

HAWKULAR_APM_URI_PUBLISHER

HAWKULAR_APM_USERNAME

HAWKULAR_APM_PASSWORD

HAWKULAR_APM_CONFIG_RETRY_INTERVAL

HAWKULAR_APM_CONFIG_REFRESH

HAWKULAR_APM_LOG_LEVEL

HAWKULAR_APM_LOG_JUL

HAWKULAR_APM_COLLECTOR_BATCHSIZE

HAWKULAR_APM_COLLECTOR_BATCHTIME

HAWKULAR_APM_COLLECTOR_BATCHTHREADS

HAWKULAR_APM_AGENT_STATE_EXPIRY_INTERVAL

HAWKULAR_APM_AGENT_FILE_EXTENSION_WHITELIST

HAWKULAR_APM_PROCESSOR_MAX_RETRY_COUNT

HAWKULAR_APM_PROCESSOR_RETRY_DELAY

HAWKULAR_APM_PROCESSOR_LAST_RETRY_DELAY

HAWKULAR_APM_KAFKA_POLLING_INTERVAL

HAWKULAR_APM_KAFKA_MAX_POLL_RECORDS

HAWKULAR_APM_KAFKA_PRODUCER_RETRIES

HAWKULAR_APM_KAFKA_CONSUMER_AUTO_COMMIT_INTERVAL

HAWKULAR_APM_KAFKA_CONSUMER_SESSION_TIMEOUT

HAWKULAR_APM_CORS_ALLOWED_ORIGINS

HAWKULAR_APM_CORS_ACCESS_CONTROL_ALLOW_HEADERS

KAFKA_PREFIX

HAWKULAR_APM_SERVICE_NAME

HAWKULAR_APM_BUILDSTAMP

OPENSHIFT_BUILD_NAME

OPENSHIFT_BUILD_NAMESPACE

Constructor Detail

PropertyUtil

Method Detail

hasProperty

getProperty

getProperty

getPropertyAsInteger

getPropertyAsInteger

getPropertyAsBoolean

getHostName

getHostAddress

getKafkaZookeeper