org.sblim.cimclient
Interface WBEMClientSBLIM

All Superinterfaces:
WBEMClient
All Known Implementing Classes:
WBEMClientCIMXML

public interface WBEMClientSBLIM
extends WBEMClient

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

See Also:
WBEMClient

Method Summary
 javax.net.SocketFactory getCustomSocketFactory()
          Gets the custom socket factory if one is set.
 java.util.Properties getLocalProperties()
          Returns the configuration properties that are local to the current thread.
 java.util.Properties getProperties()
          Returns the client specific configuration properties.
 java.lang.String getProperty(java.lang.String pKey)
          Returns the effective value of a given configuration property.
 void setCustomSocketFactory(javax.net.SocketFactory pFactory)
          Sets a custom socket factory.
 void setLocalProperties(java.util.Properties pProperties)
          Sets the configuration properties that are local to the current thread.
 void setLocalProperty(java.lang.String pKey, java.lang.String pValue)
          Sets a local configuration property for the current thread.
 void setProperties(java.util.Properties pProperties)
          Sets the client specific configuration properties.
 void setProperty(java.lang.String pKey, java.lang.String pValue)
          Sets a client specific configuration property.
 
Methods inherited from interface javax.wbem.client.WBEMClient
associatorClasses, associatorInstances, associatorNames, associatorPaths, associators, associators, close, closeEnumeration, createClass, createInstance, deleteClass, deleteInstance, deleteQualifierType, enumerateClasses, enumerateClassNames, enumerateInstanceNames, enumerateInstancePaths, enumerateInstances, enumerateInstances, enumerateQualifierTypes, enumerationCount, execQuery, execQueryInstances, getClass, getInstance, getInstancePaths, getInstances, getInstancesWithPath, getQualifierType, initialize, invokeMethod, modifyClass, modifyInstance, referenceClasses, referenceInstances, referenceNames, referencePaths, references, references, setLocales, setQualifierType
 

Method Detail

getProperties

java.util.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()

setProperties

void setProperties(java.util.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)

getProperty

java.lang.String getProperty(java.lang.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.

Specified by:
getProperty in interface WBEMClient
Parameters:
pKey - The name of the configuration property
Returns:
The value of the given configuration property
See Also:
WBEMConfigurationProperties

setProperty

void setProperty(java.lang.String pKey,
                 java.lang.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.

Specified by:
setProperty in interface WBEMClient
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)

getLocalProperties

java.util.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()

setLocalProperties

void setLocalProperties(java.util.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(Properties)

setLocalProperty

void setLocalProperty(java.lang.String pKey,
                      java.lang.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), setProperty(String, String)

getCustomSocketFactory

javax.net.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.

setCustomSocketFactory

void setCustomSocketFactory(javax.net.SocketFactory pFactory)
                            throws java.lang.UnsupportedOperationException
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:
java.lang.UnsupportedOperationException - Some protocols might not communicate via TCP sockets


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