org.sblim.cimclient

Interface WBEMConfigurationProperties

public interface WBEMConfigurationProperties

The interface WBEMConfigurationProperties contains the names of all configuration properties that are recognized by the CIM Client.
Field Summary
static StringCIMXML_EMBOBJBUILDER
 Tells the XML builder how to sign embedded objects. 
static StringCIMXML_PARSER
Specifies the XML parser for parsing CIM-XML responses.
The SAX parser is the default choice since it is fast, resource saving and interoperable.
static StringCIMXML_PARSER_STRICT_EMBOBJ_TYPES
 If set the type of valueless EmbeddedObjects are mapped to CLASS_T. 
static StringCIMXML_TRACING
Enables or disables tracing of CIM-XML communication.
static StringCONFIG_URL
A URL string giving the location of the CIM client config file.
static StringHTTP_AUTHENTICATION_MODULE
The Java class name of the authentication module to use for http authentication.
static StringHTTP_CONNECTION_RETRIES
Specifies how often the client will retry to connect to a CIMOM which refused the connection in the first place.

Type: Integer
Recognition: Anytime
Range: 0 ..
static StringHTTP_CONTENT_LENGTH_THRESHOLD
Specifies the threshold above which a http document is regarded as valid by the content length retry algorithm.

Type: Integer
Recognition: Anytime
Range: 0 ..
static StringHTTP_ENABLE_CONTENT_LENGTH_RETRY
Specifies if the client will discard and request again http documents with less than a given number of bytes.

Type: Boolean
Recognition: Anytime
Range: true, false
Default: false
static StringHTTP_POOL_SIZE
The size of the internal http connection pools.
static StringHTTP_TIMEOUT
The timeout for http requests.
static StringHTTP_USE_CHUNKING
Specifies if chunking is used for transmitting http messages.

Type: Boolean
Recognition: Anytime
Range: true, false
Default: true
static StringHTTP_USE_MPOST
Specifies if MPOST is used for transmitting http messages.
static StringHTTP_VERSION
Specifies the http protocol version to use.
static StringKEYSTORE_PASSWORD
The password of the keystore.

Type: String
Recognition: On next SSL connection
Default: none
static StringKEYSTORE_PATH
The file path of the SSL keystore.

Type: String
Recognition: On next SSL connection
Default: none
static StringKEYSTORE_TYPE
The type of the keystore.

Type: String
Recognition: On next SSL connection
Range: PKCS12, JKS, ...
Default: JKS
static StringLISTENER_BACKLOG
The number of queued connections that is tolerated before the thread pool creates an additional handler thread.
static StringLISTENER_HANDLER_MAX_IDLE
The idle time of a worker that is tolerated before the worker is destroyed by the thread pool.
static StringLISTENER_HTTP_TIMEOUT
The timeout for http connections of an indication listener.
static StringLISTENER_MAX_POOL_SIZE
The size of the thread pool for the connection handlers of the indicati for http connections of an indication listener.
static StringLISTENER_MIN_POOL_SIZE
The minimal number of connection handlers of the indication listener that will be kept open by the thread pool regardsless of the current load.
static StringLOG_CONSOLE_LEVEL
Sets the minimum level for messages to be written to the console logger file.

Type: Discrete
Recognition: Startup
Range: OFF, SEVERE, WARNING, INFO, CONFIG, ALL
Default: OFF, which disables console logging completely.
static StringLOG_CONSOLE_TYPE
Sets the type of the console logger.
static StringLOG_FILE_COUNT
Sets the number of log files to cycle through.
static StringLOG_FILE_LEVEL
Sets the minimum level for messages to be written to the log file.

Type: Discrete
Recognition: Startup
Range: OFF, SEVERE, WARNING, INFO, CONFIG, ALL
Default: OFF, which disables file logging completely.
static StringLOG_FILE_LOCATION
A string specifying the location of the log file.
static StringLOG_FILE_SIZE_LIMIT
Sets the maximum size in bytes of a single log file.
static StringSSL_KEYMANAGER_ALGORITHM
The key manager factory algorithm name.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !
static StringSSL_PROTOCOL
The protocol used for SSLContext.getInstance(String protocol).
static StringSSL_SERVER_SOCKET_PROVIDER
The provider to use for creation of SSL server sockets.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !
static StringSSL_SOCKET_PROVIDER
The provider to use for creation of SSL client sockets.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !
static StringSSL_TRUSTMANAGER_ALGORITHM
The trust manager factory algorithm name.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !
static StringSYNCHRONIZED_SSL_HANDSHAKE
 If set to false, SSL handshakes are not synchronized.  
