version 1.16, 2003/10/20 21:00:50
|
version 1.25, 2006/01/30 16:17:07
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// The Open Group, Tivoli Systems |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation, The Open Group. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Chip Vincent (cvincent@us.ibm.com) |
|
// |
|
// Modified By: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_ResponseHandler_h | #ifndef Pegasus_ResponseHandler_h |
|
|
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class ResponseHandlerRep; |
|
|
|
/** | /** |
<p>The <tt>ResponseHandler</tt> class allows a provider | <p>The <tt>ResponseHandler</tt> class allows a provider |
to report operation progress and results to the CIM Server. | to report operation progress and results to the CIM Server. |
|
|
public: | public: |
| |
/** | /** |
Destructor. |
ResponseHandler destructor. |
*/ | */ |
virtual ~ResponseHandler(void); | virtual ~ResponseHandler(void); |
| |
|
|
//virtual void deliver(const Array<T> & objects); | //virtual void deliver(const Array<T> & objects); |
| |
/** | /** |
Inform the CIM Server that delivery of results will begin. |
Inform the CIM server that delivery of results will begin. |
<p>The provider must call <tt>processing</tt> before | <p>The provider must call <tt>processing</tt> before |
attempting to call <tt>deliver</tt>. | attempting to call <tt>deliver</tt>. |
*/ | */ |
virtual void processing(void) = 0; | virtual void processing(void) = 0; |
| |
/** | /** |
Inform the CIM Server that delivery of results is complete. |
Inform the CIM server that delivery of results is complete. |
<p>The provider must call <tt>complete</tt> when all | <p>The provider must call <tt>complete</tt> when all |
results have been delivered. It must not call <tt>deliver</tt> |
results have been delivered. The provider must not call <tt>deliver</tt> |
after calling <tt>complete</tt>.</p> | after calling <tt>complete</tt>.</p> |
*/ | */ |
virtual void complete(void) = 0; | virtual void complete(void) = 0; |
| |
#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES | #ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES |
/** |
/** <I><B>Experimental Interface</B></I><BR> |
Set the context for the results delivered to the CIM Server. | Set the context for the results delivered to the CIM Server. |
<p>The <tt>setContext</tt> function is used by providers to | <p>The <tt>setContext</tt> function is used by providers to |
set a context for the response, in the form of an OperationContext | set a context for the response, in the form of an OperationContext |
|
|
processing before <tt>complete</tt> is called.</p> | processing before <tt>complete</tt> is called.</p> |
<p>Currently supported OperationContext containers: | <p>Currently supported OperationContext containers: |
<li> | <li> |
ContentLanguageListContainer: used to set the ContentLanguages of the |
ContentLanguageListContainer: used to set the ContentLanguageList of the |
results. | results. |
</li> | </li> |
</p> | </p> |
|
|
| |
ResponseHandler& operator=(const ResponseHandler& handler); | ResponseHandler& operator=(const ResponseHandler& handler); |
| |
// |
/** |
// Gets the context for the results delivered to the CIM Server. |
Gets the context for the results delivered to the CIM server. |
// |
*/ |
OperationContext getContext(void) const; | OperationContext getContext(void) const; |
}; | }; |
| |
| |
// |
/** |
// InstanceResponseHandler |
The InstanceResponseHandler class is a subclass to the ResponseHandler class. |
/// |
The InstanceResponseHandler class contains functions that are specific to an |
|
instance of the ResponseHandler class. |
|
*/ |
class PEGASUS_COMMON_LINKAGE InstanceResponseHandler : virtual public ResponseHandler | class PEGASUS_COMMON_LINKAGE InstanceResponseHandler : virtual public ResponseHandler |
{ | { |
public: | public: |
|
|
}; | }; |
| |
| |
// |
/** |
// MethodResultResponseHandler |
The MethodResultResponseHandler class is a subclass to the ResponseHandler class. |
/// |
*/ |
class PEGASUS_COMMON_LINKAGE MethodResultResponseHandler : virtual public ResponseHandler | class PEGASUS_COMMON_LINKAGE MethodResultResponseHandler : virtual public ResponseHandler |
{ | { |
public: | public: |
/// |
/** |
|
Add documentation here. |
|
*/ |
virtual void deliverParamValue(const CIMParamValue & outParamValue) = 0; | virtual void deliverParamValue(const CIMParamValue & outParamValue) = 0; |
| |
/// |
/** |
|
Add documentation here. |
|
*/ |
virtual void deliverParamValue(const Array<CIMParamValue> & outParamValues) = 0; | virtual void deliverParamValue(const Array<CIMParamValue> & outParamValues) = 0; |
| |
/// |
/** |
|
Add documentation here. |
|
*/ |
virtual void deliver(const CIMValue & returnValue) = 0; | virtual void deliver(const CIMValue & returnValue) = 0; |
}; | }; |
| |
| |
// |
/** |
// IndicationResponseHandler |
The IndicationResponseHandler class is a subclass to the ResponseHandler class. |
// |
<p> NOTE: This class definition should not be considered complete until indication |
// NOTE: This class definition should not be considered complete until |
support has been completed in Pegasus. Implementation of indication support may |
// indication support has been completed in Pegasus. Implementation of |
reveal a need for API changes in this class.</p> |
// indication support may reveal a need for API changes in this class. |
*/ |
class PEGASUS_COMMON_LINKAGE IndicationResponseHandler : virtual public ResponseHandler | class PEGASUS_COMMON_LINKAGE IndicationResponseHandler : virtual public ResponseHandler |
{ | { |
public: | public: |
|
/** |
|
Add documentation here. |
|
*/ |
virtual void deliver(const CIMIndication & indication) = 0; | virtual void deliver(const CIMIndication & indication) = 0; |
| |
|
/** |
|
Add documentation here. |
|
*/ |
virtual void deliver(const Array<CIMIndication> & indications) = 0; | virtual void deliver(const Array<CIMIndication> & indications) = 0; |
| |
|
/** |
|
Add documentation here. |
|
*/ |
virtual void deliver( | virtual void deliver( |
const OperationContext & context, | const OperationContext & context, |
const CIMIndication & indication) = 0; | const CIMIndication & indication) = 0; |
| |
|
/** |
|
Add documentation here. |
|
*/ |
virtual void deliver( | virtual void deliver( |
const OperationContext & context, | const OperationContext & context, |
const Array<CIMIndication> & indications) = 0; | const Array<CIMIndication> & indications) = 0; |
|
|
virtual void deliver(const Array<CIMObject> & objects) = 0; | virtual void deliver(const Array<CIMObject> & objects) = 0; |
}; | }; |
| |
|
|
#ifdef PEGASUS_INTERNALONLY |
|
// This type is used in CIMPropertyProvider which Pegasus does not support |
|
// |
|
// ValueResponseHandler |
|
// |
|
class PEGASUS_COMMON_LINKAGE ValueResponseHandler : virtual public ResponseHandler |
|
{ |
|
public: |
|
virtual void deliver(const CIMValue & value) = 0; |
|
|
|
virtual void deliver(const Array<CIMValue> & values) = 0; |
|
}; |
|
#endif |
|
|
|
|
|
#ifdef PEGASUS_INTERNALONLY |
|
// This type is used in CIMClassProvider which Pegasus does not support |
|
// |
|
// ClassResponseHandler |
|
// |
|
class PEGASUS_COMMON_LINKAGE ClassResponseHandler : virtual public ResponseHandler |
|
{ |
|
public: |
|
virtual void deliver(const CIMClass & classObj) = 0; |
|
|
|
virtual void deliver(const Array<CIMClass> & classObjs) = 0; |
|
}; |
|
#endif |
|
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif | #endif |