org.sblim.cimclient

Interface WBEMClientSBLIM

public interface WBEMClientSBLIM extends WBEMClient

Class WBEMClientSBLIM contains the SBLIM CIM Client specific extensions to the WBEMClient interface.

See Also:

Method Summary
SocketFactorygetCustomSocketFactory()
Gets the custom socket factory if one is set.
PropertiesgetLocalProperties()
Returns the configuration properties that are local to the current thread.
PropertiesgetProperties()
Returns the client specific configuration properties.
StringgetProperty(String pKey)
Returns the effective value of a given configuration property.
voidsetCustomSocketFactory(SocketFactory pFactory)
Sets a custom socket factory.
voidsetLocalProperties(Properties pProperties)
Sets the configuration properties that are local to the current thread.
voidsetLocalProperty(String pKey, String pValue)
Sets a local configuration property for the current thread.
voidsetProperties(Properties pProperties)
Sets the client specific configuration properties.
voidsetProperty(String pKey, String pValue)
Sets a client specific configuration property.

Method Detail

getCustomSocketFactory

public SocketFactory getCustomSocketFactory()
Gets the custom socket factory if one is set. The client uses this factory for socket creation instead of the default one.

Returns: The custom factory used for socket creation. null indicates set the JRE default factory is used.

getLocalProperties

public Properties getLocalProperties()
Returns the configuration properties that are local to the current thread. Note that only these properties are returned that override the global and the client settings. The global settings can be accessed via the java.lang.System class, the client setting via getProperties().
If the no client specific configuration is set, this method returns null

Returns: The configuration properties

See Also: System#getProperties() getProperties

getProperties

public Properties getProperties()
Returns the client specific configuration properties. Note that only these properties are returned that override the global settings. The global settings can be accessed via the java.lang.System class.
If the no client specific configuration is set, this method returns null

Returns: The configuration properties

See Also: System#getProperties()

getProperty

public String getProperty(String pKey)
Returns the effective value of a given configuration property. The method will return the local value of the current thread if one was set or otherwise client specific value if one was set or otherwise the global value if one was set or otherwise the default value. Valid property names can be found in the WBEMConfigurationProperties interface.

Parameters: pKey The name of the configuration property

Returns: The value of the given configuration property

See Also: WBEMConfigurationProperties

setCustomSocketFactory

public void setCustomSocketFactory(SocketFactory pFactory)
Sets a custom socket factory. The client will use this factory for socket creation instead of the JRE default.

Parameters: pFactory The factory to use for socket creation. null resets to the JRE default factory.

Throws: UnsupportedOperationException Some protocols might not communicate via TCP sockets

setLocalProperties

public void setLocalProperties(Properties pProperties)
Sets the configuration properties that are local to the current thread. Any previously set local properties (of the current thread) are overwritten. The given properties are handled as an overlay on the global settings and the client settings. That means that properties specified here override the corresponding properties whereas properties not specified here are taken from the client or global properties. The global settings can be accessed via the java.lang.System class, the client setting via getProperties().

Parameters: pProperties The thread specific properties. null remove the local setting of the current thread.

See Also: System#setProperties(Properties) setProperties

setLocalProperty

public void setLocalProperty(String pKey, String pValue)
Sets a local configuration property for the current thread. This property will override the corresponding global and client property for this client instance. The global settings can be accessed via the java.lang.System class, the client setting via getProperties(). Valid property names can be found in the WBEMConfigurationProperties interface. Unknown properties are ignored.

Parameters: pKey The name of the configuration property pValue The value of the configuration property. null resets to the global setting.

See Also: WBEMConfigurationProperties System#setProperty(String, String) WBEMClientSBLIM

setProperties

public void setProperties(Properties pProperties)
Sets the client specific configuration properties. Any previously set client specific properties are overwritten. The given properties are handled as an overlay on the global settings. That means that properties specified here override the corresponding global properties whereas properties not specified here are taken from the global properties. The global settings can be accessed via the java.lang.System class.

Parameters: pProperties The session specific properties. null resets this client to the global settings.

See Also: System#setProperties(Properties)

setProperty

public void setProperty(String pKey, String pValue)
Sets a client specific configuration property. This property will override the corresponding global property for this client instance. The global settings can be accessed via the java.lang.System class. Valid property names can be found in the WBEMConfigurationProperties interface. Unknown properties are ignored.

Parameters: pKey The name of the configuration property pValue The value of the configuration property. null resets to the global setting.

See Also: WBEMConfigurationProperties System#setProperty(String, String)

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