static StringTRACE_FILE_COUNT
Sets the number of log files to cycle through.
static StringTRACE_FILE_LEVEL
Sets the minimum level for messages to be written to the trace file.

Type: Discrete
Recognition: Startup
Range: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL
Default: OFF, which disables file tracing completely
static StringTRACE_FILE_LOCATION
A string specifying the location of the trace file.
static StringTRACE_FILE_SIZE_LIMIT
Sets the maximum size in bytes of a single log file.
static StringTRUSTSTORE_PASSWORD
The password of the truststore.

Type: String
Recognition: On next SSL connection
Default: none
static StringTRUSTSTORE_PATH
The file path of the SSL truststore.

Type: String
Recognition: On next SSL connection
Default: none
static StringTRUSTSTORE_TYPE
The type of the truststore.

Type: String
Recognition: On next SSL connection
Range: PKCS12, JKS, ...
Default: JKS

Field Detail

CIMXML_EMBOBJBUILDER

public static final String CIMXML_EMBOBJBUILDER
 Tells the XML builder how to sign embedded objects. This is necessary due to
 the non-consequent handling of embedded objects on different CIMOMs.
 "AttribOnly"       - only the EMBEDDEDOBJECT="instance/object" is used
                      (should be good for Pegasus)
 "EmbObjQuali"      - on qualified CIM-XML elements the EmbeddedObject qualifier is used
                      for embedded classes and instances
 "EmbObjAndEmbInstQuali" -
                      on qualified CIM-XML elements the EmbeddedObject qualifier is used
                      for embedded classes and the EmbeddedInstance="className" qualifier
                      is used for embedded instances 
 Type: String
 Recognition: Anytime
 Range: AttribOnly, EmbObjQuali, EmbObjAndEmbInstQuali
 Default: AttribOnly
 

CIMXML_PARSER

public static final String CIMXML_PARSER
Specifies the XML parser for parsing CIM-XML responses.
The SAX parser is the default choice since it is fast, resource saving and interoperable. The streaming algorithm of the PULL parser uses the fewest possible resources but at the prize to keep the CIMOMs response open for a long time. That works with many but not all CIMOMs. The DOM parser is slow and resource hungry but nice to debug.

Type: Discrete
Recognition: Anytime
Range: DOM, PULL, SAX
Default: SAX

CIMXML_PARSER_STRICT_EMBOBJ_TYPES

public static final String CIMXML_PARSER_STRICT_EMBOBJ_TYPES
 If set the type of valueless EmbeddedObjects are mapped to CLASS_T. It should work well
 with OpenPegasus-2.7.0.
 If unset no type mapping is done for valuless EmbeddedObjects.  
 
 Type: Boolean
 Default: true
 

CIMXML_TRACING

public static final String CIMXML_TRACING
Enables or disables tracing of CIM-XML communication. The trace is sent to an output stream the application has to set via the LogAndTraceManager class.

Type: Boolean
Recognition: Anytime
Range: true, false
Default: false

CONFIG_URL

public static final String CONFIG_URL
A URL string giving the location of the CIM client config file.

By default the SBLIM CIM Client looks for The first file found will be used. The default search list is not applied if this property is set, even if the given URL does not exist.

HTTP_AUTHENTICATION_MODULE

public static final String HTTP_AUTHENTICATION_MODULE
The Java class name of the authentication module to use for http authentication.

Type: String
Recognition: On next authentication
Range: org.sblim.cimclient.internal.http.WwwAuthInfo, org.sblim.cimclient.internal.http.PegasusLocalAuthInfo or any self-written subclass of org.sblim.cimclient.internal.http.AuthorizationInfo
Default: org.sblim.cimclient.internal.http.WwwAuthInfo

HTTP_CONNECTION_RETRIES

public static final String HTTP_CONNECTION_RETRIES
Specifies how often the client will retry to connect to a CIMOM which refused the connection in the first place.

Type: Integer
Recognition: Anytime
Range: 0 .. Integer.MAX_VALUE
Default: 0

HTTP_CONTENT_LENGTH_THRESHOLD

public static final String HTTP_CONTENT_LENGTH_THRESHOLD
Specifies the threshold above which a http document is regarded as valid by the content length retry algorithm.

Type: Integer
Recognition: Anytime
Range: 0 .. Integer.MAX_VALUE
Default: 50

HTTP_ENABLE_CONTENT_LENGTH_RETRY

public static final String HTTP_ENABLE_CONTENT_LENGTH_RETRY
Specifies if the client will discard and request again http documents with less than a given number of bytes.

Type: Boolean
Recognition: Anytime
Range: true, false
Default: false

HTTP_POOL_SIZE

