Configuring the Client

The SBLIM CIM Client can be changed in its behaviour for several parts. This chapter explains, how and which parts can be configured.

The Configuration File

The SBLIM CIM Client can be configured by a configuration file which follows the Java properties approach. So, key = value entries can be used to define values for the several properties. The file name of the configuration file is cim.defaults. Also an alternative file name is recognized. This is cimclient.properties. Be sure, that the directory, where the configuration file is stored, is part of your CLASSPATH environment variable.

To be compliant with the rpm package structure defined by the JPackage project, another file name is recognized. This is /etc/java/sblim-cim-client.properties. But this is only supported on Linux and AIX machines.

The search order is defined by the following numbering:

If one of the files is recognized once, the search will stop and use the file as input. So it is not possible to use 2 configuration files in parallel. If properties are not defined in the used configuration file, the default values are taken.

Here is an example, how to specify a property:

# Specifies the parsing model to be used. 0 - pullbase, 1 - SAX, 2 - DOM
# Type: Integer
# Defining a value outside the value range will cause to use the default value.
# Range: 0 .. 2
# Default: 0
xml.parser = 1

The sample will use the value 1 for the property xml.parser. The lines starting with a \# will be ignored. These are only comments.

Be Careful: The property keys are case sensitive. So, please avoid typos.

The Recognized Properties

http.timeout

Specifies the time out for the connection (in milliseconds).
A timeout of zero is interpreted as an infinite timeout. Defining a value outside the value range will cause to use the default value.
Type: Integer
Range: 0 .. 2147483647
Default: 0

http.pool.size

Specifies the maximum number of connections to keep alive for the connection pool.
A positive value defines the number of connection, zero - no connection will be reused, and -1 all connections will be reused (when it's possible). Defining a value outside the value range will cause to use the default value.
Type: Integer
Range: -1 .. 2147483647
Default: 16

https.jsse.provider

Specifies the JSSE provider.
Type: String
Default: The installed provider for SSLContext.SSL with the highest priority or com.ibm.jsse.IBMJSSEProvider if none is reported by the JVM

https.jsse.certificate

Specifies the JSSE certificate manager.
Type: String
Default: The value of the security property ssl.KeyManagerFactory.algorithm or IbmX509 if the property is null

https.truststore.path

Specifies the path of the truststore.
Type: String
Default: truststore

https.truststore.password

Specifies the password for the truststore. (plain password) Type: String Default: - null value -

https.keystore.path

Specifies the path of the keystore
Type: String
Default: keystore

https.keystore.password

Specifies the password for the keystore. (plain password)
Type: String
Default: - null value -

https.keystore.type

Specifies the type of the keystore (e.g. JKS, PKCS12)
Type: String
Default: JKS

xml.parser

Specifies the parsing model to be used. 0 - pullbase, 1 - SAX, 2 - DOM.
Defining a value outside the value range will cause to use the default value.
Type: Integer
Range: 0 .. 2
Default: 0

logger

Turn the logger on/off. true - turn the logger on, false - turn the logger off.
Defining a value outside the value range will cause to use the default value.
Type: Boolean
Range: false, true
Default: false

logger.namespace

The namespace used for the logger.
Specify a different namespace than the default one to create your own logging environment. Be sure, that no one else is using the specified namespace, if you want to modify the logger.
Type: String
Default: org.sblim.wbem.cim

log.console.level

Specifies the level of the messages to be display in the console.
Defining a value outside the value range will cause to use the default value.
Type: String
Range: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, All
Default: WARNING

log.file.level

Specifies the level of the messages to be keep in the log file.
Defining a value outside the value range will cause to use the default value.
Type: String
Range: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, All
Default: WARNING

log.output

Specifies the output log file.
Type: String
Default: cimclient.log

debug.istream

Debug the raw inputstream from the response, before the XML is parsed.
Defining a value outside the value range will cause to use the default value.
Type: Boolean
Range: false, true
Default: false

debug.istream.output

Specifies the output stream for the debugging information.
"stdout" is used for the systems standard output, "stderr" is used for the systems standard error. Otherwise the path of the output file.
Type: String
Default: stdout

debug.xml.input

Debug the XML from the response.
Defining a value outside the value range will cause to use the default value.
Type: Boolean
Range: false, true
Default: false

debug.xml.output

Debug the XML from the request.
Defining a value outside the value range will cause to use the default value.
Type: Boolean
Range: false, true
Default: false

debug.http.pool

Turn on/off debugging info for the HTTP connection pool.
Defining a value outside the value range will cause to use the default value.
Type: Boolean
Range: false, true
Default: false
DEPRECATED: Do not use in the current implementation.

default.authorization.enabled

Turn on/off the usage of the default user/pw.
This can be used if the CIMOM requires a "garbage" credential. Defining a value outside the value range will cause to use the default value.
Type: Boolean
Range: false, true
Default: false

default.principal

The name of the user for the "garbage" credential.
Type: String
Default: default

default.credential

The credential of the user for the "garbage" credential.
Type: String
Default: default

retries.number

This defines the number of retries that are executed in case an error occurs during the transmission of the cimXML request.
Defining a value outside the value range will cause to use the default value.
Type: Integer
Range: 0 .. 5
Default: 1

retries.content.enable

Enables the retry mechanism in case the content length of the response is below.
Type: Boolean
Range: false, true
Default: true

retries.content.lenght

The minimal content length of a response.
Defining a value outside the value range will cause to use the default value.
Type: Integer
Range: 0 .. 2147483647
Default: 50

Copyright © 2005, 2011 IBM Corporation. All Rights Reserved.