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
125
126
127
|
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* XKMSLocateRequest := Interface for LocateRequest Messages
*
* $Id: XKMSLocateRequest.hpp 1125514 2011-05-20 19:08:33Z scantor $
*
*/
#ifndef XKMSLOCATEREQUEST_INCLUDE
#define XKMSLOCATEREQUEST_INCLUDE
// XSEC Includes
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/xkms/XKMSRequestAbstractType.hpp>
class XKMSQueryKeyBinding;
/**
* @ingroup xkms
*/
/**
* @brief Interface definition for the LocateRequest elements
*
* The \<LocateRequest\> is one of the fundamental message types of
* the XKISS service. It is used by the Locate service to find a key
* and return a set of key bindings for that key.
*
* The schema definition for LocateRequest is as follows :
*
* \verbatim
<!-- LocateRequest -->
<element name="LocateRequest" type="xkms:LocateRequestType"/>
<complexType name="LocateRequestType">
<complexContent>
<extension base="xkms:RequestAbstractType">
<sequence>
<element ref="xkms:QueryKeyBinding"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- /LocateRequest -->
\endverbatim
*/
class XKMSLocateRequest : public XKMSRequestAbstractType {
/** @name Constructors and Destructors */
//@{
protected:
XKMSLocateRequest() {};
public:
virtual ~XKMSLocateRequest() {};
/** @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 Obtain the QueryKeyBinding element
*
* The QueryKeyBinding element is the core of the LocateRequest message, and
* defines the public key information that will be sent to the server.
*
* @returns A pointer to the XKMSQueryKeyBinding element
*/
virtual XKMSQueryKeyBinding * getQueryKeyBinding(void) = 0;
//@}
/** @name Setter Interface Methods */
//@{
/** \brief Add a QueryKeyBinding element
*
* Set a QueryKeyBinding element in the LocateRequest message. The returned
* object can be manipulated to add KeyInfo elements to the LocateRequest.
*
* @returns A pointer to the newly created QueryKeyBinding object, or
* the pointer to extant object if one already existed.
*/
virtual XKMSQueryKeyBinding * addQueryKeyBinding(void) = 0;
//@}
private:
// Unimplemented
XKMSLocateRequest(const XKMSLocateRequest &);
XKMSLocateRequest & operator = (const XKMSLocateRequest &);
};
#endif /* XKMSLOCATEREQUEST_INCLUDE */
|
