ucb/source/ucp/webdav/DAVException.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #ifndef INCLUDED_UCB_SOURCE_UCP_WEBDAV_DAVEXCEPTION_HXX
  22 #define INCLUDED_UCB_SOURCE_UCP_WEBDAV_DAVEXCEPTION_HXX
  23
  24 #include <rtl/ustring.hxx>
  25
  26 namespace http_dav_ucp
  27 {
  28
  29
  30 // HTTP/WebDAV status codes
  31
  32
  33 const sal_uInt16 SC_NONE                             = 0;
  34
  35 // 1xx (Informational - no errors)
  36 const sal_uInt16 SC_CONTINUE                         = 100;
  37 const sal_uInt16 SC_SWITCHING_PROTOCOLS              = 101;
  38 // DAV extensions
  39 const sal_uInt16 SC_PROCESSING                       = 102;
  40
  41 //2xx (Successful - no errors)
  42 const sal_uInt16 SC_OK                               = 200;
  43 const sal_uInt16 SC_CREATED                          = 201;
  44 const sal_uInt16 SC_ACCEPTED                         = 202;
  45 const sal_uInt16 SC_NON_AUTHORITATIVE_INFORMATION    = 203;
  46 const sal_uInt16 SC_NO_CONTENT                       = 204;
  47 const sal_uInt16 SC_RESET_CONTENT                    = 205;
  48 const sal_uInt16 SC_PARTIAL_CONTENT                  = 206;
  49 // DAV extensions
  50 const sal_uInt16 SC_MULTISTATUS                      = 207;
  51
  52 //3xx (Redirection)
  53 const sal_uInt16 SC_MULTIPLE_CHOICES                 = 300;
  54 const sal_uInt16 SC_MOVED_PERMANENTLY                = 301;
  55 const sal_uInt16 SC_MOVED_TEMPORARILY                = 302;
  56 const sal_uInt16 SC_SEE_OTHER                        = 303;
  57 const sal_uInt16 SC_NOT_MODIFIED                     = 304;
  58 const sal_uInt16 SC_USE_PROXY                        = 305;
  59 const sal_uInt16 SC_TEMPORARY_REDIRECT               = 307;
  60
  61 //4xx (Client error)
  62 const sal_uInt16 SC_BAD_REQUEST                      = 400;
  63 const sal_uInt16 SC_UNAUTHORIZED                     = 401;
  64 const sal_uInt16 SC_PAYMENT_REQUIRED                 = 402;
  65 const sal_uInt16 SC_FORBIDDEN                        = 403;
  66 const sal_uInt16 SC_NOT_FOUND                        = 404;
  67 const sal_uInt16 SC_METHOD_NOT_ALLOWED               = 405;
  68 const sal_uInt16 SC_NOT_ACCEPTABLE                   = 406;
  69 const sal_uInt16 SC_PROXY_AUTHENTICATION_REQUIRED    = 407;
  70 const sal_uInt16 SC_REQUEST_TIMEOUT                  = 408;
  71 const sal_uInt16 SC_CONFLICT                         = 409;
  72 const sal_uInt16 SC_GONE                             = 410;
  73 const sal_uInt16 SC_LENGTH_REQUIRED                  = 411;
  74 const sal_uInt16 SC_PRECONDITION_FAILED              = 412;
  75 const sal_uInt16 SC_REQUEST_ENTITY_TOO_LARGE         = 413;
  76 const sal_uInt16 SC_REQUEST_URI_TOO_LONG             = 414;
  77 const sal_uInt16 SC_UNSUPPORTED_MEDIA_TYPE           = 415;
  78 const sal_uInt16 SC_REQUESTED_RANGE_NOT_SATISFIABLE  = 416;
  79 const sal_uInt16 SC_EXPECTATION_FAILED               = 417;
  80 // DAV extensions
  81 const sal_uInt16 SC_UNPROCESSABLE_ENTITY             = 422;
  82 const sal_uInt16 SC_LOCKED                           = 423;
  83 const sal_uInt16 SC_FAILED_DEPENDENCY                = 424;
  84
  85 //5xx (Server error)
  86 const sal_uInt16 SC_INTERNAL_SERVER_ERROR            = 500;
  87 const sal_uInt16 SC_NOT_IMPLEMENTED                  = 501;
  88 const sal_uInt16 SC_BAD_GATEWAY                      = 502;
  89 const sal_uInt16 SC_SERVICE_UNAVAILABLE              = 503;
  90 const sal_uInt16 SC_GATEWAY_TIMEOUT                  = 504;
  91 const sal_uInt16 SC_HTTP_VERSION_NOT_SUPPORTED       = 505;
  92 // DAV extensions
  93 const sal_uInt16 SC_INSUFFICIENT_STORAGE             = 507;
  94
  95
  96 class DAVException : public std::exception
  97 {
  98     public:
  99         enum ExceptionCode {
 100             DAV_HTTP_ERROR = 0, // Generic error,
 101                                 // mData = server error message,
 102                                 // mStatusCode = HTTP status code
 103             DAV_HTTP_LOOKUP,    // Name lookup failed,
 104                                 // mData = server[:port]
 105             DAV_HTTP_NOAUTH,    // No User authentication data provided - e.g., user aborts corresponding dialog
 106                                 // mData = server[:port]
 107             DAV_HTTP_AUTH,      // User authentication failed on server,
 108                                 // mData = server[:port]
 109             DAV_HTTP_AUTHPROXY, // User authentication failed on proxy,
 110                                 // mData = proxy server[:port]
 111             DAV_HTTP_CONNECT,   // Could not connect to server,
 112                                 // mData = server[:port]
 113             DAV_HTTP_TIMEOUT,   // Connection timed out
 114                                 // mData = server[:port]
 115             DAV_HTTP_FAILED,    // The precondition failed
 116                                 // mData = server[:port]
 117             DAV_HTTP_RETRY,     // Retry request
 118                                 // mData = server[:port]
 119             DAV_HTTP_REDIRECT,  // Request was redirected,
 120                                 // mData = new URL
 121             DAV_SESSION_CREATE, // session creation error,
 122                                 // mData = server[:port]
 123             DAV_INVALID_ARG,    // invalid argument
 124
 125             DAV_LOCK_EXPIRED,   // DAV lock expired
 126
 127             DAV_NOT_LOCKED,     // not locked
 128
 129             DAV_LOCKED_SELF,    // locked by this OOo session
 130
 131             DAV_LOCKED          // locked by third party
 132         };
 133
 134     private:
 135         ExceptionCode   mExceptionCode;
 136         OUString   mData;
 137         sal_uInt16      mStatusCode;
 138
 139     public:
 140          explicit DAVException( ExceptionCode inExceptionCode )
 141              : mExceptionCode( inExceptionCode )
 142              , mData()
 143              , mStatusCode( SC_NONE )
 144          {};
 145          DAVException( ExceptionCode inExceptionCode,
 146                        const OUString & rData )
 147              : mExceptionCode( inExceptionCode )
 148              , mData( rData )
 149              , mStatusCode( SC_NONE )
 150          {};
 151          DAVException( ExceptionCode inExceptionCode,
 152                        const OUString & rData,
 153                        sal_uInt16 nStatusCode )
 154             : mExceptionCode( inExceptionCode )
 155             , mData( rData )
 156             , mStatusCode( nStatusCode )
 157          {};
 158
 159     const ExceptionCode & getError() const { return mExceptionCode; }
 160     const OUString & getData() const  { return mData; }
 161     sal_uInt16 getStatus() const { return mStatusCode; }
 162 };
 163
 164 } // namespace http_dav_ucp
 165
 166 #endif // INCLUDED_UCB_SOURCE_UCP_WEBDAV_DAVEXCEPTION_HXX
 167
 168 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */