-rw-r--r-- | include/opkele/consumer.h | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h index 042e2d1..b9d1e54 100644 --- a/include/opkele/consumer.h +++ b/include/opkele/consumer.h | |||
@@ -4,59 +4,76 @@ | |||
4 | #include <opkele/types.h> | 4 | #include <opkele/types.h> |
5 | #include <opkele/extension.h> | 5 | #include <opkele/extension.h> |
6 | 6 | ||
7 | /** | 7 | /** |
8 | * @file | 8 | * @file |
9 | * @brief OpenID consumer-side functionality | 9 | * @brief OpenID consumer-side functionality |
10 | */ | 10 | */ |
11 | 11 | ||
12 | namespace opkele { | 12 | namespace opkele { |
13 | 13 | ||
14 | /** | 14 | /** |
15 | * implementation of basic consumer functionality | 15 | * implementation of basic consumer functionality |
16 | * | ||
17 | * @note | ||
18 | * The consumer uses libcurl internally, which means that if you're using | ||
19 | * libopkele in multithreaded environment you should call curl_global_init | ||
20 | * yourself before spawning any threads. | ||
16 | */ | 21 | */ |
17 | class consumer_t { | 22 | class consumer_t { |
18 | public: | 23 | public: |
19 | 24 | ||
20 | /** | 25 | /** |
21 | * store association. The function should be overridden in the real | 26 | * store association. The function should be overridden in the real |
22 | * implementation to provide persistent associations store. | 27 | * implementation to provide persistent associations store. |
23 | * @param server the OpenID server | 28 | * @param server the OpenID server |
24 | * @param handle association handle | 29 | * @param handle association handle |
25 | * @param secret the secret associated with the server and handle | 30 | * @param secret the secret associated with the server and handle |
26 | * @param expires_in the number of seconds until the handle is expired | 31 | * @param expires_in the number of seconds until the handle is expired |
27 | * @return the auto_ptr<> for the newly allocated association_t object | 32 | * @return the auto_ptr<> for the newly allocated association_t object |
28 | */ | 33 | */ |
29 | virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0; | 34 | virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0; |
30 | /** | 35 | /** |
31 | * retrieve stored association. The function should be overridden | 36 | * retrieve stored association. The function should be overridden |
32 | * in the real implementation to provide persistent assocations | 37 | * in the real implementation to provide persistent assocations |
33 | * store. | 38 | * store. |
39 | * | ||
40 | * @note | ||
41 | * The user is responsible for handling associations expiry and | ||
42 | * this function should never return an expired or invalidated | ||
43 | * association. | ||
44 | * | ||
34 | * @param server the OpenID server | 45 | * @param server the OpenID server |
35 | * @param handle association handle | 46 | * @param handle association handle |
36 | * @return the autho_ptr<> for the newly allocated association_t object | 47 | * @return the autho_ptr<> for the newly allocated association_t object |
37 | * @throw failed_lookup in case of error | 48 | * @throw failed_lookup if no unexpired association found |
38 | */ | 49 | */ |
39 | virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0; | 50 | virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0; |
40 | /** | 51 | /** |
41 | * invalidate stored association. The function should be overridden | 52 | * invalidate stored association. The function should be overridden |
42 | * in the real implementation of the consumer. | 53 | * in the real implementation of the consumer. |
43 | * @param server the OpenID server | 54 | * @param server the OpenID server |
44 | * @param handle association handle | 55 | * @param handle association handle |
45 | */ | 56 | */ |
46 | virtual void invalidate_assoc(const string& server,const string& handle) = 0; | 57 | virtual void invalidate_assoc(const string& server,const string& handle) = 0; |
47 | /** | 58 | /** |
48 | * retrieve any unexpired association for the server. If the | 59 | * retrieve any unexpired association for the server. If the |
49 | * function is not overridden in the real implementation, the new | 60 | * function is not overridden in the real implementation, the new |
50 | * association will be established for each request. | 61 | * association will be established for each request. |
62 | * | ||
63 | * @note | ||
64 | * The user is responsible for handling associations and this | ||
65 | * function should never return an expired or invalidated | ||
66 | * association. | ||
67 | * | ||
51 | * @param server the OpenID server | 68 | * @param server the OpenID server |
52 | * @return the auto_ptr<> for the newly allocated association_t object | 69 | * @return the auto_ptr<> for the newly allocated association_t object |
53 | * @throw failed_lookup in case of absence of the handle | 70 | * @throw failed_lookup in case of absence of the handle |
54 | */ | 71 | */ |
55 | virtual assoc_t find_assoc(const string& server); | 72 | virtual assoc_t find_assoc(const string& server); |
56 | 73 | ||
57 | /** | 74 | /** |
58 | * retrieve the metainformation contained in link tags from the | 75 | * retrieve the metainformation contained in link tags from the |
59 | * page pointed by url. the function may implement caching of the | 76 | * page pointed by url. the function may implement caching of the |
60 | * information. | 77 | * information. |
61 | * @param url url to harvest for link tags | 78 | * @param url url to harvest for link tags |
62 | * @param server reference to the string object where to put | 79 | * @param server reference to the string object where to put |