javax.wbem.provider
Interface ProviderHandle

All Superinterfaces:
WBEMClient

public interface ProviderHandle
extends WBEMClient

This interface is used by providers to get information regarding the current request or to act as a client.

Since:
JSR48 1.0.0

Field Summary
static String PROP_CLIENTHOST
           
static String PROP_PRINCIPAL
           
static String PROP_ROLE
           
static String PROP_SERVERHOST
           
static String PROP_SERVERPORT
           
 
Method Summary
 void deliverEvent(CIMInstance indication)
          Method used by indication providers to deliver indications to the CIM object manager.
 void deliverEvent(CIMInstance indication, CIMObjectPath[] matchedFilterOps)
          Method used by indication providers to deliver indications to the CIM object manager.
 void deliverIndication(CIMInstance indication, CIMObjectPath[] listeners)
          Method used by indication providers to deliver indications to the CIM object manager.
 AssociatorProvider getInternalAssociatorProvider()
          Get the handle to an internal instance provider which can be used to traverse static association instances.
 InstanceProvider getInternalInstanceProvider()
          Get the handle to an internal instance provider which can be used to store static instance information for the provider.
 String getProperty(String name)
          Get a Property Value.
 Locale[] getRequestedLocales()
          Get the ordered list of locales requested from the client.
 void setLocales(Locale[] pLocales)
          This method is not supported from the ProviderHandle This method will always throw an UnsupportedOperationException
 void setProperty(String name, String value)
          This method is not supported from the ProviderHandle This method will always throw an IllegalArgumentException
 
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, setQualifierType
 

Field Detail

PROP_CLIENTHOST

static final String PROP_CLIENTHOST
See Also:
Constant Field Values

PROP_PRINCIPAL

static final String PROP_PRINCIPAL
See Also:
Constant Field Values

PROP_ROLE

static final String PROP_ROLE
See Also:
Constant Field Values

PROP_SERVERHOST

static final String PROP_SERVERHOST
See Also:
Constant Field Values

PROP_SERVERPORT

static final String PROP_SERVERPORT
See Also:
Constant Field Values
Method Detail

deliverEvent

void deliverEvent(CIMInstance indication)
Method used by indication providers to deliver indications to the CIM object manager. The CIM object manager event service subsequently takes care of delivering the event to subscribers.

Parameters:
indication - The actual indication

deliverEvent

void deliverEvent(CIMInstance indication,
                  CIMObjectPath[] matchedFilterOps)
Method used by indication providers to deliver indications to the CIM object manager. The event provider specifies which filters matched, and the CIMOM simply forwards the indications to the handlers subscribed to the filters.

Parameters:
indication - The actual indication
matchedFilterOps - Array of object paths to the matched filters. If an object path is null, it is ignored. If any filter is invalid, for example, if it cannot be found, then the indication is not delivered to any of the filters.

deliverIndication

void deliverIndication(CIMInstance indication,
                       CIMObjectPath[] listeners)
Method used by indication providers to deliver indications to the CIM object manager. The event provider specifies which filters matched, and the CIMOM simply forwards the indications to the handlers subscribed to the filters.

Parameters:
indication - The actual indication
listeners - Array of object paths that matched the CIM_ListenerDestination instances to deliver the indications to.

getInternalAssociatorProvider

AssociatorProvider getInternalAssociatorProvider()
Get the handle to an internal instance provider which can be used to traverse static association instances.

Returns:
The CIMAssociatorProvider handle

getInternalInstanceProvider

InstanceProvider getInternalInstanceProvider()
Get the handle to an internal instance provider which can be used to store static instance information for the provider.

Returns:
The CIMInstanceProvider handle

getProperty

String getProperty(String name)
Get a Property Value. The ProviderHandle supports the following properties:
 javax.wbem.provider.Role
      The requested role to assume. This will be null if a 
      role was not specified.
 javax.wbem.provider.Principal
      The Principal (e.g. user name) that made this request 
 javax.wbem.provider.ClientHost
      The client host that this request came from. This could
      be in the form of a IP Address (IPV4 or IPV6) or the 
      host name.
 javax.wbem.provider.ServerHost
      The host that the WBEM Server is running. The WBEM Server
      may be running on a system that has multiple interfaces, but
      is only configured for one of the interfaces.
 javax.wbem.provider.ServerPort
      The port that the WBEM Server is running. 
 

Specified by:
getProperty in interface WBEMClient
Parameters:
name - The name of the property
Returns:
The value of the property

getRequestedLocales

Locale[] getRequestedLocales()
Get the ordered list of locales requested from the client. Providers should support the first language supported in the list.

Returns:
An ordered array of the requested Locales

setLocales

void setLocales(Locale[] pLocales)
This method is not supported from the ProviderHandle This method will always throw an UnsupportedOperationException

Specified by:
setLocales in interface WBEMClient
Parameters:
pLocales - An array of locales in order of priority of preference.
Throws:
UnsupportedOperationException

setProperty

void setProperty(String name,
                 String value)
This method is not supported from the ProviderHandle This method will always throw an IllegalArgumentException

Specified by:
setProperty in interface WBEMClient
Parameters:
name - The name of the property
value - The value of the property
Throws:
IllegalArgumentException


Copyright © 2002-2008 WBEM Solutions, Inc. All Rights Reserved.