org.sblim.cimclient.internal.util

Class WBEMConfiguration

public class WBEMConfiguration extends Object

Class WBEMConfigurationFile is responsible for initializing the the configuration properties from the configuration file.

UNKNOWN: This class was designed as thread-safe

Constructor Summary
WBEMConfiguration(Properties pDomainProperties)
Ctor.
Method Summary
static StringgetActiveConfigURL()
Returns the URL of the active configuration file.
StringgetCimXmlEmbObjBuilder()
getCimXmlEmbObjBuilder
StringgetCimXmlParser()
Return the XML parser to use for processing operation responses
static ExceptiongetConfigurationLoadException()
Returns the exception caught during configuration load, load failed.
SocketFactorygetCustomSocketFactory()
Returns the custom socket factory
StringgetDefaultCredentials()
getDefaultCredentials
StringgetDefaultPrincipal()
getDefaultPrincipal
PropertiesgetDomainProperties()
Returns the domain properties
StringgetDomainProperty(String pKey)
Returns a value from the domain properties for a given name
static WBEMConfigurationgetGlobalConfiguration()
Returns the global configuration
StringgetHttpAuthenticationModule()
Returns the Java class name of http authentication module to use
intgetHttpConnectRetriesCount()
Returns the number of retries the client will attempt when the connection was refused.
intgetHttpContentLengthThreshold()
Returns the threshold for the content length retry algorithm
intgetHttpPoolSize()
Returns the http pool size
intgetHttpTimeout()
Returns the http timeout
StringgetHttpVersion()
Returns the http version to use
intgetListenerBacklog()
Returns the backlog that is tolerated before the thread pool creates an additional handler
intgetListenerHttpTimeout()
Returns the http timeout for indication connection handlers
longgetListenerMaxIdle()
Returns the maximal idle time that is tolerated for a connection handler
intgetListenerMaxPoolSize()
Returns the maximal pool size for indication connection handlers
intgetListenerMinPoolSize()
Returns the minimal pool size for indication connection handlers
PropertiesgetLocalProperties()
Returns the properties local to the current thread
StringgetLocalProperty(String pKey)
Returns a value from the local properties for a given name
LevelgetLogConsoleLevel()
Returns the console log level
StringgetLogConsoleType()
Returns the console log type
intgetLogFileCount()
Returns the log file count
LevelgetLogFileLevel()
Returns the log file level
StringgetLogFileLocation()
Returns the log file location
intgetLogFileSizeLimit()
Returns the log file size limit
StringgetSslKeyManagerAlgorithm()
Returns the certificate algorithm the key manager will use
StringgetSslKeyStorePassword()
Returns the password of the keystore.
StringgetSslKeyStorePath()
Returns the file path of the keystore.
StringgetSslKeyStoreType()
Returns the type of the keystore.
StringgetSslProtocol()
getSslProtocol
StringgetSslServerSocketProvider()
Returns the JSSE provider to use for creating ssl server sockets
StringgetSslSocketProvider()
Returns the JSSE provider to use for creating ssl client sockets
StringgetSslTrustManagerAlgorithm()
Returns the certificate algorithm the trust manager will use
StringgetSslTrustStorePassword()
Returns the password of the truststore.
StringgetSslTrustStorePath()
Returns the file path of the truststore.
StringgetSslTrustStoreType()
Returns the type of the truststore.
intgetTraceFileCount()
Returns the trace file count
LevelgetTraceFileLevel()
Returns the trace file level
StringgetTraceFileLocation()
Returns the trace file location
intgetTraceFileSizeLimit()
Returns the trace file count
booleanisCimXmlTracingEnabled()
Returns the state of CIM-XML tracing
static booleanisConfigurationLoadSuccessful()
Returns if the configuration was successfully loaded from the configuration file
booleanisDefaultAuthorizationEnabled()
isDefaultAuthorizationEnabled
booleanisGlobal()
Returns whether this configuration is the global one
booleanisHttpChunked()
Returns the state of chunking enablement
booleanisHttpContentLengthRetryEnabled()
Returns if the content length retry feature is enabled
booleanisHttpMPost()
Returns the state of MPOST enablement
static voidloadGlobalConfiguration()
Loads the global configuration from the configuration file
voidsetCustomSocketFactory(SocketFactory pFactory)
Sets a custom socket factory.
voidsetDomainProperties(Properties pDomainProperties)
Sets the domain properties
voidsetDomainProperty(String pKey, String pValue)
Sets a property value of the domain properties
voidsetLocalProperties(Properties pLocalProperties)
Sets the properties local to the current thread
voidsetLocalProperty(String pKey, String pValue)
Sets a property value of the local properties
booleanstrictEmbObjTypes()
strictEmbObjTypes
booleansynchronizedSslHandshake()
synchronizedSslHandshake