public static final String HTTP_POOL_SIZE
The size of the internal http connection pools. Each WBEMClient instance has it's own http connection pool. A positive value defines the number of connections, zero that no connection will be reused, and -1 all connections will be reused (when it's possible).

Type: Integer
Recognition: Anytime
Range: -1, 0, 1 .. Integer.MAX_VALUE
Default: 16

HTTP_TIMEOUT

public static final String HTTP_TIMEOUT
The timeout for http requests. A timeout of zero is interpreted as infinite timeout.

Type: Integer
Unit: Milliseconds
Recognition: Anytime
Range: 0 .. Integer.MAX_VALUE
Default: 0

HTTP_USE_CHUNKING

public static final String HTTP_USE_CHUNKING
Specifies if chunking is used for transmitting http messages.

Type: Boolean
Recognition: Anytime
Range: true, false
Default: true

HTTP_USE_MPOST

public static final String HTTP_USE_MPOST
Specifies if MPOST is used for transmitting http messages. If false, POST is used.

Type: Boolean
Recognition: Anytime
Range: true, false
Default: true

HTTP_VERSION

public static final String HTTP_VERSION
Specifies the http protocol version to use. This option is useful if the protocol negotiation fails.

Type: String
Recognition: Anytime
Range: 1.0, 1.1
Default: 1.1

KEYSTORE_PASSWORD

public static final String KEYSTORE_PASSWORD
The password of the keystore.

Type: String
Recognition: On next SSL connection
Default: none

KEYSTORE_PATH

public static final String KEYSTORE_PATH
The file path of the SSL keystore.

Type: String
Recognition: On next SSL connection
Default: none

KEYSTORE_TYPE

public static final String KEYSTORE_TYPE
The type of the keystore.

Type: String
Recognition: On next SSL connection
Range: PKCS12, JKS, ...
Default: JKS

LISTENER_BACKLOG

public static final String LISTENER_BACKLOG
The number of queued connections that is tolerated before the thread pool creates an additional handler thread. Increasing this value leads to a less "nervous" creation/destruction of handlers. However it makes the listener more vulnerable to frozen connections.

Type: Integer
Unit: Count
Recognition: On next creation of a WBEMListener
Range: 0 .. Integer.MAX_VALUE
Default: 2

LISTENER_HANDLER_MAX_IDLE

public static final String LISTENER_HANDLER_MAX_IDLE
The idle time of a worker that is tolerated before the worker is destroyed by the thread pool. By setting the minimal pool size >0 you can protect a given number of worker from destruction.

Type: Long
Unit: Milliseconds
Recognition: On next creation of a WBEMListener
Range: 0 .. Long.MAX_VALUE
Default: 30000

LISTENER_HTTP_TIMEOUT

public static final String LISTENER_HTTP_TIMEOUT
The timeout for http connections of an indication listener. A timeout of zero is interpreted as infinite timeout.

Type: Integer
Unit: Milliseconds
Recognition: On next creation of a WBEMListener
Range: 0 .. Integer.MAX_VALUE
Default: 10000

LISTENER_MAX_POOL_SIZE

public static final String LISTENER_MAX_POOL_SIZE
The size of the thread pool for the connection handlers of the indicati for http connections of an indication listener. This is the maximum number of handler threads the pool might create on heavy load.
A value of -1 is interpreted as infinity.
Type: Integer
Unit: Count
Recognition: On next creation of a WBEMListener
Range: -1 .. Integer.MAX_VALUE
Default: 8

LISTENER_MIN_POOL_SIZE

public static final String LISTENER_MIN_POOL_SIZE
The minimal number of connection handlers of the indication listener that will be kept open by the thread pool regardsless of the current load.
Type: Integer
Unit: Count
Recognition: On next creation of a WBEMListener
Range: 0 .. Integer.MAX_VALUE
Default: 2

LOG_CONSOLE_LEVEL

public static final String LOG_CONSOLE_LEVEL
Sets the minimum level for messages to be written to the console logger file.

Type: Discrete
Recognition: Startup
Range: OFF, SEVERE, WARNING, INFO, CONFIG, ALL
Default: OFF, which disables console logging completely.

LOG_CONSOLE_TYPE

public static final String LOG_CONSOLE_TYPE
Sets the type of the console logger. Maybe either message log or trace log.

Type: Discrete
Recognition: Startup
Range: MESSAGE, TRACE
Default: MESSAGE.

LOG_FILE_COUNT

public static final String LOG_FILE_COUNT
Sets the number of log files to cycle through. When the number is exceeeded the oldest file is dropped.

Type: Integer
Recognition: Startup
Range: 1 .. Integer.MAX_VALUE
Default: 5

LOG_FILE_LEVEL

