/*************************************************************************
 *
 *  $RCSfile: XProxySettings.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: obo $ $Date: 2004-06-03 23:35:16 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_system_XProxySettings_idl__
#define __com_sun_star_system_XProxySettings_idl__

#ifndef __com_sun_star_uno_RuntimeException_idl__
#include <com/sun/star/uno/RuntimeException.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com { module sun { module star { module system {

//=============================================================================
/** Enables access to different proxy settings. If particular settings are not
    available an empty string will be returned.
*/

published interface XProxySettings: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** Access to the Ftp proxy address.
        @returns
        The address of the ftp proxy server, if any has been specified.
    */
    string getFtpProxyAddress( );

    //-------------------------------------------------------------------------
    /** Access to the Ftp proxy port.
        @returns
        The port of the ftp proxy server, if any has been specified.
    */
    string getFtpProxyPort( );

    //-------------------------------------------------------------------------
    /** Access to the Gopher proxy address.
        @returns
        The address of the gopher proxy server, if any has been specified.
    */
    string getGopherProxyAddress( );

    //-------------------------------------------------------------------------
    /** Access to the Gopher proxy port.
        @returns
        The port of the gopher proxy server, if any has been specified.
    */
    string getGopherProxyPort( );

    //-------------------------------------------------------------------------
    /** Access to the Http proxy address.
        @returns
        The address of the http proxy server, if any has been specified.
    */
    string getHttpProxyAddress( );

    //-------------------------------------------------------------------------
    /** Access to the Http proxy port.
        @returns
        The port of the http proxy server, if any has been specified.
    */
    string getHttpProxyPort( );

    //-------------------------------------------------------------------------
    /** Access to the Https proxy address.
        @returns
        The address of the https proxy server, if any has been specified.
    */
    string getHttpsProxyAddress( );

    //-------------------------------------------------------------------------
    /** Access to the Https proxy port.
        @returns
        The port of the https proxy server, if any has been specified.
    */
    string getHttpsProxyPort( );

    //-------------------------------------------------------------------------
    /** Access to the Socks proxy address.
        @returns
        The address of the socks proxy server, if any has been specified.
    */
    string getSocksProxyAddress( );

    //-------------------------------------------------------------------------
    /** Access to the Socks proxy port.
        @returns
        The port of the socks proxy server, if any has been specified.
    */
    string getSocksProxyPort( );

    //-------------------------------------------------------------------------
    /** Access to the Proxy-Bypass address.
        @returns
        A string of ';' separated addresses for which no proxy server
        should be used.
    */
    string getProxyBypassAddress( );

    //-------------------------------------------------------------------------
    /** Either a proxy is enabled or not.
        @returns
        A value of <TRUE/> if a proxy is enabled.
        <p>A value of <FALSE/> if a proxy is disabled.</p>
    */
    boolean isProxyEnabled( );
};

//=============================================================================

}; }; }; };

#endif