OW_HTTPServer.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_HTTPSERVER_HPP_INCLUDE_GUARD_
#define OW_HTTPSERVER_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_Mutex.hpp"
#include "OW_SocketAddress.hpp"
#include "OW_Socket.hpp"
#include "OW_ServiceIFC.hpp"
#include "OW_URL.hpp"
#include "OW_ThreadPool.hpp"
#include "OW_Exception.hpp"
#include "OW_SortedVectorSet.hpp"
#include "OW_SSLCtxMgr.hpp"
#include "OW_CommonFwd.hpp"
#include "OW_ServicesHttpFwd.hpp"

namespace OW_NAMESPACE
{

OW_DECLARE_EXCEPTION(HTTPServer)

class OW_HTTPSVC_API HTTPServer : public ServiceIFC
{
public:
   HTTPServer();
   virtual ~HTTPServer();
   virtual String getName() const;
   virtual StringArray getDependencies() const;

   virtual void init(const ServiceEnvironmentIFCRef& env);
   virtual void start();
   virtual void shutdown();

   bool isShuttingDown();
   Array<URL> getURLs() const;
   ServiceEnvironmentIFCRef getEnvironment() const { return m_options.env; }
   void addURL(const URL& url);
   SocketAddress getLocalHTTPAddress();
   SocketAddress getLocalHTTPSAddress();
   
   enum EAuthenticationChallengeMethod
   {
      E_DIGEST,
      E_BASIC,
      E_OWLOCAL
   };
   
   struct Options
   {
      Int32 httpPort;
      Int32 httpsPort;
      String UDSFilename;
      Int32 maxConnections;
      bool isSepThread;
      bool enableDeflate;
      EAuthenticationChallengeMethod defaultAuthChallenge;
      bool allowDigestAuthentication;
      bool allowBasicAuthentication;
      bool allowLocalAuthentication;
      bool allowAnonymous;
      bool useUDS;
      bool reuseAddr;
      ServiceEnvironmentIFCRef env;
      Int32 timeout;
      String defaultContentLanguage;
   };
private:
   bool authenticate(HTTPSvrConnection* pconn,
      String& userName, const String& info, OperationContext& context,
                 const Socket& socket);
   bool isAllowedUser(const String& user) const;

   Mutex m_guard;
   Options m_options;
#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
   HANDLE m_event;
#else
   IntrusiveReference<UnnamedPipe> m_upipe;
#endif
   Array<URL> m_urls;
   IntrusiveReference<ServerSocket> m_pHttpServerSocket;
   IntrusiveReference<ServerSocket> m_pHttpsServerSocket;
   IntrusiveReference<ServerSocket> m_pUDSServerSocket;
#ifndef OW_DISABLE_DIGEST
   IntrusiveReference<DigestAuthentication> m_digestAuthentication;
#endif
#ifndef OW_WIN32
   IntrusiveReference<LocalAuthentication> m_localAuthentication;
#endif
   Mutex m_authGuard;
   IntrusiveReference<ThreadPool> m_threadPool;
   SortedVectorSet<String> m_allowedUsers;
   bool m_allowAllUsers;
   SSLServerCtxRef m_sslCtx;
   Mutex m_shutdownGuard;
   bool m_shuttingDown;
#ifndef OW_NO_SSL
   SSLOpts m_sslopts;
   SSLTrustStoreRef m_trustStore;
#endif //  OW_HAVE_SSL

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   friend class HTTPSvrConnection;
   friend class HTTPListener;
   friend class IPCConnectionHandler;
   friend class HTTPServerSelectableCallback;
};
OW_EXPORT_TEMPLATE(OW_HTTPSVC_API, IntrusiveReference, HTTPServer);

} // end namespace OW_NAMESPACE

#endif

---