ProxyServer.idl

Go to the documentation of this file.

/**
 * @file     ProxyServer.idl
 * @brief    API for Proxy server
 * @version  1
 */
 
 #import <common.idl>

module webadmin {

struct ParentProxyConfig {
   boolean           enabled;
   string            server;
   long              port;
   boolean           authEnabled;
  CredentialsConfig credentials;
};

struct ProxyServerConfig {
   boolean           enabled;
   long              port;
   boolean           allowAllPorts;
   ParentProxyConfig parentProxy;
   boolean           automaticScriptDirect;
   boolean           automaticScriptEnabled;
};

interface ProxyServer {

   /**
    * gets Proxy server configuration
    * @param config - current configuration
    *
    * @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 ProxyServerConfig config);

   /**
    * sets Proxy server configuration
    * @param config - new configuration
    *
    * @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 set(in ProxyServerConfig config);
};

}; //webadmin