Constructor Detail

WBEMConfiguration

public WBEMConfiguration(Properties pDomainProperties)
Ctor.

Parameters: pDomainProperties The domain specific properties of this configuration. Domain specific properties are treated as an overlay on the global properties in the System class.

Throws: NullPointerException If pDomainProperties is null

Method Detail

getActiveConfigURL

public static String getActiveConfigURL()
Returns the URL of the active configuration file. This is the file used to initialize the global configuration.

Returns: The URL of the active configuration file.

getCimXmlEmbObjBuilder

public String getCimXmlEmbObjBuilder()
getCimXmlEmbObjBuilder

Returns: configuration property for the embedded object builder

getCimXmlParser

public String getCimXmlParser()
Return the XML parser to use for processing operation responses

Returns: The XML parser

getConfigurationLoadException

public static Exception getConfigurationLoadException()
Returns the exception caught during configuration load, load failed.

Returns: The exception or null if none was caught.

getCustomSocketFactory

public SocketFactory getCustomSocketFactory()
Returns the custom socket factory

Returns: The factory if set, null otherwise

getDefaultCredentials

public String getDefaultCredentials()
getDefaultCredentials

Returns: default value of Credentials

getDefaultPrincipal

public String getDefaultPrincipal()
getDefaultPrincipal

Returns: default value of Principal

getDomainProperties

public Properties getDomainProperties()
Returns the domain properties

Returns: The domain properties.

getDomainProperty

public String getDomainProperty(String pKey)
Returns a value from the domain properties for a given name

Parameters: pKey The name of the property

Returns: The value

getGlobalConfiguration

public static WBEMConfiguration getGlobalConfiguration()
Returns the global configuration

Returns: The global configuration

getHttpAuthenticationModule

public String getHttpAuthenticationModule()
Returns the Java class name of http authentication module to use

Returns: The http authentication module's class name

getHttpConnectRetriesCount

public int getHttpConnectRetriesCount()
Returns the number of retries the client will attempt when the connection was refused.

Returns: The number of retries

getHttpContentLengthThreshold

public int getHttpContentLengthThreshold()
Returns the threshold for the content length retry algorithm

Returns: The threshold

getHttpPoolSize

public int getHttpPoolSize()
Returns the http pool size

Returns: The http pool size

getHttpTimeout

public int getHttpTimeout()
Returns the http timeout

Returns: The http timeout

getHttpVersion

public String getHttpVersion()
Returns the http version to use

Returns: The http version

getListenerBacklog

public int getListenerBacklog()
Returns the backlog that is tolerated before the thread pool creates an additional handler

Returns: The backlog

getListenerHttpTimeout

public int getListenerHttpTimeout()
Returns the http timeout for indication connection handlers

Returns: The timeout

getListenerMaxIdle

public long getListenerMaxIdle()
Returns the maximal idle time that is tolerated for a connection handler

Returns: The maximal idle time

getListenerMaxPoolSize

public int getListenerMaxPoolSize()
Returns the maximal pool size for indication connection handlers

Returns: The maximal pool size

getListenerMinPoolSize

public int getListenerMinPoolSize()
Returns the minimal pool size for indication connection handlers

Returns: The minimal pool size

getLocalProperties

public Properties getLocalProperties()
Returns the properties local to the current thread

Returns: The local properties.

getLocalProperty

public String getLocalProperty(String pKey)
Returns a value from the local properties for a given name

Parameters: pKey The name of the property

Returns: The value

getLogConsoleLevel

public Level getLogConsoleLevel()
Returns the console log level

Returns: The console log level

getLogConsoleType

public String getLogConsoleType()
Returns the console log type

Returns: The console log type

getLogFileCount

public int getLogFileCount()
Returns the log file count

Returns: The log file count

getLogFileLevel

public Level getLogFileLevel()
Returns the log file level

Returns: The log file level

getLogFileLocation

public String getLogFileLocation()
Returns the log file location

Returns: The log file location

getLogFileSizeLimit

