DriverProperties (Decision Server Insights Java API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<java.lang.Object,java.lang.Object>
  - - java.util.Properties
    - - com.ibm.ia.testdriver.DriverProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>
```
public class DriverProperties
extends java.util.Properties
```
DriverProperties is a class of static methods and field constants used to manage the properties required by TestDriver.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADMIN_PASSWORD` property representing the administrator password required for authentication.
`static java.lang.String`	`ADMIN_USERNAME` property representing the administrator user name required for authentication.
`static java.lang.String`	`CATALOG_SERVER_ENDPOINTS` property representing the list of WebSphere Extreme Scale catalog servers.
`static java.lang.String`	`CONNECT_TIMEOUT` property representing the number of seconds that a connect call will retry.
`static java.lang.String`	`CONNECTION_FACTORY` property to define what client server communication environment should be used.
`static java.lang.String`	`DEBUG_AGENT_LIST` property representing the agents from which debugInfo objects will be captured.
`static java.lang.String`	`DEBUG_MAX_EVENTQUEUE_SIZE` property used by the IADebugReceiver implementation representing the maximum size of the debugInfo cache.
`static java.lang.String`	`DEBUG_NOTE` This property is a String that will be passed to the runtime server.
`static java.lang.String`	`DEBUG_SERVERS` property representing the list of servers from which to receive debugInfo objects.
`static java.lang.String`	`DEBUG_SERVERS_TIMEOUT` property representing the time to wait for communications to be established to all servers listed in the "debugservers" property.
`static int`	`DEFAULT_CONNECT_TIMEOUT`
`static int`	`DEFAULT_DEBUG_SERVERS_TIMEOUT`
`static java.lang.String`	`DEFAULT_HOSTNAME`
`static java.lang.String`	`DEFAULT_HTTPPORT_STRING`
`static java.lang.String`	`DEFAULT_MAX_QUEUE_SIZE`
`static java.lang.String`	`DISABLE_SSL_HOSTNAME_VERIFICATION` property to allow the disabling of hostname verification
`static java.lang.String`	`GRID_PASSWORD` A property representing the password required for authentication.
`static java.lang.String`	`GRID_SECURITY_ENABLED` A property representing whether or Insights grid security is enabled.
`static java.lang.String`	`GRID_USERNAME` A property representing the user name required for grid authentication.
`static java.lang.String`	`HTTP_PORT` property representing the port used for http and jmx communications.
`static java.lang.String`	`HTTP_TIMEOUT`
`static java.lang.String`	`LOAD_ENTITIES_BATCH_SIZE` A property representing the maximum batch size when loading entities via the loadEntities(Iterator) method.
`static int`	`LOAD_ENTITIES_BATCH_SIZE_DEFAULT`
`static java.lang.String`	`RUNTIME_HOST_NAME` property representing the hostname of a runtime server.
`static java.lang.String`	`SOLUTION_NAME` property representing the solution to which the TestDriver instance will attach.
`static java.lang.String`	`SSL_PROTOCOL` property representing the protocol used for secure connections
`static java.lang.String`	`SUBMIT_EVENTS_RETRY_LIMIT` A property representing the number of retry attempts that will be made to submit an event by the submitEvents() method before the submission is considered a failure.
`static int`	`SUBMIT_EVENTS_RETRY_LIMIT_DEFAULT`
`static java.lang.String`	`SUBMIT_EVENTS_RETRY_WAIT` a property representing the time period, in milliseconds, between event submission retry attempts within the submitEvents() method.
`static int`	`SUBMIT_EVENTS_RETRY_WAIT_DEFAULT`
`static java.lang.String`	`TESTDRIVER_HOME` an environment variable which points to a directory on the file system.
`static java.lang.String`	`TESTDRIVER_LOGLEVEL` a property representing the log level : valid values are OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST.
`static java.lang.String`	`TESTDRIVER_PROPS` name of the properties file containing the various TestDriver properties.
`static java.lang.String`	`TRUSTSTORE_PASSWORD` property representing the truststore passsword required for authentication.
`static java.lang.String`	`TRUSTSTORE_PATH` property representing the truststore path required for authentication.

Fields inherited from class java.util.Properties
defaults

Constructor Summary

Constructors
Constructor and Description

DriverProperties()
Initialize the TestDriver properties from the testdriver.properties file.

Constructors
Constructor and Description
`DriverProperties()` Initialize the TestDriver properties from the testdriver.properties file.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDefaultProperty(java.lang.String _property)`
`java.lang.String`	`getProperty(java.lang.String key)`
`java.lang.String`	`getProperty(java.lang.String key, java.lang.String def)`
`void`	`setDefaults()` Set the properties with appropriate defaults.
`java.lang.Object`	`setProperty(java.lang.String key, java.lang.String value)`

Methods inherited from class java.util.Properties
list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_HOSTNAME
```
public static java.lang.String DEFAULT_HOSTNAME
```
  - DEFAULT_HTTPPORT_STRING
```
public static java.lang.String DEFAULT_HTTPPORT_STRING
```
  - DEFAULT_CONNECT_TIMEOUT
```
public static int DEFAULT_CONNECT_TIMEOUT
```
  - DEFAULT_DEBUG_SERVERS_TIMEOUT
```
public static int DEFAULT_DEBUG_SERVERS_TIMEOUT
```
  - DEFAULT_MAX_QUEUE_SIZE
```
public static java.lang.String DEFAULT_MAX_QUEUE_SIZE
```
  - SOLUTION_NAME
```
public static final java.lang.String SOLUTION_NAME
```
    property representing the solution to which the TestDriver instance will attach. This property must be specified.
    
    See Also:
    Constant Field Values
  - RUNTIME_HOST_NAME
```
public static final java.lang.String RUNTIME_HOST_NAME
```
    property representing the hostname of a runtime server. If not set, a default of "localhost" is used.
    
    See Also:
    Constant Field Values
  - HTTP_PORT
```
public static final java.lang.String HTTP_PORT
```
    property representing the port used for http and jmx communications. If not set, a default of "9443" is used.
    
    See Also:
    Constant Field Values
  - ADMIN_USERNAME
```
public static final java.lang.String ADMIN_USERNAME
```
    property representing the administrator user name required for authentication.
    
    See Also:
    Constant Field Values
  - ADMIN_PASSWORD
```
public static final java.lang.String ADMIN_PASSWORD
```
    property representing the administrator password required for authentication.
    
    See Also:
    Constant Field Values
  - TRUSTSTORE_PASSWORD
```
public static final java.lang.String TRUSTSTORE_PASSWORD
```
    property representing the truststore passsword required for authentication.
    
    See Also:
    Constant Field Values
  - TRUSTSTORE_PATH
```
public static final java.lang.String TRUSTSTORE_PATH
```
    property representing the truststore path required for authentication.
    
    See Also:
    Constant Field Values
  - SSL_PROTOCOL
```
public static final java.lang.String SSL_PROTOCOL
```
    property representing the protocol used for secure connections
    
    See Also:
    Constant Field Values
  - CONNECT_TIMEOUT
```
public static final java.lang.String CONNECT_TIMEOUT
```
    property representing the number of seconds that a connect call will retry.
    
    See Also:
    Constant Field Values
  - DISABLE_SSL_HOSTNAME_VERIFICATION
```
public static final java.lang.String DISABLE_SSL_HOSTNAME_VERIFICATION
```
    property to allow the disabling of hostname verification
    
    See Also:
    Constant Field Values
  - DEBUG_SERVERS
```
public static final java.lang.String DEBUG_SERVERS
```
    property representing the list of servers from which to receive debugInfo objects. The list of servers is of the form host:port<, host:port, host:port...> where host is the hostname of a runtime server, and portname corresponds to the DebugPort property specified on the runtime server.
    
    See Also:
    Constant Field Values
  - DEBUG_SERVERS_TIMEOUT
```
public static final java.lang.String DEBUG_SERVERS_TIMEOUT
```
    property representing the time to wait for communications to be established to all servers listed in the "debugservers" property.
    
    See Also:
    Constant Field Values
  - DEBUG_AGENT_LIST
```
public static final java.lang.String DEBUG_AGENT_LIST
```
    property representing the agents from which debugInfo objects will be captured. The default is "*" which indicates all agents.
    
    See Also:
    Constant Field Values
  - DEBUG_MAX_EVENTQUEUE_SIZE
```
public static final java.lang.String DEBUG_MAX_EVENTQUEUE_SIZE
```
    property used by the IADebugReceiver implementation representing the maximum size of the debugInfo cache. If the cache reaches this size, the oldest objects are removed to make room for any new objects. If not specified, the default is 1000 objects.
    
    See Also:
    Constant Field Values
  - CATALOG_SERVER_ENDPOINTS
```
public static final java.lang.String CATALOG_SERVER_ENDPOINTS
```
    property representing the list of WebSphere Extreme Scale catalog servers. The list of servers is in the form host:port<, host:port, host:port...>
    
    See Also:
    Constant Field Values
  - GRID_SECURITY_ENABLED
```
public static final java.lang.String GRID_SECURITY_ENABLED
```
    A property representing whether or Insights grid security is enabled. This property must be set to true when security is enabled in the Inisghts server.
    
    See Also:
    Constant Field Values
  - GRID_USERNAME
```
public static final java.lang.String GRID_USERNAME
```
    A property representing the user name required for grid authentication.
    
    See Also:
    Constant Field Values
  - GRID_PASSWORD
```
public static final java.lang.String GRID_PASSWORD
```
    A property representing the password required for authentication.
    
    See Also:
    Constant Field Values
  - DEBUG_NOTE
```
public static final java.lang.String DEBUG_NOTE
```
    This property is a String that will be passed to the runtime server. When the runtime server generates a debugInfo object for this testdriver instance, it will include this string as the debugnote value in the DebugInfo object.
    
    See Also:
    Constant Field Values
  - TESTDRIVER_PROPS
```
public static final java.lang.String TESTDRIVER_PROPS
```
    name of the properties file containing the various TestDriver properties.
    
    See Also:
    Constant Field Values
  - TESTDRIVER_HOME
```
public static final java.lang.String TESTDRIVER_HOME
```
    an environment variable which points to a directory on the file system. It is used to locate the testdriver.properties file and as the destination of the testdriver log file.
    
    See Also:
    Constant Field Values
  - TESTDRIVER_LOGLEVEL
```
public static final java.lang.String TESTDRIVER_LOGLEVEL
```
    a property representing the log level : valid values are OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST. If the testdriver_home environment variable is set, then a logfile will be written to the specified directory for messages meeting the specified log level criteria.
    
    See Also:
    Constant Field Values
  - HTTP_TIMEOUT
```
public static final java.lang.String HTTP_TIMEOUT
```
    See Also:
    Constant Field Values
  - SUBMIT_EVENTS_RETRY_LIMIT
```
public static final java.lang.String SUBMIT_EVENTS_RETRY_LIMIT
```
    A property representing the number of retry attempts that will be made to submit an event by the submitEvents() method before the submission is considered a failure.
    
    See Also:
    Constant Field Values
  - SUBMIT_EVENTS_RETRY_LIMIT_DEFAULT
```
public static final int SUBMIT_EVENTS_RETRY_LIMIT_DEFAULT
```
    See Also:
    Constant Field Values
  - SUBMIT_EVENTS_RETRY_WAIT
```
public static final java.lang.String SUBMIT_EVENTS_RETRY_WAIT
```
    a property representing the time period, in milliseconds, between event submission retry attempts within the submitEvents() method.
    
    See Also:
    Constant Field Values
  - SUBMIT_EVENTS_RETRY_WAIT_DEFAULT
```
public static final int SUBMIT_EVENTS_RETRY_WAIT_DEFAULT
```
    See Also:
    Constant Field Values
  - LOAD_ENTITIES_BATCH_SIZE
```
public static final java.lang.String LOAD_ENTITIES_BATCH_SIZE
```
    A property representing the maximum batch size when loading entities via the loadEntities(Iterator) method.
    
    See Also:
    Constant Field Values
  - LOAD_ENTITIES_BATCH_SIZE_DEFAULT
```
public static final int LOAD_ENTITIES_BATCH_SIZE_DEFAULT
```
    See Also:
    Constant Field Values
  - CONNECTION_FACTORY
```
public static final java.lang.String CONNECTION_FACTORY
```
    property to define what client server communication environment should be used. Default to WXS for now
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DriverProperties
```
public DriverProperties()
```
    Initialize the TestDriver properties from the testdriver.properties file. If a Java system property "testdriver_home" is defined, the testdriver.properties file will be loaded from the directory specified by that property. Otherwise, an attempt will be made to load the property file from the users current directory ( as defined by the "user.dir" Java system property.
- Method Detail
  - setDefaults
```
public void setDefaults()
```
    Set the properties with appropriate defaults.
  - getDefaultProperty
```
public java.lang.String getDefaultProperty(java.lang.String _property)
```
  - setProperty
```
public java.lang.Object setProperty(java.lang.String key,
                           java.lang.String value)
```
    Overrides:
    
    setProperty in class java.util.Properties
  - getProperty
```
public java.lang.String getProperty(java.lang.String key)
```
    Overrides:
    
    getProperty in class java.util.Properties
  - getProperty
```
public java.lang.String getProperty(java.lang.String key,
                           java.lang.String def)
```
    Overrides:
    
    getProperty in class java.util.Properties

Fields inherited from class java.util.Properties

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

DEFAULT_HOSTNAME

DEFAULT_HTTPPORT_STRING

DEFAULT_CONNECT_TIMEOUT

DEFAULT_DEBUG_SERVERS_TIMEOUT

DEFAULT_MAX_QUEUE_SIZE

SOLUTION_NAME

RUNTIME_HOST_NAME

HTTP_PORT

ADMIN_USERNAME

ADMIN_PASSWORD

TRUSTSTORE_PASSWORD

TRUSTSTORE_PATH

SSL_PROTOCOL

CONNECT_TIMEOUT

DISABLE_SSL_HOSTNAME_VERIFICATION

DEBUG_SERVERS

DEBUG_SERVERS_TIMEOUT

DEBUG_AGENT_LIST

DEBUG_MAX_EVENTQUEUE_SIZE

CATALOG_SERVER_ENDPOINTS

GRID_SECURITY_ENABLED

GRID_USERNAME

GRID_PASSWORD

DEBUG_NOTE

TESTDRIVER_PROPS

TESTDRIVER_HOME

TESTDRIVER_LOGLEVEL

HTTP_TIMEOUT

SUBMIT_EVENTS_RETRY_LIMIT

SUBMIT_EVENTS_RETRY_LIMIT_DEFAULT

SUBMIT_EVENTS_RETRY_WAIT

SUBMIT_EVENTS_RETRY_WAIT_DEFAULT

LOAD_ENTITIES_BATCH_SIZE

LOAD_ENTITIES_BATCH_SIZE_DEFAULT

CONNECTION_FACTORY

DriverProperties

setDefaults

getDefaultProperty

setProperty

getProperty

getProperty