com.ibm.datapower.wamt.clientAPI
Class Configuration

java.lang.Object
  extended by com.ibm.datapower.wamt.clientAPI.Configuration

public class Configuration
extends java.lang.Object

This class loads all of the configuration data for the manager. Configuration can be specified only at startup time, there are no setter methods in this class to change configuration values after the Manager object has been instantiated. All configuration properties have default values, which can be overridden by key/value pairs in a properties file, which may be overridden by key/value pairs in the Map object passed to the constructor for Manager.

Configuration reads from all three "config spaces". The Map object takes priority over the properties file, and the properties file takes priority over the default values, as shown in the list below:

The IBM WebSphere Appliance Management Toolkit properties file is named WAMT.properties. The properties file location is specified by the WAMT_CONFIGURATION_HOME java system property.
Example:
        -DWAMT_CONFIGURATION_HOME=C:\WAMT_CONFIG
  Would cause the manager to expect a file with this name in this path
        C:\WAMT_CONFIG\WAMT.properties

The properties in the file should be organized as a list of key=value pairs, with one key/value pair per line. The keys can be determined by inspecting the Constant Field Values for the configuration (look for constants KEY_ for the property name and DEFAULT_ for the default value for each property. Valid values vary based on the property.


Field Summary
static java.lang.String COPYRIGHT_2009_2013
           
static java.lang.String DEFAULT_AMP_CONNECT_TIMEOUT
          Default value for the configuration item specified by KEY_AMP_CONNECT_TIMEOUT
static java.lang.String DEFAULT_CAPTURE_VERSION_BLOB
          Default value for the configuration item specified by KEY_CAPTURE_VERSION_BLOB
static java.lang.String DEFAULT_COLLECT_DAEMON_PROGRESSES
          Default value for the configuration item specified by KEY_COLLECT_DAEMON_PROGRESSES
static java.lang.String DEFAULT_COLLECT_DOMAIN_SYNCH_PROGRESSES
          Default value for the configuration item specified by KEY_COLLECT_DOMAIN_SYNCH_PROGRESSES
static java.lang.String DEFAULT_COMMANDS_IMPL
          Default value for the configuration item specified by KEY_COMMANDS_IMPL
static java.lang.String DEFAULT_COMMANDS_SOMA_IMPL
          Default value for the configuration item specified by KEY_COMMANDS_SOMA_IMPL
static java.lang.String DEFAULT_COMMANDS_V2_IMPL
          Default value for the configuration item specified by KEY_COMMANDS_V2_IMPL
static java.lang.String DEFAULT_COMMANDS_V3_IMPL
          Default value for the configuration item specified by KEY_COMMANDS_V3_IMPL
static java.lang.String DEFAULT_COMMANDS_XC10_IMPL
          Default value for the configuration item specified by KEY_COMMANDS_XC10_IMPL
static java.lang.String DEFAULT_DEVICE_LOG_PORT
          Default value for the configuration item specified by KEY_DEVICE_LOG_PORT
static java.lang.String DEFAULT_DEVICE_QUIESCE_TIMEOUT
          Default value for the configuration item specified by KEY_DOMAIN_QUIESCE_TIMEOUT
static java.lang.String DEFAULT_DOMAIN_QUIESCE_TIMEOUT
          Default value for the configuration item specified by KEY_DOMAIN_QUIESCE_TIMEOUT
static java.lang.String DEFAULT_DOMAIN_SYNCHRONIZATION_INTERVAL
          Default value for the configuration item specified by KEY_DOMAIN_SYNCHRONIZATION_INTERVAL units are in milliseconds.
static java.lang.String DEFAULT_DOMAIN_SYNCHRONIZATION_RETRY_MAX
          Default value for the configuration item specified by KEY_DOMAIN_SYNCHRONIZATION_RETRY_MAX.
static java.lang.String DEFAULT_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE
          Default value for the configuration item specified by KEY_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE.
static java.lang.String DEFAULT_HEARTBEAT_DISABLE
          Default value for the configuration item specified by KEY_HEARTBEAT_DISABLE
static java.lang.String DEFAULT_HEARTBEAT_INTERVAL
          Default value for the configuration item specified by KEY_HEARTBEAT_INTERVAL
static java.lang.String DEFAULT_HEARTBEAT_THREAD_POOL_SIZE
          Default value for the configuration item specified by KEY_HEARTBEAT_THREAD_POOL_SIZE
static java.lang.String DEFAULT_HTTP_LISTENER_IP_ADDRESS
          Default value for the configuration item specified by KEY_HTTP_LISTENER_IP_INTERFACE
static java.lang.String DEFAULT_HTTP_LISTENER_IP_INTERFACE
          Default value for the configuration item specified by KEY_HTTP_LISTENER_IP_PORT
static java.lang.String DEFAULT_HTTP_LISTENER_IP_PORT
          Default value for the configuration item specified by KEY_HTTP_LISTENER_IP_ADDRESS
static java.lang.String DEFAULT_HTTP_LISTENER_SOCKET_TIMEOUT
          Default value for the configuration item specified by KEY_HTTP_LISTENER_SOCKET_TIMEOUT
static java.lang.String DEFAULT_MESSAGE_PREFIX
          Default value for the configuration item specified by KEY_MESSAGE_PREFIX
static java.lang.String DEFAULT_NOTIFICATION_CATCHER_IMPL
          Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IMPL
static java.lang.String DEFAULT_NOTIFICATION_CATCHER_IP_ADDRESS
          Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IP_ADDRESS
static java.lang.String DEFAULT_NOTIFICATION_CATCHER_IP_INTERFACE
          Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IP_INTERFACE
static java.lang.String DEFAULT_NOTIFICATION_CATCHER_IP_PORT
          Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IP_PORT
static java.lang.String DEFAULT_NOTIFICATION_CATCHER_NO_SSL
          Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_NO_SSL
static java.lang.String DEFAULT_REPOSITORY_IMPL
          Default value for the configuration item specified by KEY_REPOSITORY_IMPL
static java.lang.String DEFAULT_SIGNAL_CONNECT_TIMEOUT
          Default value for the configuration item specified by KEY_SIGNAL_CONNECT_TIMEOUT
static java.lang.String DEFAULT_SIGNAL_DELAY_TIME
          Default value for the configuration item specified by KEY_SIGNAL_DELAY_TIME
static java.lang.String DEFAULT_SIGNAL_RESPONSE_TIMEOUT
          Default value for the configuration item specified by KEY_SIGNAL_RESPONSE_TIMEOUT
static java.lang.String DEFAULT_SIGNAL_SOAP_ACTION
          Default value for the configuration item specified by KEY_SIGNAL_SOAP_ACTION
static java.lang.String DEFAULT_SIGNAL_URL
          Default value for the configuration item specified by KEY_SIGNAL_URL
static java.lang.String DEFAULT_SOAP_HELPER_IMPL
          Default value for the configuration item specified by KEY_SOAP_HELPER_IMPL
static java.lang.String DEFAULT_SOAP_HELPER_SOMA_IMPL
          Default value for the configuration item specified by KEY_SOAP_HELPER_SOMA_IMPL
static java.lang.String DEFAULT_SOAP_HELPER_V2_IMPL
          Default value for the configuration item specified by KEY_SOAP_HELPER_V2_IMPL
static java.lang.String DEFAULT_SOAP_HELPER_V3_IMPL
          Default value for the configuration item specified by KEY_SOAP_HELPER_V3_IMPL
static java.lang.String DEFAULT_TASK_QUEUE_SIZE
          Default value for the configuration item specified by KEY_TASK_QUEUE_SIZE
static java.lang.String DEFAULT_TRUSTSTORE_FILENAME
          Default value for the configuration item specified by KEY_TRUSTSTORE_FILENAME
static java.lang.String DEFAULT_TRUSTSTORE_PASSWORD
          Default value for the configuration item specified by KEY_TRUSTSTORE_PASSWORD
static java.lang.String ENV_VAR_NAME
          The name of the environment variable that has a value which indicates the manager's home directory.
static java.lang.String KEY_AMP_CONNECT_TIMEOUT
          Period in milliseconds to monitor the AMP connect request.
If the connect request times out, the connection is terminated and an
exception is thrown.
static java.lang.String KEY_CAPTURE_VERSION_BLOB
          When a DomainVersion or DeploymentPolicyVersion is created, serialize it to the local filesystem.
static java.lang.String KEY_COLLECT_DAEMON_PROGRESSES
          The daemons (QueueProcessor and HeartbeatDaemon) should create ProgressContainers and place them on a queue for retrieval by the user interface.
static java.lang.String KEY_COLLECT_DOMAIN_SYNCH_PROGRESSES
          The DomainSynchronizationDaemon creates ProgressContainers and places them on a queue for retrieval by the user interface.
static java.lang.String KEY_COMMANDS_IMPL
          Class name to instantiate that implements the Commands interface.
static java.lang.String KEY_COMMANDS_SOMA_IMPL
          Class name to instantiate that implements the SOMACommands interface.
static java.lang.String KEY_COMMANDS_V2_IMPL
          Class name to instantiate that implements the Commands interface.
static java.lang.String KEY_COMMANDS_V3_IMPL
          Class name to instantiate that implements the Commands interface.
static java.lang.String KEY_COMMANDS_XC10_IMPL
          Class name to instantiate that implements the Commands interface.
static java.lang.String KEY_DEVICE_LOG_PORT
          The port number for DeviceLogger to listen on.
static java.lang.String KEY_DEVICE_QUIESCE_TIMEOUT
          This value sets the default timeout value (in seconds) for device quiesce operations.
static java.lang.String KEY_DOMAIN_QUIESCE_TIMEOUT
          This value sets the default timeout value (in seconds) for domain quiesce operations.
static java.lang.String KEY_DOMAIN_SYNCHRONIZATION_INTERVAL
          Period in milliseconds between which a domain synchronization daemon should fire.
static java.lang.String KEY_DOMAIN_SYNCHRONIZATION_RETRY_MAX
          Mow many times to retry a domain synch before disabling automatic synch.
static java.lang.String KEY_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE
          The number of domain synchronization threads that should exist to service all managed domains.
static java.lang.String KEY_HEARTBEAT_DISABLE
          Disable the Heartbeat daemon and its tasks from running.
static java.lang.String KEY_HEARTBEAT_INTERVAL
          Period in milliseconds between which a HeartbeatTask should fire for each device.
static java.lang.String KEY_HEARTBEAT_THREAD_POOL_SIZE
          The number of heart beat threads that should exist to service all devices.
static java.lang.String KEY_HTTP_LISTENER_IP_ADDRESS
          IP address that the HTTPListener will listen on for HTTP file requests from the device, this is the IP address part of the file URL.
static java.lang.String KEY_HTTP_LISTENER_IP_INTERFACE
          IP address that the HTTP Listener will listen on for HTTP file requests from the device, this is the interface whose IP address is used in the file URL.
static java.lang.String KEY_HTTP_LISTENER_IP_PORT
          Port for the HTTPListener to listen on for HTTP file requests.
static java.lang.String KEY_HTTP_LISTENER_SOCKET_TIMEOUT
          The interval in seconds since the HTTP listener is created in which HTTP listener will time out if there is no incoming connection.
static java.lang.String KEY_MESSAGE_PREFIX
          Prefix to be added to the message numbers logged by the manager Commands interface.
static java.lang.String KEY_NOTIFICATION_CATCHER_IMPL
          class name to instantiate that implements the NotificationCatcher interface.
static java.lang.String KEY_NOTIFICATION_CATCHER_IP_ADDRESS
          IP address that the manager will listen on for events from the device, this is the IP address part of the notification subscription URL.
static java.lang.String KEY_NOTIFICATION_CATCHER_IP_INTERFACE
          Name of IP interface that the manager will listen on for events from the device, this is the interface whose IP address is used in the notification subscription URL.
static java.lang.String KEY_NOTIFICATION_CATCHER_IP_PORT
          Port for the NotificationCatcher to listen on for events.
static java.lang.String KEY_NOTIFICATION_CATCHER_NO_SSL
          The NotificationCatcher should listen with a cleartext socket connection instead of an SSL socket connection.
static java.lang.String KEY_REPOSITORY_IMPL
          Class name to instantiate that implements the Repository interfaces.
static java.lang.String KEY_SIGNAL_CONNECT_TIMEOUT
          The connect timeout in milliseconds to a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device.
static java.lang.String KEY_SIGNAL_DELAY_TIME
          The time in milliseconds to sleep after signaling a third-party SOAP service before and after a change (firmware or domain) is deployed to a device.
static java.lang.String KEY_SIGNAL_RESPONSE_TIMEOUT
          The timeout in milliseconds to wait for a response from a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device.
static java.lang.String KEY_SIGNAL_SOAP_ACTION
          The value for the SOAPAction header of a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device.
static java.lang.String KEY_SIGNAL_URL
          The URL of a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device.
static java.lang.String KEY_SOAP_HELPER_IMPL
          Class name to instantiate that implements the SOAPHelper interface.
static java.lang.String KEY_SOAP_HELPER_SOMA_IMPL
          Class name to instantiate that implements the SOAPHelper interface.
static java.lang.String KEY_SOAP_HELPER_V2_IMPL
          Class name to instantiate that implements the SOAPHelper interface.
static java.lang.String KEY_SOAP_HELPER_V3_IMPL
          Class name to instantiate that implements the SOAPHelper interface.
static java.lang.String KEY_TASK_QUEUE_SIZE
          Maximum number of Tasks that can exist on any queue in the QueueProcessor.
static java.lang.String KEY_TRUSTSTORE_FILENAME
          The filename of the key store for the manager to use in it's truststore.
static java.lang.String KEY_TRUSTSTORE_PASSWORD
          The password for the key store specified in KEY_TRUSTSTORE_FILENAME
matching option key name: Manager.OPTION_TRUSTSTORE_PASSWORD
default value: DEFAULT_TRUSTSTORE_PASSWORD
 
Method Summary
static java.lang.String get(java.lang.String canonicalKey)
          Get the preferred value (property, then option, then default) from the configuration using the canonical name key.
static java.lang.Integer getAsInteger(java.lang.String canonicalKey)
          Get the preferred value (property, then option, then default) from the configuration using the canonical name key.
static java.lang.String getRootDirectory()
          Get the root directory for th manager.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2013

public static final java.lang.String COPYRIGHT_2009_2013
See Also:
Constant Field Values

ENV_VAR_NAME

public static final java.lang.String ENV_VAR_NAME
The name of the environment variable that has a value which indicates the manager's home directory. The properties file will be looked for in this directory. If a properties file is not found in this directory and this variable has a non-null value, a default properties file will be generated. The name of the properties file is specified by PROPERTIES_FILE_RELATIVE_NAME.

See Also:
Constant Field Values

KEY_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE

public static final java.lang.String KEY_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE
The number of domain synchronization threads that should exist to service all managed domains.
matching option key name: Manager.OPTION_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE
default value: DEFAULT_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE

See Also:
Constant Field Values

KEY_DOMAIN_SYNCHRONIZATION_INTERVAL

public static final java.lang.String KEY_DOMAIN_SYNCHRONIZATION_INTERVAL
Period in milliseconds between which a domain synchronization daemon should fire.
matching option key name: Manager.OPTION_DOMAIN_SYNCHRONIZATION_INTERVAL
default value: DEFAULT_DOMAIN_SYNCHRONIZATION_INTERVAL

See Also:
Constant Field Values

KEY_DOMAIN_SYNCHRONIZATION_RETRY_MAX

public static final java.lang.String KEY_DOMAIN_SYNCHRONIZATION_RETRY_MAX
Mow many times to retry a domain synch before disabling automatic synch.
matching option key name: Manager.OPTION_DOMAIN_SYNCHRONIZATION_RETRY_MAX
default value: DEFAULT_DOMAIN_SYNCHRONIZATION_RETRY_MAX

See Also:
Constant Field Values

KEY_HEARTBEAT_THREAD_POOL_SIZE

public static final java.lang.String KEY_HEARTBEAT_THREAD_POOL_SIZE
The number of heart beat threads that should exist to service all devices.
matching option key name: Manager.OPTION_HEARTBEAT_THREAD_POOL_SIZE
default value: DEFAULT_HEARTBEAT_THREAD_POOL_SIZE

See Also:
Constant Field Values

KEY_HEARTBEAT_INTERVAL

public static final java.lang.String KEY_HEARTBEAT_INTERVAL
Period in milliseconds between which a HeartbeatTask should fire for each device.
matching option key name: Manager.OPTION_HEARTBEAT_INTERVAL
default value: DEFAULT_HEARTBEAT_INTERVAL

See Also:
Constant Field Values

KEY_AMP_CONNECT_TIMEOUT

public static final java.lang.String KEY_AMP_CONNECT_TIMEOUT
Period in milliseconds to monitor the AMP connect request.
If the connect request times out, the connection is terminated and an
exception is thrown. The specified value must be a positive integer.
Otherwise, the DEFAULT_AMP_CONNECT_TIMEOUT value is used.
matching option key name: Manager.OPTION_AMP_CONNECT_TIMEOUT
default value: DEFAULT_AMP_CONNECT_TIMEOUT

See Also:
Constant Field Values

KEY_COMMANDS_IMPL

public static final java.lang.String KEY_COMMANDS_IMPL
Class name to instantiate that implements the Commands interface.
matching option key name: Manager.OPTION_COMMANDS_IMPL
default value: DEFAULT_COMMANDS_IMPL

See Also:
Commands, CommandFactory.getCommands(String, String), Constant Field Values

KEY_COMMANDS_V2_IMPL

public static final java.lang.String KEY_COMMANDS_V2_IMPL
Class name to instantiate that implements the Commands interface.
matching option key name: Manager.OPTION_COMMANDS_V2_IMPL
default value: DEFAULT_COMMANDS_V2_IMPL

See Also:
Commands, CommandFactory.getCommands(String, String), Constant Field Values

KEY_COMMANDS_V3_IMPL

public static final java.lang.String KEY_COMMANDS_V3_IMPL
Class name to instantiate that implements the Commands interface.
matching option key name: Manager.OPTION_COMMANDS_V3_IMPL
default value: DEFAULT_COMMANDS_V3_IMPL

See Also:
Commands, CommandFactory.getCommands(String, String), Constant Field Values

KEY_COMMANDS_SOMA_IMPL

public static final java.lang.String KEY_COMMANDS_SOMA_IMPL
Class name to instantiate that implements the SOMACommands interface.
matching option key name: Manager.OPTION_COMMANDS_SOMA_IMPL
default value: DEFAULT_COMMANDS_SOMA_IMPL

See Also:
Commands, CommandFactory.getCommands(String, String), Constant Field Values

KEY_COMMANDS_XC10_IMPL

public static final java.lang.String KEY_COMMANDS_XC10_IMPL
Class name to instantiate that implements the Commands interface.
matching option key name: Manager.OPTION_COMMANDS_V3_IMPL
default value: DEFAULT_COMMANDS_V3_IMPL

See Also:
Commands, CommandFactory.getCommands(String, String), Constant Field Values

KEY_SOAP_HELPER_IMPL

public static final java.lang.String KEY_SOAP_HELPER_IMPL
Class name to instantiate that implements the SOAPHelper interface.
matching option key name: Manager.OPTION_SOAPHELPER_IMPL
default value: DEFAULT_SOAP_HELPER_IMPL

See Also:
SOAPHelper, SOAPHelperFactory.getSOAPHelper(String), Constant Field Values

KEY_SOAP_HELPER_V2_IMPL

public static final java.lang.String KEY_SOAP_HELPER_V2_IMPL
Class name to instantiate that implements the SOAPHelper interface.
matching option key name: Manager.OPTION_SOAPHELPER_V2_IMPL
default value: DEFAULT_SOAP_HELPER_V2_IMPL

See Also:
SOAPHelper, SOAPHelperFactory.getSOAPHelper(String), Constant Field Values

KEY_SOAP_HELPER_V3_IMPL

public static final java.lang.String KEY_SOAP_HELPER_V3_IMPL
Class name to instantiate that implements the SOAPHelper interface.
matching option key name: Manager.OPTION_SOAPHELPER_V3_IMPL
default value: DEFAULT_SOAP_HELPER_V3_IMPL

See Also:
SOAPHelper, SOAPHelperFactory.getSOAPHelper(String), Constant Field Values

KEY_SOAP_HELPER_SOMA_IMPL

public static final java.lang.String KEY_SOAP_HELPER_SOMA_IMPL
Class name to instantiate that implements the SOAPHelper interface.
matching option key name: Manager.OPTION_SOAPHELPER_SOMA_IMPL
default value: DEFAULT_SOAP_HELPER_SOMA_IMPL

See Also:
SOAPHelper, SOAPHelperFactory.getSOAPHelper(String), Constant Field Values

KEY_REPOSITORY_IMPL

public static final java.lang.String KEY_REPOSITORY_IMPL
Class name to instantiate that implements the Repository interfaces.
matching option key name: Manager.OPTION_REPOSITORY_IMPL
default value: DEFAULT_REPOSITORY_IMPL

See Also:
Repository, RepositoryFactory.getRepository(String, Credential), Constant Field Values

KEY_NOTIFICATION_CATCHER_IMPL

public static final java.lang.String KEY_NOTIFICATION_CATCHER_IMPL
class name to instantiate that implements the NotificationCatcher interface.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_IMPL
default value: DEFAULT_NOTIFICATION_CATCHER_IMPL

See Also:
NotificationCatcher, NotificationCatcherFactory.getNotificationCatcher(String), Constant Field Values

KEY_NOTIFICATION_CATCHER_IP_PORT

public static final java.lang.String KEY_NOTIFICATION_CATCHER_IP_PORT
Port for the NotificationCatcher to listen on for events.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_PORT
default value: DEFAULT_NOTIFICATION_CATCHER_IP_PORT

See Also:
NotificationCatcher.getURL(), Constant Field Values

KEY_NOTIFICATION_CATCHER_IP_ADDRESS

public static final java.lang.String KEY_NOTIFICATION_CATCHER_IP_ADDRESS
IP address that the manager will listen on for events from the device, this is the IP address part of the notification subscription URL. This would be used if you have more than one IP interface on the computer running the Manager. You can use KEY_NOTIFICATION_CATCHER_IP_INTERFACE instead if desired.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_IP_ADDRESS
default value: DEFAULT_NOTIFICATION_CATCHER_IP_ADDRESS

See Also:
NotificationCatcher.getURL(), Constant Field Values

KEY_NOTIFICATION_CATCHER_IP_INTERFACE

public static final java.lang.String KEY_NOTIFICATION_CATCHER_IP_INTERFACE
Name of IP interface that the manager will listen on for events from the device, this is the interface whose IP address is used in the notification subscription URL. This would be used if you have more than one IP interface on the computer running the Manager. On a Windows platform, this should be in shortname form, i.e. "eth1". You can use KEY_NOTIFICATION_CATCHER_IP_ADDRESS instead if desired.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_IP_INTERFACE
default value: DEFAULT_NOTIFICATION_CATCHER_IP_INTERFACE

See Also:
NotificationCatcher.getURL(), Constant Field Values

KEY_NOTIFICATION_CATCHER_NO_SSL

public static final java.lang.String KEY_NOTIFICATION_CATCHER_NO_SSL
The NotificationCatcher should listen with a cleartext socket connection instead of an SSL socket connection. The subscription (log target) on the device needs to have a matching SSL enablement.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_NO_SSL
default value: DEFAULT_NOTIFICATION_CATCHER_NO_SSL

See Also:
NotificationCatcher, Constant Field Values

KEY_HTTP_LISTENER_IP_PORT

public static final java.lang.String KEY_HTTP_LISTENER_IP_PORT
Port for the HTTPListener to listen on for HTTP file requests.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_PORT
default value: DEFAULT_HTTP_LISTENER_IP_PORT

See Also:
Constant Field Values

KEY_HTTP_LISTENER_IP_ADDRESS

public static final java.lang.String KEY_HTTP_LISTENER_IP_ADDRESS
IP address that the HTTPListener will listen on for HTTP file requests from the device, this is the IP address part of the file URL. This would be used if you have more than one IP interface on the computer running the Manager. You can use KEY_HTTP_LISTENER_IP_INTERFACE instead if desired.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_IP_ADDRESS
default value: DEFAULT_HTTP_LISTENER_IP_ADDRESS

See Also:
Constant Field Values

KEY_HTTP_LISTENER_IP_INTERFACE

public static final java.lang.String KEY_HTTP_LISTENER_IP_INTERFACE
IP address that the HTTP Listener will listen on for HTTP file requests from the device, this is the interface whose IP address is used in the file URL. This would be used if you have more than one IP interface on the computer running the Manager. On a Windows platform, this should be in shortname form, i.e. "eth1". You can use KEY_HTTP_LISTENER_IP_ADDRESS instead if desired.
matching option key name: Manager.OPTION_NOTIFICATION_CATCHER_IP_INTERFACE
default value: DEFAULT_HTTP_LISTENER_IP_INTERFACE

See Also:
Constant Field Values

KEY_HTTP_LISTENER_SOCKET_TIMEOUT

public static final java.lang.String KEY_HTTP_LISTENER_SOCKET_TIMEOUT
The interval in seconds since the HTTP listener is created in which HTTP listener will time out if there is no incoming connection. Manager.OPTION_HTTP_LISTENER_SOCKET_TIMEOUT
default value: DEFAULT_HTTP_LISTENER_SOCKET_TIMEOUT

See Also:
Constant Field Values

KEY_DEVICE_LOG_PORT

public static final java.lang.String KEY_DEVICE_LOG_PORT
The port number for DeviceLogger to listen on.
matching option key name: Manager.OPTION_DEVICE_LOG_PORT
default value: DEFAULT_DEVICE_LOG_PORT

See Also:
DeviceLogger, Constant Field Values

KEY_TASK_QUEUE_SIZE

public static final java.lang.String KEY_TASK_QUEUE_SIZE
Maximum number of Tasks that can exist on any queue in the QueueProcessor. This value should be null if you want there to be no limit.
matching option key name: Manager.OPTION_TASK_QUEUE_SIZE
default value: DEFAULT_TASK_QUEUE_SIZE

See Also:
FullException, Constant Field Values

KEY_COLLECT_DAEMON_PROGRESSES

public static final java.lang.String KEY_COLLECT_DAEMON_PROGRESSES
The daemons (QueueProcessor and HeartbeatDaemon) should create ProgressContainers and place them on a queue for retrieval by the user interface. The ProgressContainers provide visibility/status in to what the QueueProcessor and HeartbeatDaemon are doing, and may be the only visible indication of errors from automated tasks such as the HeartbeatDaemon which are not user-initiated. If you select "false", you will not have the ability to show heartbeat activity or display errors that may occur during the heartbeat activity (although the heartbeats will still occur and be processed). If you select "true", you must remove the ProgressContainers from the queue, or else the queue will grow unbounded and consume resources that will accumulate.
matching option key name: Manager.OPTION_COLLECT_DAEMON_PROGRESSES
default value: DEFAULT_COLLECT_DAEMON_PROGRESSES

See Also:
Manager.getNotificationProgresses(), Manager.getHeartbeatProgresses(), Constant Field Values

KEY_COLLECT_DOMAIN_SYNCH_PROGRESSES

public static final java.lang.String KEY_COLLECT_DOMAIN_SYNCH_PROGRESSES
The DomainSynchronizationDaemon creates ProgressContainers and places them on a queue for retrieval by the user interface. The ProgressContainers provide visibility/status in to what the DomainSynchronizationDaemon is doing, and may be the only visible indication of errors from automated tasks which are not user-initiated. If you select "false", you will not have the ability to show activity or display errors that may occur during the domain synchronization activity (although the synchronization will still occur and be processed). If you select "true", you must remove the ProgressContainers from the queue, or else the queue will grow unbounded and consume resources that will accumulate.
matching option key name: Manager.OPTION_COLLECT_DOMAIN_SYNCH_PROGRESSES
default value: DEFAULT_COLLECT_DOMAIN_SYNCH_PROGRESSES

See Also:
Manager.getNotificationProgresses(), Manager.getHeartbeatProgresses(), Constant Field Values

KEY_HEARTBEAT_DISABLE

public static final java.lang.String KEY_HEARTBEAT_DISABLE
Disable the Heartbeat daemon and its tasks from running. This should be done only for debug purposes.
matching option key name: Manager.OPTION_DEBUG_DISABLE_HEARTBEAT
default value: DEFAULT_HEARTBEAT_DISABLE

See Also:
Constant Field Values

KEY_DOMAIN_QUIESCE_TIMEOUT

public static final java.lang.String KEY_DOMAIN_QUIESCE_TIMEOUT
This value sets the default timeout value (in seconds) for domain quiesce operations.
default value: DEFAULT_DOMAIN_QUIESCE_TIMEOUT

See Also:
Constant Field Values

KEY_DEVICE_QUIESCE_TIMEOUT

public static final java.lang.String KEY_DEVICE_QUIESCE_TIMEOUT
This value sets the default timeout value (in seconds) for device quiesce operations.
default value: DEFAULT_DEVICE_QUIESCE_TIMEOUT

See Also:
Constant Field Values

KEY_CAPTURE_VERSION_BLOB

public static final java.lang.String KEY_CAPTURE_VERSION_BLOB
When a DomainVersion or DeploymentPolicyVersion is created, serialize it to the local filesystem. These simple blobs can be inspected offline. This would be done only for debug purposes.
matching option key name: Manager.OPTION_DEBUG_CAPTURE_VERSION_BLOB
default value: DEFAULT_CAPTURE_VERSION_BLOB

See Also:
getRootDirectory(), Constant Field Values

KEY_SIGNAL_URL

public static final java.lang.String KEY_SIGNAL_URL
The URL of a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device. The signaler is helpful in graceful shutdown of the device from a load balancer. If this value is null there there will be no signaling.
matching option key name: Manager.OPTION_SIGNAL_URL
default value: DEFAULT_SIGNAL_URL

See Also:
Constant Field Values

KEY_SIGNAL_SOAP_ACTION

public static final java.lang.String KEY_SIGNAL_SOAP_ACTION
The value for the SOAPAction header of a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device. The signaler is helpful in graceful shutdown of the device from a load balancer. If this value is null there there will be no SOAPAction header.
matching option key name: Manager.OPTION_SIGNAL_SOAP_ACTION
default value: DEFAULT_SIGNAL_SOAP_ACTION

See Also:
Constant Field Values

KEY_SIGNAL_CONNECT_TIMEOUT

public static final java.lang.String KEY_SIGNAL_CONNECT_TIMEOUT
The connect timeout in milliseconds to a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device. The signaler is helpful in graceful shutdown of the device from a load balancer. If this value is "0" then the usual network timeout will apply.
matching option key name: Manager.OPTION_SIGNAL_CONNECT_TIMEOUT
default value: DEFAULT_SIGNAL_CONNECT_TIMEOUT

See Also:
Constant Field Values

KEY_SIGNAL_RESPONSE_TIMEOUT

public static final java.lang.String KEY_SIGNAL_RESPONSE_TIMEOUT
The timeout in milliseconds to wait for a response from a third-party SOAP service to be signaled immediately before and after a change (firmware or domain) is deployed to a device. The signaler is helpful in graceful shutdown of the device from a load balancer.
matching option key name: Manager.OPTION_SIGNAL_RESPONSE_TIMEOUT
default value: DEFAULT_SIGNAL_RESPONSE_TIMEOUT

See Also:
Constant Field Values

KEY_SIGNAL_DELAY_TIME

public static final java.lang.String KEY_SIGNAL_DELAY_TIME
The time in milliseconds to sleep after signaling a third-party SOAP service before and after a change (firmware or domain) is deployed to a device. The signaler is helpful in graceful shutdown of the device from a load balancer. This delay time will be helpful in performing actions after the third-party SOAP service has received the signal.
matching option key name: Manager.OPTION_SIGNAL_DELAY_TIME
default value: DEFAULT_SIGNAL_DELAY_TIME

See Also:
Constant Field Values

KEY_TRUSTSTORE_FILENAME

public static final java.lang.String KEY_TRUSTSTORE_FILENAME
The filename of the key store for the manager to use in it's truststore. The Manager will load all the certificates from the keystore to use as trusted certificates.
matching option key name: Manager.OPTION_TRUSTSTORE_FILENAME
default value: DEFAULT_TRUSTSTORE_FILENAME

See Also:
Constant Field Values

KEY_TRUSTSTORE_PASSWORD

public static final java.lang.String KEY_TRUSTSTORE_PASSWORD
The password for the key store specified in KEY_TRUSTSTORE_FILENAME
matching option key name: Manager.OPTION_TRUSTSTORE_PASSWORD
default value: DEFAULT_TRUSTSTORE_PASSWORD

See Also:
Constant Field Values

DEFAULT_HEARTBEAT_THREAD_POOL_SIZE

public static final java.lang.String DEFAULT_HEARTBEAT_THREAD_POOL_SIZE
Default value for the configuration item specified by KEY_HEARTBEAT_THREAD_POOL_SIZE

See Also:
Constant Field Values

DEFAULT_HEARTBEAT_INTERVAL

public static final java.lang.String DEFAULT_HEARTBEAT_INTERVAL
Default value for the configuration item specified by KEY_HEARTBEAT_INTERVAL

See Also:
Constant Field Values

DEFAULT_AMP_CONNECT_TIMEOUT

public static final java.lang.String DEFAULT_AMP_CONNECT_TIMEOUT
Default value for the configuration item specified by KEY_AMP_CONNECT_TIMEOUT

See Also:
Constant Field Values

DEFAULT_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE

public static final java.lang.String DEFAULT_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE
Default value for the configuration item specified by KEY_DOMAIN_SYNCHRONIZATION_THREAD_POOL_SIZE. Default is 5

See Also:
Constant Field Values

DEFAULT_DOMAIN_SYNCHRONIZATION_INTERVAL

public static final java.lang.String DEFAULT_DOMAIN_SYNCHRONIZATION_INTERVAL
Default value for the configuration item specified by KEY_DOMAIN_SYNCHRONIZATION_INTERVAL units are in milliseconds. Default is 600000 milliseconds

See Also:
Constant Field Values

DEFAULT_DOMAIN_SYNCHRONIZATION_RETRY_MAX

public static final java.lang.String DEFAULT_DOMAIN_SYNCHRONIZATION_RETRY_MAX
Default value for the configuration item specified by KEY_DOMAIN_SYNCHRONIZATION_RETRY_MAX. Default is 2.

See Also:
Constant Field Values

DEFAULT_COMMANDS_IMPL

public static final java.lang.String DEFAULT_COMMANDS_IMPL
Default value for the configuration item specified by KEY_COMMANDS_IMPL

See Also:
Constant Field Values

DEFAULT_MESSAGE_PREFIX

public static final java.lang.String DEFAULT_MESSAGE_PREFIX
Default value for the configuration item specified by KEY_MESSAGE_PREFIX

See Also:
Constant Field Values

DEFAULT_COMMANDS_V2_IMPL

public static final java.lang.String DEFAULT_COMMANDS_V2_IMPL
Default value for the configuration item specified by KEY_COMMANDS_V2_IMPL

See Also:
Constant Field Values

DEFAULT_COMMANDS_V3_IMPL

public static final java.lang.String DEFAULT_COMMANDS_V3_IMPL
Default value for the configuration item specified by KEY_COMMANDS_V3_IMPL

See Also:
Constant Field Values

DEFAULT_COMMANDS_SOMA_IMPL

public static final java.lang.String DEFAULT_COMMANDS_SOMA_IMPL
Default value for the configuration item specified by KEY_COMMANDS_SOMA_IMPL

See Also:
Constant Field Values

DEFAULT_COMMANDS_XC10_IMPL

public static final java.lang.String DEFAULT_COMMANDS_XC10_IMPL
Default value for the configuration item specified by KEY_COMMANDS_XC10_IMPL

See Also:
Constant Field Values

DEFAULT_SOAP_HELPER_IMPL

public static final java.lang.String DEFAULT_SOAP_HELPER_IMPL
Default value for the configuration item specified by KEY_SOAP_HELPER_IMPL

See Also:
Constant Field Values

DEFAULT_SOAP_HELPER_V2_IMPL

public static final java.lang.String DEFAULT_SOAP_HELPER_V2_IMPL
Default value for the configuration item specified by KEY_SOAP_HELPER_V2_IMPL

See Also:
Constant Field Values

DEFAULT_SOAP_HELPER_V3_IMPL

public static final java.lang.String DEFAULT_SOAP_HELPER_V3_IMPL
Default value for the configuration item specified by KEY_SOAP_HELPER_V3_IMPL

See Also:
Constant Field Values

DEFAULT_SOAP_HELPER_SOMA_IMPL

public static final java.lang.String DEFAULT_SOAP_HELPER_SOMA_IMPL
Default value for the configuration item specified by KEY_SOAP_HELPER_SOMA_IMPL

See Also:
Constant Field Values

DEFAULT_REPOSITORY_IMPL

public static final java.lang.String DEFAULT_REPOSITORY_IMPL
Default value for the configuration item specified by KEY_REPOSITORY_IMPL

See Also:
Constant Field Values

DEFAULT_NOTIFICATION_CATCHER_IMPL

public static final java.lang.String DEFAULT_NOTIFICATION_CATCHER_IMPL
Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IMPL

See Also:
Constant Field Values

DEFAULT_NOTIFICATION_CATCHER_IP_PORT

public static final java.lang.String DEFAULT_NOTIFICATION_CATCHER_IP_PORT
Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IP_PORT

See Also:
Constant Field Values

DEFAULT_NOTIFICATION_CATCHER_IP_ADDRESS

public static final java.lang.String DEFAULT_NOTIFICATION_CATCHER_IP_ADDRESS
Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IP_ADDRESS


DEFAULT_NOTIFICATION_CATCHER_IP_INTERFACE

public static final java.lang.String DEFAULT_NOTIFICATION_CATCHER_IP_INTERFACE
Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_IP_INTERFACE


DEFAULT_NOTIFICATION_CATCHER_NO_SSL

public static final java.lang.String DEFAULT_NOTIFICATION_CATCHER_NO_SSL
Default value for the configuration item specified by KEY_NOTIFICATION_CATCHER_NO_SSL

See Also:
Constant Field Values

DEFAULT_HTTP_LISTENER_IP_PORT

public static final java.lang.String DEFAULT_HTTP_LISTENER_IP_PORT
Default value for the configuration item specified by KEY_HTTP_LISTENER_IP_ADDRESS

See Also:
Constant Field Values

DEFAULT_HTTP_LISTENER_SOCKET_TIMEOUT

public static final java.lang.String DEFAULT_HTTP_LISTENER_SOCKET_TIMEOUT
Default value for the configuration item specified by KEY_HTTP_LISTENER_SOCKET_TIMEOUT

See Also:
Constant Field Values

DEFAULT_HTTP_LISTENER_IP_ADDRESS

public static final java.lang.String DEFAULT_HTTP_LISTENER_IP_ADDRESS
Default value for the configuration item specified by KEY_HTTP_LISTENER_IP_INTERFACE


DEFAULT_HTTP_LISTENER_IP_INTERFACE

public static final java.lang.String DEFAULT_HTTP_LISTENER_IP_INTERFACE
Default value for the configuration item specified by KEY_HTTP_LISTENER_IP_PORT


DEFAULT_DEVICE_LOG_PORT

public static final java.lang.String DEFAULT_DEVICE_LOG_PORT
Default value for the configuration item specified by KEY_DEVICE_LOG_PORT


DEFAULT_TASK_QUEUE_SIZE

public static final java.lang.String DEFAULT_TASK_QUEUE_SIZE
Default value for the configuration item specified by KEY_TASK_QUEUE_SIZE


DEFAULT_COLLECT_DAEMON_PROGRESSES

public static final java.lang.String DEFAULT_COLLECT_DAEMON_PROGRESSES
Default value for the configuration item specified by KEY_COLLECT_DAEMON_PROGRESSES

See Also:
Constant Field Values

DEFAULT_COLLECT_DOMAIN_SYNCH_PROGRESSES

public static final java.lang.String DEFAULT_COLLECT_DOMAIN_SYNCH_PROGRESSES
Default value for the configuration item specified by KEY_COLLECT_DOMAIN_SYNCH_PROGRESSES

See Also:
Constant Field Values

DEFAULT_HEARTBEAT_DISABLE

public static final java.lang.String DEFAULT_HEARTBEAT_DISABLE
Default value for the configuration item specified by KEY_HEARTBEAT_DISABLE

See Also:
Constant Field Values

DEFAULT_DOMAIN_QUIESCE_TIMEOUT

public static final java.lang.String DEFAULT_DOMAIN_QUIESCE_TIMEOUT
Default value for the configuration item specified by KEY_DOMAIN_QUIESCE_TIMEOUT

See Also:
Constant Field Values

DEFAULT_DEVICE_QUIESCE_TIMEOUT

public static final java.lang.String DEFAULT_DEVICE_QUIESCE_TIMEOUT
Default value for the configuration item specified by KEY_DOMAIN_QUIESCE_TIMEOUT

See Also:
Constant Field Values

DEFAULT_CAPTURE_VERSION_BLOB

public static final java.lang.String DEFAULT_CAPTURE_VERSION_BLOB
Default value for the configuration item specified by KEY_CAPTURE_VERSION_BLOB

See Also:
Constant Field Values

DEFAULT_SIGNAL_URL

public static final java.lang.String DEFAULT_SIGNAL_URL
Default value for the configuration item specified by KEY_SIGNAL_URL


DEFAULT_SIGNAL_SOAP_ACTION

public static final java.lang.String DEFAULT_SIGNAL_SOAP_ACTION
Default value for the configuration item specified by KEY_SIGNAL_SOAP_ACTION


DEFAULT_SIGNAL_CONNECT_TIMEOUT

public static final java.lang.String DEFAULT_SIGNAL_CONNECT_TIMEOUT
Default value for the configuration item specified by KEY_SIGNAL_CONNECT_TIMEOUT

See Also:
Constant Field Values

DEFAULT_SIGNAL_RESPONSE_TIMEOUT

public static final java.lang.String DEFAULT_SIGNAL_RESPONSE_TIMEOUT
Default value for the configuration item specified by KEY_SIGNAL_RESPONSE_TIMEOUT

See Also:
Constant Field Values

DEFAULT_SIGNAL_DELAY_TIME

public static final java.lang.String DEFAULT_SIGNAL_DELAY_TIME
Default value for the configuration item specified by KEY_SIGNAL_DELAY_TIME

See Also:
Constant Field Values

DEFAULT_TRUSTSTORE_FILENAME

public static final java.lang.String DEFAULT_TRUSTSTORE_FILENAME
Default value for the configuration item specified by KEY_TRUSTSTORE_FILENAME


DEFAULT_TRUSTSTORE_PASSWORD

public static final java.lang.String DEFAULT_TRUSTSTORE_PASSWORD
Default value for the configuration item specified by KEY_TRUSTSTORE_PASSWORD


KEY_MESSAGE_PREFIX

public static final java.lang.String KEY_MESSAGE_PREFIX
Prefix to be added to the message numbers logged by the manager Commands interface.
matching option key name: Manager.OPTION_MESSAGE_PREFIX
default value: DEFAULT_MESSAGE_PREFIX

See Also:
Constant Field Values
Method Detail

getAsInteger

public static java.lang.Integer getAsInteger(java.lang.String canonicalKey)
Get the preferred value (property, then option, then default) from the configuration using the canonical name key. For example, Configuration.getAsInteger(Configuration.KEY_TASK_QUEUE_SIZE). This method may be more helpful than get(String) in places where you want an int or an Integer and don't want to do your own checking for a NumberFormatException. As long as there is a non-null and parseable default value for this item, and the key refers to a valid item, you can trust that this will not return null and thus you don't need to check for that.

Parameters:
canonicalKey - the canonical name of the configuration item. The canonical names are the public String members of this class that start with "KEY_", such as KEY_COMMANDS_IMPL.
Returns:
the preferred value which parses successfully into an Integer. If a value, such as a property, is set to a non-parseable value (i.e., the String "2q" from the properties file can not be converted to an Integer), then this method will check the next preferred value (i.e., see if the value from the Manager options can be converted to an Integer). If both the properties value and the option value are null or non-parseable, then it will convert the default value to an Integer and return it. Even after all this, the return value may still be null, if the default value is null.
See Also:
get(String), set(String, String)

getRootDirectory

public static java.lang.String getRootDirectory()
Get the root directory for th manager. This value is defined in the System property (environment variable) specified by ENV_VAR_NAME. If that System property has not been defined, then the value returned will be the current directory and a log message at Level.FINE may be generated.

This method is for internal use only.

Returns:
the root directory. If a trailing separator (ie, "/" on Linux) is not included in the value when it was specified, a trailing separator will be added.

get

public static java.lang.String get(java.lang.String canonicalKey)
Get the preferred value (property, then option, then default) from the configuration using the canonical name key. For example, Configuration.get(Configuration.KEY_COMMANDS_IMPL)

Parameters:
canonicalKey - the canonical name of the configuration item. The canonical names are the public String members of this class that start with "KEY_", such as KEY_COMMANDS_IMPL.
Returns:
the preferred value. This may be null, if the default value is null and there is no specific property or option value. If this was originally a non-String object from the Manager options, it was converted into a String by invoking its toString() method.
See Also:
getAsInteger(String), set(String, String)


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.