ReverseProxy.idl

Go to the documentation of this file.

/**
 * @file     ReverseProxy.idl
 * @brief    API for Reverse Proxy
 * @version  1
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <common.idl>

module webadmin {

enum HttpsServerMode {
   HttpsServerModeDisabled,
   HttpsServerModeDefaultCertificate,
   HttpsServerModeCustomCertificate
};

struct ReverseProxyRule {
   /*@{ server match */
   string serverHostname;
   boolean serverHttp;  // server on standard HTTP port 80
   HttpsServerMode httpsMode;// server on standard HTTPS port 443
   IdReference customCertificate;// HTTPS server certificate ID

   /*@{ target connection */
   string targetServer;// hostname/IPv4/IPv6 + optionally ":<port>"
   boolean targetHttps;

   /*@{ actions */
   boolean antivirus;

   /*@{ misc */
   boolean enabled;
   string description;
   kerio::web::KId id;
};

typedef sequence<ReverseProxyRule> ReverseProxyRuleList;

struct ReverseProxyConfig {
   boolean enabled;
   IdReference defaultCertificate;
   ReverseProxyRuleList rules;
};

interface ReverseProxy {

   /**
    * @param config - reverse proxy config (enabled, default cert.)
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void get(out ReverseProxyConfig config);

   /**
    * @param  errors - list of errors TODO Write particular values
    * @param config - reverse proxy config (enabled, default cert.)
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation." \n
    *          8002  Database error.  - "Unable to modify rule for hostname '%1'." \n
    *          8002  Database error.  - "Unable to create rule for hostname '%1'." \n
    *          8002  Database error.  - "Unable to delete rule for hostname '%1'."   
    */
   void set(out kerio::web::ErrorList errors, in ReverseProxyConfig config);

};

}; //webadmin