WBEMConfigurationProperties (SBLIM CIM Client for Java - 2.1.3

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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 java.lang.String`	`CIMXML_EMBOBJBUILDER` Tells the XML builder how to sign embedded objects.
`static java.lang.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.
`static java.lang.String`	`CIMXML_PARSER_STRICT_EMBOBJ_TYPES` If set the type of valueless EmbeddedObjects are mapped to CLASS_T.
`static java.lang.String`	`CIMXML_TRACING` Enables or disables tracing of CIM-XML communication.
`static java.lang.String`	`CONFIG_URL` A URL string giving the location of the CIM client config file.
`static java.lang.String`	`HTTP_AUTHENTICATION_MODULE` The Java class name of the authentication module to use for http authentication.
`static java.lang.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 ..`
`static java.lang.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 ..`
`static java.lang.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`
`static java.lang.String`	`HTTP_POOL_SIZE` The size of the internal http connection pools.
`static java.lang.String`	`HTTP_TIMEOUT` The timeout for http requests.
`static java.lang.String`	`HTTP_USE_CHUNKING` Specifies if chunking is used for transmitting http messages. Type: `Boolean` Recognition: `Anytime` Range: `true, false` Default: `true`
`static java.lang.String`	`HTTP_USE_MPOST` Specifies if MPOST is used for transmitting http messages.
`static java.lang.String`	`HTTP_VERSION` Specifies the http protocol version to use.
`static java.lang.String`	`KEY_CREDENTIALS_DEFAULT_ENABLED` If set to false user supplied credentials wil be applied.
`static java.lang.String`	`KEY_DEFAULT_CREDENTIAL` default Credential value is set to "default" Type: String Recognition: On next HTTP client Default: "default"
`static java.lang.String`	`KEY_DEFAULT_PRINCIPAL` default Principal value is set to "default" Type: String Recognition: On next HTTP client Default: "default"
`static java.lang.String`	`KEYSTORE_PASSWORD` The password of the keystore. Type: `String` Recognition: `On next SSL connection` Default: none
`static java.lang.String`	`KEYSTORE_PATH` The file path of the SSL keystore. Type: `String` Recognition: `On next SSL connection` Default: none
`static java.lang.String`	`KEYSTORE_TYPE` The type of the keystore. Type: `String` Recognition: `On next SSL connection` Range: `PKCS12, JKS, ...` Default: `JKS`
`static java.lang.String`	`LISTENER_BACKLOG` The number of queued connections that is tolerated before the thread pool creates an additional handler thread.
`static java.lang.String`	`LISTENER_HANDLER_MAX_IDLE` The idle time of a worker that is tolerated before the worker is destroyed by the thread pool.
`static java.lang.String`	`LISTENER_HTTP_TIMEOUT` The timeout for http connections of an indication listener.
`static java.lang.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.
`static java.lang.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.
`static java.lang.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.
`static java.lang.String`	`LOG_CONSOLE_TYPE` Sets the type of the console logger.
`static java.lang.String`	`LOG_FILE_COUNT` Sets the number of log files to cycle through.
`static java.lang.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.
`static java.lang.String`	`LOG_FILE_LOCATION` A string specifying the location of the log file.
`static java.lang.String`	`LOG_FILE_SIZE_LIMIT` Sets the maximum size in bytes of a single log file.
`static java.lang.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`
`static java.lang.String`	`SSL_PROTOCOL` The protocol used for SSLContext.getInstance(String protocol).
`static java.lang.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")`
`static java.lang.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")`
`static java.lang.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`
`static java.lang.String`	`SYNCHRONIZED_SSL_HANDSHAKE` If set to false, SSL handshakes are not synchronized.
`static java.lang.String`	`TRACE_FILE_COUNT` Sets the number of log files to cycle through.
`static java.lang.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
`static java.lang.String`	`TRACE_FILE_LOCATION` A string specifying the location of the trace file.
`static java.lang.String`	`TRACE_FILE_SIZE_LIMIT` Sets the maximum size in bytes of a single log file.
`static java.lang.String`	`TRUSTSTORE_PASSWORD` The password of the truststore. Type: `String` Recognition: `On next SSL connection` Default: none
`static java.lang.String`	`TRUSTSTORE_PATH` The file path of the SSL truststore. Type: `String` Recognition: `On next SSL connection` Default: none
`static java.lang.String`	`TRUSTSTORE_TYPE` The type of the truststore. Type: `String` Recognition: `On next SSL connection` Range: `PKCS12, JKS, ...` Default: `JKS`

Field Detail

CONFIG_URL

static final java.lang.String CONFIG_URL

A URL string giving the location of the CIM client config file.

By default the SBLIM CIM Client looks for

file:sblim-cim-client2.properties
file:%USER_HOME%/sblim-cim-client2.properties
file:/etc/java/sblim-cim-client2.properties

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.

See Also:: Constant Field Values

LOG_FILE_LEVEL

static final java.lang.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.

See Also:: Constant Field Values

LOG_FILE_LOCATION

static final java.lang.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:

/	the local pathname separator
%t	the system temporary directory
%h	the value of the "user.home" system property
%g	the generation number to distinguish rotated logs
%u	a unique number to resolve conflicts
%%	translates to a single percent sign "%"

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.

See Also:: Constant Field Values

LOG_FILE_SIZE_LIMIT

static final java.lang.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

See Also:: Constant Field Values

LOG_FILE_COUNT

static final java.lang.String LOG_FILE_COUNT

Sets the number of log files to cycle through. When the number is exceeded the oldest file is dropped.

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

See Also:: Constant Field Values

LOG_CONSOLE_LEVEL

static final java.lang.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.

See Also:: Constant Field Values

LOG_CONSOLE_TYPE

static final java.lang.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.

See Also:: Constant Field Values

TRACE_FILE_LEVEL

static final java.lang.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

See Also:: Constant Field Values

TRACE_FILE_LOCATION

static final java.lang.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:

/	the local pathname separator
%t	the system temporary directory
%h	the value of the "user.home" system property
%g	the generation number to distinguish rotated logs
%u	a unique number to resolve conflicts
%%	translates to a single percent sign "%"

See Also:: Constant Field Values

TRACE_FILE_SIZE_LIMIT

static final java.lang.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

See Also:: Constant Field Values

TRACE_FILE_COUNT

static final java.lang.String TRACE_FILE_COUNT

Sets the number of log files to cycle through. When the number is exceeded the oldest file is dropped.

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

See Also:: Constant Field Values

HTTP_TIMEOUT

static final java.lang.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

See Also:: Constant Field Values

HTTP_POOL_SIZE

static final java.lang.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

See Also:: Constant Field Values

HTTP_AUTHENTICATION_MODULE

static final java.lang.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

See Also:: Constant Field Values

HTTP_USE_MPOST

static final java.lang.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

See Also:: Constant Field Values

HTTP_USE_CHUNKING

static final java.lang.String HTTP_USE_CHUNKING

Specifies if chunking is used for transmitting http messages.

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

See Also:: Constant Field Values

HTTP_VERSION

static final java.lang.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

See Also:: Constant Field Values

HTTP_CONNECTION_RETRIES

static final java.lang.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

See Also:: Constant Field Values

HTTP_ENABLE_CONTENT_LENGTH_RETRY

static final java.lang.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

See Also:: Constant Field Values

HTTP_CONTENT_LENGTH_THRESHOLD

static final java.lang.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

See Also:: Constant Field Values

KEYSTORE_PATH

static final java.lang.String KEYSTORE_PATH

The file path of the SSL keystore.

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

See Also:: Constant Field Values

KEYSTORE_TYPE

static final java.lang.String KEYSTORE_TYPE

The type of the keystore.

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

See Also:: Constant Field Values

KEYSTORE_PASSWORD

static final java.lang.String KEYSTORE_PASSWORD

The password of the keystore.

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

See Also:: Constant Field Values

TRUSTSTORE_PATH

static final java.lang.String TRUSTSTORE_PATH

The file path of the SSL truststore.

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

See Also:: Constant Field Values

TRUSTSTORE_TYPE

static final java.lang.String TRUSTSTORE_TYPE

The type of the truststore.

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

See Also:: Constant Field Values

TRUSTSTORE_PASSWORD

static final java.lang.String TRUSTSTORE_PASSWORD

The password of the truststore.

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

See Also:: Constant Field Values

SSL_SOCKET_PROVIDER

static final java.lang.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")

See Also:: Constant Field Values

SSL_SERVER_SOCKET_PROVIDER

static final java.lang.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")

See Also:: Constant Field Values

SSL_PROTOCOL

static final java.lang.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"

See Also:: Constant Field Values

SSL_KEYMANAGER_ALGORITHM

static final java.lang.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

See Also:: Constant Field Values

SSL_TRUSTMANAGER_ALGORITHM

static final java.lang.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

See Also:: Constant Field Values

CIMXML_PARSER

static final java.lang.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

See Also:: Constant Field Values

CIMXML_TRACING

static final java.lang.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

See Also:: Constant Field Values

CIMXML_EMBOBJBUILDER

static final java.lang.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

See Also:: Constant Field Values

CIMXML_PARSER_STRICT_EMBOBJ_TYPES

static final java.lang.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

See Also:: Constant Field Values

SYNCHRONIZED_SSL_HANDSHAKE

static final java.lang.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

See Also:: Constant Field Values

KEY_CREDENTIALS_DEFAULT_ENABLED

static final java.lang.String KEY_CREDENTIALS_DEFAULT_ENABLED

  If set to false user supplied credentials wil be applied. 
  If set to true default credentials will be used.
  This can be used if the CIMOM requires a "garbage" credential
 
 Type: Boolean
 Recognition: On next HTTP client
 Default: false

See Also:: Constant Field Values

KEY_DEFAULT_PRINCIPAL

static final java.lang.String KEY_DEFAULT_PRINCIPAL

   default Principal value is set to "default"
 
 Type: String
 Recognition: On next HTTP client
 Default: "default"

See Also:: Constant Field Values

KEY_DEFAULT_CREDENTIAL

static final java.lang.String KEY_DEFAULT_CREDENTIAL

   default Credential value is set to "default"
 
 Type: String
 Recognition: On next HTTP client
 Default: "default"

See Also:: Constant Field Values

LISTENER_HTTP_TIMEOUT

static final java.lang.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

See Also:: Constant Field Values

LISTENER_MAX_POOL_SIZE

static final java.lang.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

See Also:: Constant Field Values

LISTENER_MIN_POOL_SIZE

static final java.lang.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

See Also:: Constant Field Values

LISTENER_BACKLOG

static final java.lang.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

See Also:: Constant Field Values

LISTENER_HANDLER_MAX_IDLE

static final java.lang.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

See Also:: Constant Field Values