Class WBEMConfiguration
- java.lang.Object
-
- org.sblim.cimclient.internal.util.WBEMConfiguration
-
public class WBEMConfiguration extends java.lang.Object
Class WBEMConfigurationFile is responsible for initializing the the configuration properties from the configuration file.- Threading considerations:
- This class was designed as thread-safe
-
-
Constructor Summary
Constructors Constructor Description WBEMConfiguration(java.util.Properties pDomainProperties)
Ctor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allowEmptyLocalNameSpacePath()
Returns whether the client will allow emptyLOCALNAMESPACEPATH
elements in incoming CIM-XML responses.static java.lang.String
getActiveConfigFullURL()
Returns the full URL of the active configuration file.static java.lang.String
getActiveConfigURL()
Returns the URL of the active configuration file.java.lang.String
getCimXmlEmbObjBuilder()
getCimXmlEmbObjBuilderjava.lang.String
getCimXmlParser()
Return the XML parser to use for processing operation responsesjava.lang.String
getCimXmlTraceStream()
Returns the CIM-XML trace stream to be used if application does not set one of its ownstatic java.lang.Exception
getConfigurationLoadException()
Returns the exception caught during configuration load, load failed.javax.net.SocketFactory
getCustomSocketFactory()
Returns the custom socket factoryjava.lang.String
getDefaultCredentials()
getDefaultCredentialsjava.lang.String
getDefaultPrincipal()
getDefaultPrincipaljava.util.Properties
getDomainProperties()
Returns the domain propertiesjava.lang.String
getDomainProperty(java.lang.String pKey)
Returns a value from the domain properties for a given namestatic WBEMConfiguration
getGlobalConfiguration()
Returns the global configurationjava.lang.String
getHttpAuthenticationModule()
Returns the Java class name of http authentication module to useint
getHttpConnectRetriesCount()
Returns the number of retries the client will attempt when the connection was refused.int
getHttpContentLengthThreshold()
Returns the threshold for the content length retry algorithmint
getHttpPoolSize()
Returns the http pool sizeint
getHttpTimeout()
Returns the http timeoutjava.lang.String
getHttpVersion()
Returns the http version to usejava.lang.String
getHttpWwwAuthenticateInfo()
Returns the WWW-Authenticate info to use on first requestboolean
getListenerAddSenderIPAddress()
Returns whether sender IP property should be added to indicationsint
getListenerBacklog()
Returns the backlog that is tolerated before the thread pool creates an additional handlerlong
getListenerDeliveryRetryAttempts()
Returns the default value to use for CIM_IndicationService DeliveryRetryAttemptslong
getListenerDeliveryRetryInterval()
Returns the default value to use for CIM_IndicationService DeliveryRetryIntervalint
getListenerHttpHeaderTimeout()
Returns the http header timeout for indication connection handlersint
getListenerHttpTimeout()
Returns the http timeout for indication connection handlersjava.lang.String
getListenerIndicationTraceFilter()
Returns the filter to use for tracing of incoming indications at the FINE levelint
getListenerMaxAllowedTimeouts()
Returns the maximum allowed http timeouts before IP is blockedlong
getListenerMaxIdle()
Returns the maximal idle time that is tolerated for a connection handlerint
getListenerMaxPoolSize()
Returns the maximal pool size for indication connection handlersint
getListenerMaxQueuedEvents()
Returns the maximal queue size for indications awaiting deliveryint
getListenerMaxQueueSize()
Returns the maximal queue size for pending indication connectionsint
getListenerMinPoolSize()
Returns the minimal pool size for indication connection handlersjava.util.Properties
getLocalProperties()
Returns the properties local to the current threadjava.lang.String
getLocalProperty(java.lang.String pKey)
Returns a value from the local properties for a given namejava.util.logging.Level
getLogConsoleLevel()
Returns the console log leveljava.lang.String
getLogConsoleType()
Returns the console log typeint
getLogFileCount()
Returns the log file countjava.util.logging.Level
getLogFileLevel()
Returns the log file leveljava.lang.String
getLogFileLocation()
Returns the log file locationint
getLogFileSizeLimit()
Returns the log file size limitint
getReliableIndicationHashtableCapacity()
Returns the initial capacity of the hash table used to handle reliable indicationsint
getSocketConnectTimeout()
Returns the socket connect timeoutint
getSocketIdleTimeout()
Returns the socket idle timeoutjava.lang.String
getSslClientCipherSuitesToDisable()
Returns the comma-separated list of cipher suites to be disabled by client.boolean
getSslClientPeerVerification()
Returns whether the client will attempt to authenticate the CIMOMjava.lang.String
getSslClientProtocol()
getSslClientProtocoljava.lang.String
getSslKeyManagerAlgorithm()
Returns the certificate algorithm the key manager will usejava.lang.String
getSslKeyStorePassword()
Returns the password of the keystore.java.lang.String
getSslKeyStorePath()
Returns the file path of the keystore.java.lang.String
getSslKeyStoreType()
Returns the type of the keystore.java.lang.String
getSslListenerCipherSuitesToDisable()
Returns the comma-separated list of cipher suites to be disabled by listener.java.lang.String
getSslListenerPeerVerification()
Returns how the listener will handle to authentication of the indication sender endpoint.java.lang.String
getSslListenerProtocol()
getSslListenerProtocoljava.lang.String
getSslProtocol()
getSslProtocoljava.lang.String
getSslServerSocketProvider()
Returns the JSSE provider to use for creating ssl server socketsjava.lang.String
getSslSocketProvider()
Returns the JSSE provider to use for creating ssl client socketsjava.lang.String
getSslTrustManagerAlgorithm()
Returns the certificate algorithm the trust manager will usejava.lang.String
getSslTrustStorePassword()
Returns the password of the truststore.java.lang.String
getSslTrustStorePath()
Returns the file path of the truststore.java.lang.String
getSslTrustStoreType()
Returns the type of the truststore.int
getTraceFileCount()
Returns the trace file countjava.util.logging.Level
getTraceFileLevel()
Returns the trace file leveljava.lang.String
getTraceFileLocation()
Returns the trace file locationint
getTraceFileSizeLimit()
Returns the trace file countboolean
isCimXmlTracingEnabled()
Returns the state of CIM-XML tracingstatic boolean
isConfigurationLoadSuccessful()
Returns if the configuration was successfully loaded from the configuration fileboolean
isDefaultAuthorizationEnabled()
isDefaultAuthorizationEnabledboolean
isGlobal()
Returns whether this configuration is the global oneboolean
isGzipEncodingEnabled()
Returns the state of gzip encoding enablement.boolean
isHttpChunked()
Returns the state of chunking enablementboolean
isHttpContentLengthRetryEnabled()
Returns if the content length retry feature is enabledboolean
isHttpMPost()
Returns the state of MPOST enablementboolean
isReliableIndicationEnabled()
Returns the state of reliable indication supportstatic void
loadGlobalConfiguration()
Loads the global configuration from the configuration fileboolean
performSslHandshake()
performSslHandshakevoid
setCustomSocketFactory(javax.net.SocketFactory pFactory)
Sets a custom socket factory.void
setDomainProperties(java.util.Properties pDomainProperties)
Sets the domain propertiesvoid
setDomainProperty(java.lang.String pKey, java.lang.String pValue)
Sets a property value of the domain propertiesvoid
setLocalProperties(java.util.Properties pLocalProperties)
Sets the properties local to the current threadvoid
setLocalProperty(java.lang.String pKey, java.lang.String pValue)
Sets a property value of the local propertiesboolean
socketConnectWithTimeout()
socketConnectWithTimeoutboolean
strictEmbObjTypes()
strictEmbObjTypesboolean
synchronizedSslHandshake()
synchronizedSslHandshakeboolean
synchronizeNumericKeyDataTypes()
Returns whether the client will synchronize the data types of all numeric keys in aCIMInstance
'sCIMObjectPath
match those of the corresponding keys within theCIMInstance
'sCIMProperty[]
.boolean
upperCaseEmbObjEntities()
upperCaseEmbObjEntitiesboolean
verifyJavaLangDoubleStrings()
Returns whether the client will attempt to verify strings passed into thejava.lang.Double
constructor or itsparseDouble
method won't hang the JVM in an infinite loop.
-
-
-
Constructor Detail
-
WBEMConfiguration
public WBEMConfiguration(java.util.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 theSystem
class.- Throws:
java.lang.NullPointerException
- If pDomainProperties isnull
-
-
Method Detail
-
loadGlobalConfiguration
public static void loadGlobalConfiguration()
Loads the global configuration from the configuration file
-
getActiveConfigURL
public static java.lang.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.
-
getActiveConfigFullURL
public static java.lang.String getActiveConfigFullURL()
Returns the full URL of the active configuration file. This is the file used to initialize the global configuration.- Returns:
- The full URL of the active configuration file.
-
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
-
getGlobalConfiguration
public static WBEMConfiguration getGlobalConfiguration()
Returns the global configuration- Returns:
- The global configuration
-
getConfigurationLoadException
public static java.lang.Exception getConfigurationLoadException()
Returns the exception caught during configuration load, load failed.- Returns:
- The exception or
null
if none was caught.
-
isGlobal
public boolean isGlobal()
Returns whether this configuration is the global one- Returns:
true
if this is the global configuration
-
getDomainProperties
public java.util.Properties getDomainProperties()
Returns the domain properties- Returns:
- The domain properties.
-
setDomainProperties
public void setDomainProperties(java.util.Properties pDomainProperties)
Sets the domain properties- Parameters:
pDomainProperties
- The new value
-
getDomainProperty
public java.lang.String getDomainProperty(java.lang.String pKey)
Returns a value from the domain properties for a given name- Parameters:
pKey
- The name of the property- Returns:
- The value
-
setDomainProperty
public void setDomainProperty(java.lang.String pKey, java.lang.String pValue)
Sets a property value of the domain properties- Parameters:
pKey
- The name of propertypValue
- The new value
-
getLocalProperties
public java.util.Properties getLocalProperties()
Returns the properties local to the current thread- Returns:
- The local properties.
-
setLocalProperties
public void setLocalProperties(java.util.Properties pLocalProperties)
Sets the properties local to the current thread- Parameters:
pLocalProperties
- The new value
-
getLocalProperty
public java.lang.String getLocalProperty(java.lang.String pKey)
Returns a value from the local properties for a given name- Parameters:
pKey
- The name of the property- Returns:
- The value
-
setLocalProperty
public void setLocalProperty(java.lang.String pKey, java.lang.String pValue)
Sets a property value of the local properties- Parameters:
pKey
- The name of propertypValue
- The new value
-
setCustomSocketFactory
public void setCustomSocketFactory(javax.net.SocketFactory pFactory)
Sets a custom socket factory.- Parameters:
pFactory
- The factory
-
getCustomSocketFactory
public javax.net.SocketFactory getCustomSocketFactory()
Returns the custom socket factory- Returns:
- The factory if set,
null
otherwise
-
getLogConsoleLevel
public java.util.logging.Level getLogConsoleLevel()
Returns the console log level- Returns:
- The console log level
-
getLogConsoleType
public java.lang.String getLogConsoleType()
Returns the console log type- Returns:
- The console log type
-
getLogFileLevel
public java.util.logging.Level getLogFileLevel()
Returns the log file level- Returns:
- The log file level
-
getLogFileLocation
public java.lang.String getLogFileLocation()
Returns the log file location- Returns:
- The log file location
-
getLogFileCount
public int getLogFileCount()
Returns the log file count- Returns:
- The log file count
-
getLogFileSizeLimit
public int getLogFileSizeLimit()
Returns the log file size limit- Returns:
- The log file size limit
-
getTraceFileLevel
public java.util.logging.Level getTraceFileLevel()
Returns the trace file level- Returns:
- The trace file level
-
getTraceFileLocation
public java.lang.String getTraceFileLocation()
Returns the trace file location- Returns:
- The trace file location
-
getTraceFileCount
public int getTraceFileCount()
Returns the trace file count- Returns:
- The trace file count
-
getTraceFileSizeLimit
public int getTraceFileSizeLimit()
Returns the trace file count- Returns:
- The trace file count
-
getHttpTimeout
public int getHttpTimeout()
Returns the http timeout- Returns:
- The http timeout
-
getHttpPoolSize
public int getHttpPoolSize()
Returns the http pool size- Returns:
- The http pool size
-
getHttpAuthenticationModule
public java.lang.String getHttpAuthenticationModule()
Returns the Java class name of http authentication module to use- Returns:
- The http authentication module's class name
-
getHttpWwwAuthenticateInfo
public java.lang.String getHttpWwwAuthenticateInfo()
Returns the WWW-Authenticate info to use on first request- Returns:
- The WWW-Authenticate info
-
isHttpMPost
public boolean isHttpMPost()
Returns the state of MPOST enablement- Returns:
true
if MPOST is enabled,false
otherwise
-
isHttpChunked
public boolean isHttpChunked()
Returns the state of chunking enablement- Returns:
true
if chunking is enabled,false
otherwise
-
getHttpVersion
public java.lang.String getHttpVersion()
Returns the http version to use- Returns:
- The http version
-
getSslKeyStorePath
public java.lang.String getSslKeyStorePath()
Returns the file path of the keystore.- Returns:
- The keystore file path.
-
getSslKeyStoreType
public java.lang.String getSslKeyStoreType()
Returns the type of the keystore.- Returns:
- The keystore type.
-
getSslKeyStorePassword
public java.lang.String getSslKeyStorePassword()
Returns the password of the keystore.- Returns:
- The keystore password.
-
getSslTrustStorePath
public java.lang.String getSslTrustStorePath()
Returns the file path of the truststore.- Returns:
- The truststore file path.
-
getSslTrustStoreType
public java.lang.String getSslTrustStoreType()
Returns the type of the truststore.- Returns:
- The truststore type.
-
getSslTrustStorePassword
public java.lang.String getSslTrustStorePassword()
Returns the password of the truststore.- Returns:
- The truststore password.
-
getSslSocketProvider
public java.lang.String getSslSocketProvider()
Returns the JSSE provider to use for creating ssl client sockets- Returns:
- The JSSE provider for client sockets
-
getSslServerSocketProvider
public java.lang.String getSslServerSocketProvider()
Returns the JSSE provider to use for creating ssl server sockets- Returns:
- The JSSE provider for server sockets
-
getSslProtocol
public java.lang.String getSslProtocol()
getSslProtocol- Returns:
- The SSL protocol for SSLContext.getInstance()
-
getSslClientProtocol
public java.lang.String getSslClientProtocol()
getSslClientProtocol- Returns:
- The SSL protocol for SSLContext.getInstance() for client
-
getSslListenerProtocol
public java.lang.String getSslListenerProtocol()
getSslListenerProtocol- Returns:
- The SSL protocol for SSLContext.getInstance() for listener
-
getSslKeyManagerAlgorithm
public java.lang.String getSslKeyManagerAlgorithm()
Returns the certificate algorithm the key manager will use- Returns:
- The key mangers algorithm
-
getSslTrustManagerAlgorithm
public java.lang.String getSslTrustManagerAlgorithm()
Returns the certificate algorithm the trust manager will use- Returns:
- The trust mangers algorithm
-
getSslClientPeerVerification
public boolean getSslClientPeerVerification()
Returns whether the client will attempt to authenticate the CIMOM- Returns:
true
if the client will attempt to authenticate the CIMOM by verifying the server certificatefalse
otherwise
-
getSslListenerPeerVerification
public java.lang.String getSslListenerPeerVerification()
Returns how the listener will handle to authentication of the indication sender endpoint.- Returns:
- The listener peer verification mode
-
getSslClientCipherSuitesToDisable
public java.lang.String getSslClientCipherSuitesToDisable()
Returns the comma-separated list of cipher suites to be disabled by client.- Returns:
- The list of cipher suites
-
getSslListenerCipherSuitesToDisable
public java.lang.String getSslListenerCipherSuitesToDisable()
Returns the comma-separated list of cipher suites to be disabled by listener.- Returns:
- The list of cipher suites
-
getHttpConnectRetriesCount
public int getHttpConnectRetriesCount()
Returns the number of retries the client will attempt when the connection was refused.- Returns:
- The number of retries
-
isHttpContentLengthRetryEnabled
public boolean isHttpContentLengthRetryEnabled()
Returns if the content length retry feature is enabled- Returns:
true
if content length retry is enabled,false
otherwise
-
getHttpContentLengthThreshold
public int getHttpContentLengthThreshold()
Returns the threshold for the content length retry algorithm- Returns:
- The threshold
-
getCimXmlParser
public java.lang.String getCimXmlParser()
Return the XML parser to use for processing operation responses- Returns:
- The XML parser
-
getCimXmlEmbObjBuilder
public java.lang.String getCimXmlEmbObjBuilder()
getCimXmlEmbObjBuilder- Returns:
- configuration property for the embedded object builder
-
strictEmbObjTypes
public boolean strictEmbObjTypes()
strictEmbObjTypes- Returns:
- true if EmbeddedObject exactly means Embedded Class
-
upperCaseEmbObjEntities
public boolean upperCaseEmbObjEntities()
upperCaseEmbObjEntities- Returns:
- true if "EMBEDDEDOBJECT" entity, false if "EmbeddedObject"
-
performSslHandshake
public boolean performSslHandshake()
performSslHandshake- Returns:
- true if SSL handshakes should take place
-
synchronizedSslHandshake
public boolean synchronizedSslHandshake()
synchronizedSslHandshake- Returns:
- true if SSL handshakes should be synchronized
-
socketConnectWithTimeout
public boolean socketConnectWithTimeout()
socketConnectWithTimeout- Returns:
- true if socket connections should be attempted with a timeout
-
getSocketConnectTimeout
public int getSocketConnectTimeout()
Returns the socket connect timeout- Returns:
- The socket connect timeout
-
getSocketIdleTimeout
public int getSocketIdleTimeout()
Returns the socket idle timeout- Returns:
- The socket idle timeout
-
isDefaultAuthorizationEnabled
public boolean isDefaultAuthorizationEnabled()
isDefaultAuthorizationEnabled- Returns:
- true if default authorization is enabled
-
getDefaultPrincipal
public java.lang.String getDefaultPrincipal()
getDefaultPrincipal- Returns:
- default value of Principal
-
getDefaultCredentials
public java.lang.String getDefaultCredentials()
getDefaultCredentials- Returns:
- default value of Credentials
-
isCimXmlTracingEnabled
public boolean isCimXmlTracingEnabled()
Returns the state of CIM-XML tracing- Returns:
true
if tracing is enabled,false
otherwise
-
getCimXmlTraceStream
public java.lang.String getCimXmlTraceStream()
Returns the CIM-XML trace stream to be used if application does not set one of its own- Returns:
- The trace stream
-
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
-
getListenerHttpHeaderTimeout
public int getListenerHttpHeaderTimeout()
Returns the http header timeout for indication connection handlers- Returns:
- The timeout
-
getListenerMaxAllowedTimeouts
public int getListenerMaxAllowedTimeouts()
Returns the maximum allowed http timeouts before IP is blocked- Returns:
- The maximum allowed timeouts
-
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
-
getListenerMaxQueueSize
public int getListenerMaxQueueSize()
Returns the maximal queue size for pending indication connections- Returns:
- The maximal queue size
-
getListenerMaxIdle
public long getListenerMaxIdle()
Returns the maximal idle time that is tolerated for a connection handler- Returns:
- The maximal idle time
-
getListenerMaxQueuedEvents
public int getListenerMaxQueuedEvents()
Returns the maximal queue size for indications awaiting delivery- Returns:
- The maximal queue size
-
isReliableIndicationEnabled
public boolean isReliableIndicationEnabled()
Returns the state of reliable indication support- Returns:
true
if reliable indication support is enabled,false
otherwise
-
getListenerDeliveryRetryAttempts
public long getListenerDeliveryRetryAttempts()
Returns the default value to use for CIM_IndicationService DeliveryRetryAttempts- Returns:
- The default value
-
getListenerDeliveryRetryInterval
public long getListenerDeliveryRetryInterval()
Returns the default value to use for CIM_IndicationService DeliveryRetryInterval- Returns:
- The default value
-
getReliableIndicationHashtableCapacity
public int getReliableIndicationHashtableCapacity()
Returns the initial capacity of the hash table used to handle reliable indications- Returns:
- The default value
-
getListenerIndicationTraceFilter
public java.lang.String getListenerIndicationTraceFilter()
Returns the filter to use for tracing of incoming indications at the FINE level- Returns:
- The indication trace filter
-
getListenerAddSenderIPAddress
public boolean getListenerAddSenderIPAddress()
Returns whether sender IP property should be added to indications- Returns:
true
if sender IP property should be added to indications,false
otherwise
-
verifyJavaLangDoubleStrings
public boolean verifyJavaLangDoubleStrings()
Returns whether the client will attempt to verify strings passed into thejava.lang.Double
constructor or itsparseDouble
method won't hang the JVM in an infinite loop.- Returns:
true
if the client will attempt to verify strings passed toDouble
,false
otherwise
-
synchronizeNumericKeyDataTypes
public boolean synchronizeNumericKeyDataTypes()
Returns whether the client will synchronize the data types of all numeric keys in aCIMInstance
'sCIMObjectPath
match those of the corresponding keys within theCIMInstance
'sCIMProperty[]
.- Returns:
true
if the client will synchronizeCIMInstance
numeric key data types,false
otherwise
-
isGzipEncodingEnabled
public boolean isGzipEncodingEnabled()
Returns the state of gzip encoding enablement.- Returns:
true
if gzip encoding is enabled,false
otherwise
-
allowEmptyLocalNameSpacePath
public boolean allowEmptyLocalNameSpacePath()
Returns whether the client will allow emptyLOCALNAMESPACEPATH
elements in incoming CIM-XML responses.- Returns:
true
if CIM-XML parser should allow emptyLOCALNAMESPACEPATH
elements in incoming responses,false
otherwise
-
-