public static final String LOG_FILE_LEVEL
Sets the minimum level for messages to be written to the log file.

Type: Discrete
Recognition: Startup
Range: OFF, SEVERE, WARNING, INFO, CONFIG, ALL
Default: OFF, which disables file logging completely.

LOG_FILE_LOCATION

public static final String LOG_FILE_LOCATION
A string specifying the location of the log file. The string may include the following special components that will be replaced at runtime:
Thus for example a pattern of %t/java%g.log with a count of 2 would typically cause log files to be written on Unix to /var/tmp/java2.log

Type: String
Recognition: Startup
Default: %t/cimclient_log_%g.txt.

LOG_FILE_SIZE_LIMIT

public static final String LOG_FILE_SIZE_LIMIT
Sets the maximum size in bytes of a single log file. When the limit is reached a new file is created. A limit of zero will create a new log file for every log record !

Type: Integer
Recognition: Startup
Range: 0 .. Integer.MAX_VALUE
Default: 100.000

SSL_KEYMANAGER_ALGORITHM

public static final String SSL_KEYMANAGER_ALGORITHM
The key manager factory algorithm name.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !

Type: String
Recognition: On next SSL connection
Range: IbmX509, SunX509, ...
Default: JRE specific

SSL_PROTOCOL

public static final String SSL_PROTOCOL
The protocol used for SSLContext.getInstance(String protocol). For IBMJSSE2 provider it can be "SSL_TLS".

Security property: JRE global access via Security.setProperty() and Security.getProperty()
Recognition: On next SSL connection
Default: "SSL"

SSL_SERVER_SOCKET_PROVIDER

public static final String SSL_SERVER_SOCKET_PROVIDER
The provider to use for creation of SSL server sockets.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !

Type: Java class name
Recognition: On next SSL connection
Default: Security.getProviders("SSLContext.SSL")

SSL_SOCKET_PROVIDER

public static final String SSL_SOCKET_PROVIDER
The provider to use for creation of SSL client sockets.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !

Type: Java class name
Recognition: On next SSL connection
Default: Security.getProviders("SSLContext.SSL")

SSL_TRUSTMANAGER_ALGORITHM

public static final String SSL_TRUSTMANAGER_ALGORITHM
The trust manager factory algorithm name.

Security property: JRE global access via Security.setProperty() and Security.getProperty() !

Type: String
Recognition: On next SSL connection
Range: IbmX509, SunX509, ...
Default: JRE specific

SYNCHRONIZED_SSL_HANDSHAKE

public static final String SYNCHRONIZED_SSL_HANDSHAKE
 If set to false, SSL handshakes are not synchronized.  If set to true, SSL handshakes
 are synchronized as a workaround for an IBMJSSE1 problem with thread-safe handshakes.
 
 Type: Boolean
 Recognition: On next HTTP client
 Default: false
 

TRACE_FILE_COUNT

public static final String TRACE_FILE_COUNT
Sets the number of log files to cycle through. When the number is exceeeded the oldest file is dropped.

Type: Integer
Recognition: Startup
Range: 1 .. Integer.MAX_VALUE
Default: 5

TRACE_FILE_LEVEL

public static final String TRACE_FILE_LEVEL
Sets the minimum level for messages to be written to the trace file.

Type: Discrete
Recognition: Startup
Range: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL
Default: OFF, which disables file tracing completely

TRACE_FILE_LOCATION

public static final String TRACE_FILE_LOCATION
A string specifying the location of the trace file. The string may include the following special components that will be replaced at runtime:
Thus for example a pattern of %t/java%g.log with a count of 2 would typically cause log files to be written on Unix to /var/tmp/java2.log

Type: String
Recognition: Startup
Default: %t/cimclient_trace_%g.txt

TRACE_FILE_SIZE_LIMIT

public static final String TRACE_FILE_SIZE_LIMIT
Sets the maximum size in bytes of a single log file. When the limit is reached a new file is created. A limit of zero creates a new file for each trace record !

Type: Integer
Recognition: Startup
Range: 0 .. Integer.MAX_VALUE
Default: 1.000.000

TRUSTSTORE_PASSWORD

public static final String TRUSTSTORE_PASSWORD
The password of the truststore.

Type: String
Recognition: On next SSL connection
Default: none

TRUSTSTORE_PATH

public static final String TRUSTSTORE_PATH
The file path of the SSL truststore.

Type: String
Recognition: On next SSL connection
Default: none

TRUSTSTORE_TYPE

public static final String TRUSTSTORE_TYPE
The type of the truststore.

Type: String
Recognition: On next SSL connection
Range: PKCS12, JKS, ...
Default: JKS
Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.