1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*
* Copyright 2004-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* XSEC
*
* XKMSPendingRequest := Interface for PendingRequest Messages
*
* $Id: XKMSPendingRequest.hpp 351364 2005-06-04 11:30:26Z blautenb $
*
*/
#ifndef XKMSPENDINGREQUEST_INCLUDE
#define XKMSPENDINGREQUEST_INCLUDE
// XSEC Includes
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/xkms/XKMSRequestAbstractType.hpp>
class XKMSQueryKeyBinding;
/**
* @ingroup xkms
*/
/**
* @brief Interface definition for the PendingRequest elements
*
* The \<PendingRequest\> is used in Asynchronous processing. A client
* uses the PendingRequest element to request a response to a request that
* was placed in the past, and to which the service originally provided
* a "Pending" response - i.e. work yet to be done.
*
* The schema definition for PendingRequest is as follows :
*
* \verbatim
<!-- PendingRequest -->
<element name="PendingRequest" type="xkms:PendingRequestType"/>
<complexType name="PendingRequestType">
<complexContent>
<extension base="xkms:RequestAbstractType">
<attribute name="ResponseId" type="NCName" use="required"/>
</extension>
</complexContent>
</complexType>
<!-- /PendingRequest -->
\endverbatim
*/
class XKMSPendingRequest : public XKMSRequestAbstractType {
/** @name Constructors and Destructors */
//@{
protected:
XKMSPendingRequest() {};
public:
virtual ~XKMSPendingRequest() {};
/** @name Getter Interface Methods */
//@{
/**
* \brief Return the element at the base of the message
*/
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * getElement(void) const = 0;
/**
* \brief Return the ResponseId
*
* The ResponseId equates to the Id of the first response the service returned,
* which must (by definition) have had a response code of "Pending". Together
* with the OriginalRequestId, this can be used by the service to uniquley
* identify the original request for which this PendingRequest refers.
*
* @return A pointer to the XMLCh string holding the ResponseId
*/
virtual const XMLCh * getResponseId(void) const = 0;
//@}
/** @name Setter Interface Methods */
//@{
/**
* \brief Set the ResponseId
*
* Allows a calling application to over-ride the configured responseId
*
* @param responseId The new responseId for this element
*/
virtual void setResponseId(const XMLCh * responseId) = 0;
//@}
private:
// Unimplemented
XKMSPendingRequest(const XKMSPendingRequest &);
XKMSPendingRequest & operator = (const XKMSPendingRequest &);
};
#endif /* XKMSPENDINGREQUEST_INCLUDE */
|
