All Classes Files Functions Variables Pages
HttpCache.idl
Go to the documentation of this file.
1 /**
2  * @file HttpCache.idl
3  * @brief API for HTTP Cache
4  * @version 4
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 
9 module webadmin {
10 
12  double used; ///< in B
13  long files;
14  long hit;
15  long miss;
16 };
17 
19  boolean transparentEnabled;
20  boolean nonTransparentEnabled;
21  boolean reverseEnabled;
22  long cacheSize; ///< in MB
23  long httpTtl; ///< in days
24 
25  HttpCacheStatus status; ///< read-only
26 };
27 
29  long ttl; ///< in hours
30  string url;
31  string description;
32 };
33 
34 typedef sequence<UrlSpecificTtl> UrlSpecificTtlList;
35 
36 interface HttpCache {
37  /**
38  * gets Http Cache configuration and status
39  * @param config - current configuration
40  * @throws kerio::web::ApiException \n
41  * -32001 Session expired. - "The user is not logged in." \n
42  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
43  */
44  void get(out HttpCacheConfig config);
45 
46  /**
47  * sets Http Cache configuration
48  * @param config - new configuration
49  * @throws kerio::web::ApiException \n
50  * -32001 Session expired. - "The user is not logged in." \n
51  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
52  */
53  void set(in HttpCacheConfig config);
54 
55  /**
56  * gets list of URL specific TTL
57  * @param list - URL specific TTL list
58  * @throws kerio::web::ApiException \n
59  * -32001 Session expired. - "The user is not logged in." \n
60  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
61  */
62  void getUrlSpecificTtl(out UrlSpecificTtlList list);
63 
64  /**
65  * gets list of URL specific TTL
66  * @param errors - list of errors \n
67  * 8001 Database error. - "Unable to modify entry for URL '%1'." \n
68  * 8002 Database error. - "Unable to create entry for URL '%1'." \n
69  * 8002 Database error. - "Unable to remove entry for URL '%1'."
70  * @param list - URL specific TTL list
71  * @throws kerio::web::ApiException \n
72  * -32001 Session expired. - "The user is not logged in." \n
73  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
74  */
75  void setUrlSpecificTtl(out kerio::web::ErrorList errors, in UrlSpecificTtlList list);
76 
77  /**
78  * Removes cache content
79  * @throws kerio::web::ApiException \n
80  * -32001 Session expired. - "The user is not logged in." \n
81  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
82  */
83  void clearCache();
84 };
85 
86 }; //webadmin
long ttl
in hours
Definition: HttpCache.idl:29
long cacheSize
in MB
Definition: HttpCache.idl:22
HttpCacheStatus status
read-only
Definition: HttpCache.idl:25
double used
in B
Definition: HttpCache.idl:12
Definition: HttpCache.idl:28
Definition: HttpCache.idl:36
long httpTtl
in days
Definition: HttpCache.idl:23
Definition: Accounting.idl:11
Definition: HttpCache.idl:18
Definition: HttpCache.idl:11