public int getLogFileSizeLimit()
Returns the log file size limit

Returns: The log file size limit

getSslKeyManagerAlgorithm

public String getSslKeyManagerAlgorithm()
Returns the certificate algorithm the key manager will use

Returns: The key mangers algorithm

getSslKeyStorePassword

public String getSslKeyStorePassword()
Returns the password of the keystore.

Returns: The keystore password.

getSslKeyStorePath

public String getSslKeyStorePath()
Returns the file path of the keystore.

Returns: The keystore file path.

getSslKeyStoreType

public String getSslKeyStoreType()
Returns the type of the keystore.

Returns: The keystore type.

getSslProtocol

public String getSslProtocol()
getSslProtocol

Returns: The SSL protocol for SSLContext.getInstance()

getSslServerSocketProvider

public String getSslServerSocketProvider()
Returns the JSSE provider to use for creating ssl server sockets

Returns: The JSSE provider for server sockets

getSslSocketProvider

public String getSslSocketProvider()
Returns the JSSE provider to use for creating ssl client sockets

Returns: The JSSE provider for client sockets

getSslTrustManagerAlgorithm

public String getSslTrustManagerAlgorithm()
Returns the certificate algorithm the trust manager will use

Returns: The trust mangers algorithm

getSslTrustStorePassword

public String getSslTrustStorePassword()
Returns the password of the truststore.

Returns: The truststore password.

getSslTrustStorePath

public String getSslTrustStorePath()
Returns the file path of the truststore.

Returns: The truststore file path.

getSslTrustStoreType

public String getSslTrustStoreType()
Returns the type of the truststore.

Returns: The truststore type.

getTraceFileCount

public int getTraceFileCount()
Returns the trace file count

Returns: The trace file count

getTraceFileLevel

public Level getTraceFileLevel()
Returns the trace file level

Returns: The trace file level

getTraceFileLocation

public String getTraceFileLocation()
Returns the trace file location

Returns: The trace file location

getTraceFileSizeLimit

public int getTraceFileSizeLimit()
Returns the trace file count

Returns: The trace file count

isCimXmlTracingEnabled

public boolean isCimXmlTracingEnabled()
Returns the state of CIM-XML tracing

Returns: true if tracing is enabled, false otherwise

isConfigurationLoadSuccessful

public static boolean isConfigurationLoadSuccessful()
Returns if the configuration was successfully loaded from the configuration file

Returns: true if the configuration was successfully loaded from the configuration file, false otherwise

isDefaultAuthorizationEnabled

public boolean isDefaultAuthorizationEnabled()
isDefaultAuthorizationEnabled

Returns: true if default authorization is enabled

isGlobal

public boolean isGlobal()
Returns whether this configuration is the global one

Returns: true if this is the global configuration

isHttpChunked

public boolean isHttpChunked()
Returns the state of chunking enablement

Returns: true if chunking is enabled, false otherwise

isHttpContentLengthRetryEnabled

public boolean isHttpContentLengthRetryEnabled()
Returns if the content length retry feature is enabled

Returns: true if content length retry is enabled, false otherwise

isHttpMPost

public boolean isHttpMPost()
Returns the state of MPOST enablement

Returns: true if MPOST is enabled, false otherwise

loadGlobalConfiguration

public static void loadGlobalConfiguration()
Loads the global configuration from the configuration file

setCustomSocketFactory

public void setCustomSocketFactory(SocketFactory pFactory)
Sets a custom socket factory.

Parameters: pFactory The factory

setDomainProperties

public void setDomainProperties(Properties pDomainProperties)
Sets the domain properties

Parameters: pDomainProperties The new value

setDomainProperty

public void setDomainProperty(String pKey, String pValue)
Sets a property value of the domain properties

Parameters: pKey The name of property pValue The new value

setLocalProperties

public void setLocalProperties(Properties pLocalProperties)
Sets the properties local to the current thread

Parameters: pLocalProperties The new value

setLocalProperty

public void setLocalProperty(String pKey, String pValue)
Sets a property value of the local properties

Parameters: pKey The name of property pValue The new value

strictEmbObjTypes

public boolean strictEmbObjTypes()
strictEmbObjTypes

Returns: true if EmbeddedObject exactly means Embedded Class

synchronizedSslHandshake

public boolean synchronizedSslHandshake()
synchronizedSslHandshake

Returns: true if SSL handshakes should be synchronized

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