Interface WBEMClientSBLIM
- All Superinterfaces:
WBEMClient
- All Known Implementing Classes:
WBEMClientCIMXML
Class WBEMClientSBLIM contains the SBLIM CIM Client specific extensions to
the WBEMClient interface.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionenumerateNamespaces
(String pNamespace) Enumerate the names of the instances of CIM namespaces.Gets the custom socket factory if one is set.Returns the configuration properties that are local to the current thread.Returns the client specific configuration properties.getProperty
(String pKey) Returns the effective value of a given configuration property.void
initialize
(URI pUri, Subject pSubject, Locale[] pLocales) Initialize the client connection.boolean
isActive()
Returns an indication of whether the client is active (initialized and not closed) or inactive (not initialized or closed).boolean
sendIndication
(URI pRecipient, CIMInstance pIndication) Sends the indication to the specified recipient.void
setCustomSocketFactory
(SocketFactory pFactory) Sets a custom socket factory.void
setLocalProperties
(Properties pProperties) Sets the configuration properties that are local to the current thread.void
setLocalProperty
(String pKey, String pValue) Sets a local configuration property for the current thread.void
setProperties
(Properties pProperties) Sets the client specific configuration properties.void
setProperty
(String pKey, String pValue) Sets a client specific configuration property.Methods inherited from interface WBEMClient
associatorClasses, associatorInstances, associatorNames, associatorPaths, 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, setLocales, setQualifierType
-
Method Details
-
initialize
void initialize(URI pUri, Subject pSubject, Locale[] pLocales) throws IllegalArgumentException, WBEMException Initialize the client connection. This must be called before any operations. This must only be called once.- Parameters:
pUri
- The protocol and host to use. Any other fields will be ignored.pSubject
- The principal/credential pairs for this connection.pLocales
- An array of locales in order of priority of preference.- Throws:
IllegalArgumentException
- If the host or scheme portion of the object path is null, or if the protocol is not supported.WBEMException
- If the protocol adapter or security cannot be initialized.
-
getProperties
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 thejava.lang.System
class.
If the no client specific configuration is set, this method returnsnull
- Returns:
- The configuration properties
- See Also:
-
setProperties
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 thejava.lang.System
class.- Parameters:
pProperties
- The session specific properties.null
resets this client to the global settings.- See Also:
-
getProperty
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 theWBEMConfigurationProperties
interface.- Specified by:
getProperty
in interfaceWBEMClient
- Parameters:
pKey
- The name of the configuration property- Returns:
- The value of the given configuration property
- See Also:
-
setProperty
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 thejava.lang.System
class. Valid property names can be found in theWBEMConfigurationProperties
interface. Unknown properties are ignored.- Specified by:
setProperty
in interfaceWBEMClient
- Parameters:
pKey
- The name of the configuration propertypValue
- The value of the configuration property.null
resets to the global setting.- See Also:
-
getLocalProperties
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 thejava.lang.System
class, the client setting viagetProperties()
.
If the no client specific configuration is set, this method returnsnull
- Returns:
- The configuration properties
- See Also:
-
setLocalProperties
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 thejava.lang.System
class, the client setting viagetProperties()
.- Parameters:
pProperties
- The thread specific properties.null
remove the local setting of the current thread.- See Also:
-
setLocalProperty
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 thejava.lang.System
class, the client setting viagetProperties()
. Valid property names can be found in theWBEMConfigurationProperties
interface. Unknown properties are ignored.- Parameters:
pKey
- The name of the configuration propertypValue
- The value of the configuration property.null
resets to the global setting.- See Also:
-
getCustomSocketFactory
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
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
-
enumerateNamespaces
Enumerate the names of the instances of CIM namespaces.- Parameters:
pNamespace
- The Interop Namespace, if known. If null, the default Interop Namespace names defined by DSP1033 are used.- Returns:
- A
CloseableIterator
ofCIMObjectPath
s. - Throws:
WBEMException
- If unsuccessful, one of the following status codes must be returned. The ORDERED list is:CIM_ERR_FAILED (some other unspecified error occurred)
-
isActive
boolean isActive()Returns an indication of whether the client is active (initialized and not closed) or inactive (not initialized or closed).- Returns:
true
if client is active,false
otherwise.
-
sendIndication
Sends the indication to the specified recipient.- Parameters:
pRecipient
- URI of indication recipient.pIndication
- Indication.- Returns:
true
if indication received successfully,false
otherwise.- Throws:
WBEMException
- If unsuccessful, one of the following status codes must be returned. The ORDERED list is:CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters) CIM_ERR_FAILED (some other unspecified error occurred)
-