-rw-r--r-- | include/opkele/server.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/opkele/server.h b/include/opkele/server.h index dd7fc41..3c25646 100644 --- a/include/opkele/server.h +++ b/include/opkele/server.h | |||
@@ -4,57 +4,57 @@ | |||
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() { } | 20 | virtual ~server_t() { } |
21 | 21 | ||
22 | /** | 22 | /** |
23 | * allocate the new association. The function should be overridden | 23 | * allocate the new association. The function should be overridden |
24 | * in the real implementation to provide persistent assocations | 24 | * in the real implementation to provide persistent assocations |
25 | * store. | 25 | * store. |
26 | * @param mode the mode of request being processed to base the | 26 | * @param mode the mode of request being processed to base the |
27 | * statelessness of the association upon | 27 | * statelessness of the association upon |
28 | * @return the auto_ptr<> for the newly allocated association_t object | 28 | * @return the assoc_t for the newly allocated association_t object |
29 | */ | 29 | */ |
30 | virtual assoc_t alloc_assoc(mode_t mode) = 0; | 30 | virtual assoc_t alloc_assoc(mode_t mode) = 0; |
31 | /** | 31 | /** |
32 | * retrieve the association. The function should be overridden in | 32 | * retrieve the association. The function should be overridden in |
33 | * the reqal implementation to provide persistent assocations | 33 | * the reqal implementation to provide persistent assocations |
34 | * store. | 34 | * store. |
35 | * @param h association handle | 35 | * @param h association handle |
36 | * @return the auto_ptr<> for the newly allocated association_t object | 36 | * @return the assoc_t for the newly allocated association_t object |
37 | * @throw failed_lookup in case of failure | 37 | * @throw failed_lookup in case of failure |
38 | */ | 38 | */ |
39 | virtual assoc_t retrieve_assoc(const string& h) = 0; | 39 | virtual assoc_t retrieve_assoc(const string& h) = 0; |
40 | 40 | ||
41 | /** | 41 | /** |
42 | * validate the identity. | 42 | * validate the identity. |
43 | * @param assoc association object | 43 | * @param assoc association object |
44 | * @param pin incoming request parameters | 44 | * @param pin incoming request parameters |
45 | * @param identity being verified | 45 | * @param identity being verified |
46 | * @param trust_root presented in the request | 46 | * @param trust_root presented in the request |
47 | * @throw exception if identity can not be confirmed | 47 | * @throw exception if identity can not be confirmed |
48 | */ | 48 | */ |
49 | 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; |
50 | 50 | ||
51 | 51 | ||
52 | /** | 52 | /** |
53 | * process the associate request. | 53 | * process the associate request. |
54 | * @param pin the incoming request parameters | 54 | * @param pin the incoming request parameters |
55 | * @param pout the store for the response parameters | 55 | * @param pout the store for the response parameters |
56 | */ | 56 | */ |
57 | void associate(const params_t& pin,params_t& pout); | 57 | void associate(const params_t& pin,params_t& pout); |
58 | /** | 58 | /** |
59 | * process the checkid_immediate request. | 59 | * process the checkid_immediate request. |
60 | * @param pin the incoming request parameters | 60 | * @param pin the incoming request parameters |