-rw-r--r-- | include/opkele/server.h | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/include/opkele/server.h b/include/opkele/server.h index e7e5bb3..dd7fc41 100644 --- a/include/opkele/server.h +++ b/include/opkele/server.h | |||
@@ -1,51 +1,53 @@ | |||
1 | #ifndef __OPKELE_SERVER_H | 1 | #ifndef __OPKELE_SERVER_H |
2 | #define __OPKELE_SERVER_H | 2 | #define __OPKELE_SERVER_H |
3 | 3 | ||
4 | /** | 4 | /** |
5 | * @file | 5 | * @file |
6 | * @brief OpenID server-side functionality | 6 | * @brief OpenID server-side functionality |
7 | */ | 7 | */ |
8 | 8 | ||
9 | #include <opkele/types.h> | 9 | #include <opkele/types.h> |
10 | #include <opkele/extension.h> | 10 | #include <opkele/extension.h> |
11 | 11 | ||
12 | namespace opkele { | 12 | namespace opkele { |
13 | 13 | ||
14 | /** | 14 | /** |
15 | * implementation of basic server functionality | 15 | * implementation of basic server functionality |
16 | */ | 16 | */ |
17 | class server_t { | 17 | class server_t { |
18 | public: | 18 | public: |
19 | 19 | ||
20 | virtual ~server_t() { } | ||
21 | |||
20 | /** | 22 | /** |
21 | * allocate the new association. The function should be overridden | 23 | * allocate the new association. The function should be overridden |
22 | * in the real implementation to provide persistent assocations | 24 | * in the real implementation to provide persistent assocations |
23 | * store. | 25 | * store. |
24 | * @param mode the mode of request being processed to base the | 26 | * @param mode the mode of request being processed to base the |
25 | * statelessness of the association upon | 27 | * statelessness of the association upon |
26 | * @return the auto_ptr<> for the newly allocated association_t object | 28 | * @return the auto_ptr<> for the newly allocated association_t object |
27 | */ | 29 | */ |
28 | virtual assoc_t alloc_assoc(mode_t mode) = 0; | 30 | virtual assoc_t alloc_assoc(mode_t mode) = 0; |
29 | /** | 31 | /** |
30 | * retrieve the association. The function should be overridden in | 32 | * retrieve the association. The function should be overridden in |
31 | * the reqal implementation to provide persistent assocations | 33 | * the reqal implementation to provide persistent assocations |
32 | * store. | 34 | * store. |
33 | * @param h association handle | 35 | * @param h association handle |
34 | * @return the auto_ptr<> for the newly allocated association_t object | 36 | * @return the auto_ptr<> for the newly allocated association_t object |
35 | * @throw failed_lookup in case of failure | 37 | * @throw failed_lookup in case of failure |
36 | */ | 38 | */ |
37 | virtual assoc_t retrieve_assoc(const string& h) = 0; | 39 | virtual assoc_t retrieve_assoc(const string& h) = 0; |
38 | 40 | ||
39 | /** | 41 | /** |
40 | * validate the identity. | 42 | * validate the identity. |
41 | * @param assoc association object | 43 | * @param assoc association object |
42 | * @param pin incoming request parameters | 44 | * @param pin incoming request parameters |
43 | * @param identity being verified | 45 | * @param identity being verified |
44 | * @param trust_root presented in the request | 46 | * @param trust_root presented in the request |
45 | * @throw exception if identity can not be confirmed | 47 | * @throw exception if identity can not be confirmed |
46 | */ | 48 | */ |
47 | virtual void validate(const association_t& assoc,const params_t& pin,const string& identity,const string& trust_root) = 0; | 49 | virtual void validate(const association_t& assoc,const params_t& pin,const string& identity,const string& trust_root) = 0; |
48 | 50 | ||
49 | 51 | ||
50 | /** | 52 | /** |
51 | * process the associate request. | 53 | * process the associate request. |