File: XKMSUseKeyWith.hpp

package info (click to toggle)
xml-security-c 1.5.1-3%2Bsqueeze3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 7,424 kB
  • ctags: 5,832
  • sloc: cpp: 45,357; sh: 8,270; makefile: 689
file content (130 lines) | stat: -rw-r--r-- 2,859 bytes parent folder | download | duplicates (4)
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
128
129
130
/*
 * 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
 *
 * XKMSUseKeyWith := Interface for UseKeyWith Messages
 *
 * $Id: XKMSUseKeyWith.hpp 351364 2005-06-04 11:30:26Z blautenb $
 *
 */

#ifndef XKMSUSEKEYWITH_INCLUDE
#define XKMSUSEKEYWITH_INCLUDE

// XSEC Includes

#include <xsec/framework/XSECDefs.hpp>

/**
 * @ingroup xkms
 */

/**
 * @brief Interface definition UseKeyWith elements
 *
 * \<UseKeyWith\> elements are played insied KeyBinding elements and identify
 * applications and application identifiers that correspond with the keys being
 * found.
 *
 * The schema definition for UseKeyWith is as follows :
 *
 * \verbatim
   <!-- UseKeyWith -->
   <element name="UseKeyWith" type="xkms:UseKeyWithType"/>
   <complexType name="UseKeyWithType">
      <attribute name="Application" type="anyURI" use="required"/>
      <attribute name="Identifier" type="string" use="required"/>
   </complexType>
   <!-- /UseKeyWith -->

\endverbatim
 */

class XKMSUseKeyWith {

	/** @name Constructors and Destructors */
	//@{

protected:

	XKMSUseKeyWith() {};

public:

	virtual ~XKMSUseKeyWith() {};

	/** @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 URI associated with the application for which this
	 * identifier applies
	 *
	 * @returns a library owned XMLCh string containing the URI
	 */

	virtual const XMLCh * getApplication(void) const = 0;

	/**
	 * \brief Obtain the identifier string that should be used to locate a key
	 *
	 * @returns a library owned XMLCh string containing the URI
	 */

	virtual const XMLCh * getIdentifier(void) const = 0;

	//@}

	/** @name Setter Interface Methods */
	//@{

	/**
	 * \brief Set the Application string
	 *
	 * param uri URI String identifying the application
	 */

	virtual void setApplication(const XMLCh * uri) = 0;

	/**
	 * \brief Set the Identifier string
	 *
	 * param identifier String identifying the key
	 */

	virtual void setIdentifier(const XMLCh * identifier) = 0;

	//@}

	

private:

	// Unimplemented
	XKMSUseKeyWith(const XKMSUseKeyWith &);
	XKMSUseKeyWith & operator = (const XKMSUseKeyWith &);

};

#endif /* XKMSUSEKEYWITH_INCLUDE */