author | Michael Krelin <hacker@klever.net> | 2007-01-12 00:28:16 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2007-01-12 00:28:16 (UTC) |
commit | 4cc2e58186e8cd9b96a3573c92f6664064cf11fe (patch) (unidiff) | |
tree | 762943dfd3db8b6c48d5b31418310962376746d3 /include/opkele/server.h | |
parent | f5eb33d7a9c296e3fa7bde9b678f0e1027a9bf88 (diff) | |
download | libopkele-4cc2e58186e8cd9b96a3573c92f6664064cf11fe.zip libopkele-4cc2e58186e8cd9b96a3573c92f6664064cf11fe.tar.gz libopkele-4cc2e58186e8cd9b96a3573c92f6664064cf11fe.tar.bz2 |
extended server and consumer classes
-rw-r--r-- | include/opkele/server.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/opkele/server.h b/include/opkele/server.h index bf131d8..598eb47 100644 --- a/include/opkele/server.h +++ b/include/opkele/server.h | |||
@@ -1,99 +1,99 @@ | |||
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 | /** | 12 | /** |
13 | * @brief the main opkele namespace | 13 | * @brief the main opkele namespace |
14 | */ | 14 | */ |
15 | namespace opkele { | 15 | namespace opkele { |
16 | 16 | ||
17 | /** | 17 | /** |
18 | * implementation of basic server functionality | 18 | * implementation of basic server functionality |
19 | */ | 19 | */ |
20 | class server_t { | 20 | class server_t { |
21 | public: | 21 | public: |
22 | 22 | ||
23 | /** | 23 | /** |
24 | * allocate the new association. The function should be overridden | 24 | * allocate the new association. The function should be overridden |
25 | * in the real implementation to provide persistent assocations | 25 | * in the real implementation to provide persistent assocations |
26 | * store. | 26 | * store. |
27 | * @param mode the mode of request being processed to base the | 27 | * @param mode the mode of request being processed to base the |
28 | * statelessness of the association upon | 28 | * statelessness of the association upon |
29 | * @return the auto_ptr<> for the newly allocated association_t object | 29 | * @return the auto_ptr<> for the newly allocated association_t object |
30 | */ | 30 | */ |
31 | virtual assoc_t alloc_assoc(mode_t mode) = 0; | 31 | virtual assoc_t alloc_assoc(mode_t mode) = 0; |
32 | /** | 32 | /** |
33 | * retrieve the association. The function should be overridden in | 33 | * retrieve the association. The function should be overridden in |
34 | * the reqal implementation to provide persistent assocations | 34 | * the reqal implementation to provide persistent assocations |
35 | * store. | 35 | * store. |
36 | * @param h association handle | 36 | * @param h association handle |
37 | * @return the auto_ptr<> for the newly allocated association_t object | 37 | * @return the auto_ptr<> for the newly allocated association_t object |
38 | * @throw failed_lookup in case of failure | 38 | * @throw failed_lookup in case of failure |
39 | */ | 39 | */ |
40 | virtual assoc_t retrieve_assoc(const string& h) = 0; | 40 | virtual assoc_t retrieve_assoc(const string& h) = 0; |
41 | 41 | ||
42 | /** | 42 | /** |
43 | * validate the identity. | 43 | * validate the identity. |
44 | * @param assoc association object | 44 | * @param assoc association object |
45 | * @param pin incoming request parameters | 45 | * @param pin incoming request parameters |
46 | * @param identity being verified | 46 | * @param identity being verified |
47 | * @param trust_root presented in the request | 47 | * @param trust_root presented in the request |
48 | * @throw exception if identity can not be confirmed | 48 | * @throw exception if identity can not be confirmed |
49 | */ | 49 | */ |
50 | virtual void validate(const association_t& assoc,const params_t& pin,const string& identity,const string& trust_root) = 0; | 50 | virtual void validate(const association_t& assoc,const params_t& pin,const string& identity,const string& trust_root) = 0; |
51 | 51 | ||
52 | 52 | ||
53 | /** | 53 | /** |
54 | * process the associate request. | 54 | * process the associate request. |
55 | * @param pin the incoming request parameters | 55 | * @param pin the incoming request parameters |
56 | * @param pout the store for the response parameters | 56 | * @param pout the store for the response parameters |
57 | */ | 57 | */ |
58 | void associate(const params_t& pin,params_t& pout); | 58 | void associate(const params_t& pin,params_t& pout); |
59 | /** | 59 | /** |
60 | * process the checkid_immediate request. | 60 | * process the checkid_immediate request. |
61 | * @param pin the incoming request parameters | 61 | * @param pin the incoming request parameters |
62 | * @param return_to reference to the object to store return_to url to | 62 | * @param return_to reference to the object to store return_to url to |
63 | * @param pout the response parameters | 63 | * @param pout the response parameters |
64 | * @param ext pointer to the extension hooks object | 64 | * @param ext pointer to the extension hooks object |
65 | * @throw exception in case of errors or negative reply | 65 | * @throw exception in case of errors or negative reply |
66 | */ | 66 | */ |
67 | void checkid_immediate(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); | 67 | virtual void checkid_immediate(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); |
68 | /** | 68 | /** |
69 | * process the checkid_setup request. | 69 | * process the checkid_setup request. |
70 | * @param pin the incoming request parameters | 70 | * @param pin the incoming request parameters |
71 | * @param return_to reference to the object to store return_to url to | 71 | * @param return_to reference to the object to store return_to url to |
72 | * @param pout the response parameters | 72 | * @param pout the response parameters |
73 | * @param ext pointer to the extension hooks object | 73 | * @param ext pointer to the extension hooks object |
74 | * @throw exception in case of errors or negative reply | 74 | * @throw exception in case of errors or negative reply |
75 | */ | 75 | */ |
76 | void checkid_setup(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); | 76 | virtual void checkid_setup(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); |
77 | /** | 77 | /** |
78 | * the actual functionality behind checkid_immediate() and | 78 | * the actual functionality behind checkid_immediate() and |
79 | * checkid_setup() | 79 | * checkid_setup() |
80 | * @param mode the request being processed (either | 80 | * @param mode the request being processed (either |
81 | * mode_checkid_immediate or mode_checkid_setup) | 81 | * mode_checkid_immediate or mode_checkid_setup) |
82 | * @param pin the incoming request parameters | 82 | * @param pin the incoming request parameters |
83 | * @param return_to reference to the object to store return_to url to | 83 | * @param return_to reference to the object to store return_to url to |
84 | * @param pout the response parameters | 84 | * @param pout the response parameters |
85 | * @param ext pointer to the extension hooks object | 85 | * @param ext pointer to the extension hooks object |
86 | * @throw exception in case of errors or negative reply | 86 | * @throw exception in case of errors or negative reply |
87 | */ | 87 | */ |
88 | void checkid_(mode_t mode,const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); | 88 | virtual void checkid_(mode_t mode,const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); |
89 | /** | 89 | /** |
90 | * process the check_authentication request. | 90 | * process the check_authentication request. |
91 | * @param pin incoming request parameters | 91 | * @param pin incoming request parameters |
92 | * @param pout response parameters | 92 | * @param pout response parameters |
93 | */ | 93 | */ |
94 | void check_authentication(const params_t& pin,params_t& pout); | 94 | void check_authentication(const params_t& pin,params_t& pout); |
95 | }; | 95 | }; |
96 | 96 | ||
97 | } | 97 | } |
98 | 98 | ||
99 | #endif /* __OPKELE_SERVER_H */ | 99 | #endif /* __OPKELE_SERVER_H */ |