138 lines
4.9 KiB
C++
138 lines
4.9 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_UCBHELPER_PROXYDECIDER_HXX
|
|
#define INCLUDED_UCBHELPER_PROXYDECIDER_HXX
|
|
|
|
#include <rtl/ustring.hxx>
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#include <com/sun/star/uno/XComponentContext.hpp>
|
|
#include <ucbhelper/ucbhelperdllapi.h>
|
|
|
|
namespace com { namespace sun { namespace star { namespace lang {
|
|
class XMultiServiceFactory;
|
|
} } } }
|
|
|
|
namespace ucbhelper
|
|
{
|
|
|
|
/**
|
|
* This struct describes a proxy server.
|
|
*/
|
|
struct InternetProxyServer
|
|
{
|
|
/**
|
|
* The name of the proxy server.
|
|
*/
|
|
OUString aName;
|
|
|
|
/**
|
|
* The port of the proxy server.
|
|
*/
|
|
sal_Int32 nPort;
|
|
|
|
/**
|
|
* Constructor.
|
|
*/
|
|
InternetProxyServer() : nPort( -1 ) {}
|
|
};
|
|
|
|
namespace proxydecider_impl { class InternetProxyDecider_Impl; }
|
|
|
|
/**
|
|
* This class is able to decide whether and which internet proxy server is to
|
|
* be used to access a given URI.
|
|
*
|
|
* The implementation reads the internet proxy settings from Office
|
|
* configuration. It listens for configuration changes and adapts itself
|
|
* accordingly. Because configuration data can change during runtime clients
|
|
* should not cache results obtained from InternetProxyDecider instances. One
|
|
* instance should be kept to be queried multiple times instead.
|
|
*/
|
|
class UCBHELPER_DLLPUBLIC InternetProxyDecider
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* Note: Every instance should be held alive as long as possible because
|
|
* because construction is quite expensive.
|
|
*
|
|
* @param rxSMgr is a Service Manager.
|
|
*/
|
|
InternetProxyDecider( const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::uno::XComponentContext >& rxContext );
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
~InternetProxyDecider();
|
|
|
|
/**
|
|
* Informs whether a proxy server should be used.
|
|
*
|
|
* @param rProtocol contains the internet protocol to be used to
|
|
* access the server (i.e. "ftp", "http"). The protocol string
|
|
* is handled case-insensitive and must not be empty.
|
|
* @param rHost contains the name of the server that should be accessed.
|
|
* This parameter might be left empty. In this case the
|
|
* implementation will return whether a proxy is configured
|
|
* for the given protocol.
|
|
* @param nPort contains the port of the server that should be accessed.
|
|
* If host is not empty this parameter must always contain a valid
|
|
* port number, for instance the default port for the requested
|
|
* protocol(i.e. 80 or http).
|
|
* @return true if a proxy server should be used, false otherwise.
|
|
*/
|
|
bool
|
|
shouldUseProxy( const OUString & rProtocol,
|
|
const OUString & rHost,
|
|
sal_Int32 nPort ) const;
|
|
|
|
/**
|
|
* Returns the proxy server to be used.
|
|
*
|
|
* @param rProtocol contains the internet protocol to be used to
|
|
* access the server (i.e. "ftp", "http"). The protocol string
|
|
* is handled case-insensitive and must not be empty.
|
|
* @param rHost contains the name of the server that should be accessed.
|
|
* This parameter might be left empty. In this case the
|
|
* implementation will return the proxy that is configured
|
|
* for the given protocol.
|
|
* @param nPort contains the port of the server that should be accessed.
|
|
* If host is not empty this parameter must always contain a valid
|
|
* port number, for instance the default port for the requested
|
|
* protocol(i.e. 80 or http).
|
|
* @return a InternetProxyServer reference. If member aName of the
|
|
* InternetProxyServer is empty no proxy server is to be used.
|
|
*/
|
|
const InternetProxyServer &
|
|
getProxy( const OUString & rProtocol,
|
|
const OUString & rHost,
|
|
sal_Int32 nPort ) const;
|
|
|
|
private:
|
|
proxydecider_impl::InternetProxyDecider_Impl * m_pImpl;
|
|
};
|
|
|
|
} // namespace ucbhelper
|
|
|
|
#endif /* ! INCLUDED_UCBHELPER_PROXYDECIDER_HXX */
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|