LibreOffice Module ucb (master) 1
DAVException.hxx
Go to the documentation of this file.
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#pragma once
22
23#include <rtl/ustring.hxx>
24#include <utility>
25
26namespace http_dav_ucp
27{
28
29
30// HTTP/WebDAV status codes
31
32
33const sal_uInt16 SC_NONE = 0;
34
35// 1xx (Informational - no errors)
36const sal_uInt16 SC_CONTINUE = 100;
37const sal_uInt16 SC_SWITCHING_PROTOCOLS = 101;
38// DAV extensions
39const sal_uInt16 SC_PROCESSING = 102;
40
41//2xx (Successful - no errors)
42const sal_uInt16 SC_OK = 200;
43const sal_uInt16 SC_CREATED = 201;
44const sal_uInt16 SC_ACCEPTED = 202;
45const sal_uInt16 SC_NON_AUTHORITATIVE_INFORMATION = 203;
46const sal_uInt16 SC_NO_CONTENT = 204;
47const sal_uInt16 SC_RESET_CONTENT = 205;
48const sal_uInt16 SC_PARTIAL_CONTENT = 206;
49// DAV extensions
50const sal_uInt16 SC_MULTISTATUS = 207;
51
52//3xx (Redirection)
53const sal_uInt16 SC_MULTIPLE_CHOICES = 300;
54const sal_uInt16 SC_MOVED_PERMANENTLY = 301;
55const sal_uInt16 SC_MOVED_TEMPORARILY = 302;
56const sal_uInt16 SC_SEE_OTHER = 303;
57const sal_uInt16 SC_NOT_MODIFIED = 304;
58const sal_uInt16 SC_USE_PROXY = 305;
59const sal_uInt16 SC_TEMPORARY_REDIRECT = 307;
60
61//4xx (Client error)
62const sal_uInt16 SC_BAD_REQUEST = 400;
63const sal_uInt16 SC_UNAUTHORIZED = 401;
64const sal_uInt16 SC_PAYMENT_REQUIRED = 402;
65const sal_uInt16 SC_FORBIDDEN = 403;
66const sal_uInt16 SC_NOT_FOUND = 404;
67const sal_uInt16 SC_METHOD_NOT_ALLOWED = 405;
68const sal_uInt16 SC_NOT_ACCEPTABLE = 406;
69const sal_uInt16 SC_PROXY_AUTHENTICATION_REQUIRED = 407;
70const sal_uInt16 SC_REQUEST_TIMEOUT = 408;
71const sal_uInt16 SC_CONFLICT = 409;
72const sal_uInt16 SC_GONE = 410;
73const sal_uInt16 SC_LENGTH_REQUIRED = 411;
74const sal_uInt16 SC_PRECONDITION_FAILED = 412;
75const sal_uInt16 SC_REQUEST_ENTITY_TOO_LARGE = 413;
76const sal_uInt16 SC_REQUEST_URI_TOO_LONG = 414;
77const sal_uInt16 SC_UNSUPPORTED_MEDIA_TYPE = 415;
79const sal_uInt16 SC_EXPECTATION_FAILED = 417;
80// DAV extensions
81const sal_uInt16 SC_UNPROCESSABLE_ENTITY = 422;
82const sal_uInt16 SC_LOCKED = 423;
83const sal_uInt16 SC_FAILED_DEPENDENCY = 424;
84
85//5xx (Server error, general <https://tools.ietf.org/html/rfc7231#section-6.6>)
86const sal_uInt16 SC_INTERNAL_SERVER_ERROR = 500;
87const sal_uInt16 SC_NOT_IMPLEMENTED = 501;
88const sal_uInt16 SC_BAD_GATEWAY = 502;
89const sal_uInt16 SC_SERVICE_UNAVAILABLE = 503;
90const sal_uInt16 SC_GATEWAY_TIMEOUT = 504;
91const sal_uInt16 SC_HTTP_VERSION_NOT_SUPPORTED = 505;
92// DAV extensions (<https://tools.ietf.org/html/rfc4918#section-11>)
93const sal_uInt16 SC_INSUFFICIENT_STORAGE = 507;
94
95// unofficial status codes only used internally by LO
96// used to cache the connection time out event
97const sal_uInt16 USC_CONNECTION_TIMED_OUT = 908;
98 // name resolution failed
99const sal_uInt16 USC_LOOKUP_FAILED = 909;
100const sal_uInt16 USC_AUTH_FAILED = 910;
101const sal_uInt16 USC_AUTHPROXY_FAILED = 911;
102
103
104
105class DAVException : public std::exception
106{
107 public:
109 DAV_HTTP_ERROR = 0, // Generic error,
110 // mData = server error message,
111 // mStatusCode = HTTP status code
112 DAV_HTTP_LOOKUP, // Name lookup failed,
113 // mData = server[:port]
114 DAV_HTTP_NOAUTH, // No User authentication data provided - e.g., user aborts corresponding dialog
115 // mData = server[:port]
116 DAV_HTTP_AUTH, // User authentication failed on server,
117 // mData = server[:port]
118 DAV_HTTP_AUTHPROXY, // User authentication failed on proxy,
119 // mData = proxy server[:port]
120 DAV_HTTP_CONNECT, // Could not connect to server,
121 // mData = server[:port]
122 DAV_HTTP_TIMEOUT, // Connection timed out
123 // mData = server[:port]
124 DAV_HTTP_FAILED, // The precondition failed
125 // mData = server[:port]
126 DAV_HTTP_RETRY, // Retry request
127 // mData = server[:port]
128 DAV_HTTP_REDIRECT, // Request was redirected,
129 // mData = new URL
130 DAV_SESSION_CREATE, // session creation error,
131 // mData = server[:port]
132 DAV_INVALID_ARG, // invalid argument
133
134 DAV_LOCK_EXPIRED, // DAV lock expired
135
136 DAV_NOT_LOCKED, // not locked
137
138 DAV_LOCKED_SELF, // locked by this OOo session
139
140 DAV_LOCKED // locked by third party
141 };
142
143 private:
145 OUString mData;
146 sal_uInt16 mStatusCode;
147
148 public:
149 explicit DAVException( ExceptionCode inExceptionCode )
150 : mExceptionCode( inExceptionCode )
151 , mData()
153 {};
154 DAVException( ExceptionCode inExceptionCode,
155 OUString aData )
156 : mExceptionCode( inExceptionCode )
157 , mData(std::move( aData ))
159 {};
160 DAVException( ExceptionCode inExceptionCode,
161 OUString aData,
162 sal_uInt16 nStatusCode )
163 : mExceptionCode( inExceptionCode )
164 , mData(std::move( aData ))
165 , mStatusCode( nStatusCode )
166 {};
167
168 const ExceptionCode & getError() const { return mExceptionCode; }
169 const OUString & getData() const { return mData; }
170 sal_uInt16 getStatus() const { return mStatusCode; }
171};
172
173} // namespace http_dav_ucp
174
175/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
DAVException(ExceptionCode inExceptionCode, OUString aData, sal_uInt16 nStatusCode)
DAVException(ExceptionCode inExceptionCode)
const OUString & getData() const
const ExceptionCode & getError() const
DAVException(ExceptionCode inExceptionCode, OUString aData)
sal_uInt16 getStatus() const
constexpr OUStringLiteral aData
const sal_uInt16 SC_NOT_IMPLEMENTED
const sal_uInt16 SC_TEMPORARY_REDIRECT
const sal_uInt16 SC_FAILED_DEPENDENCY
const sal_uInt16 SC_PROCESSING
const sal_uInt16 USC_AUTHPROXY_FAILED
const sal_uInt16 SC_SEE_OTHER
const sal_uInt16 SC_MULTIPLE_CHOICES
const sal_uInt16 SC_BAD_GATEWAY
const sal_uInt16 SC_CONTINUE
const sal_uInt16 SC_LOCKED
const sal_uInt16 USC_LOOKUP_FAILED
const sal_uInt16 SC_USE_PROXY
const sal_uInt16 SC_MOVED_TEMPORARILY
const sal_uInt16 SC_NON_AUTHORITATIVE_INFORMATION
const sal_uInt16 SC_NOT_ACCEPTABLE
const sal_uInt16 SC_GONE
const sal_uInt16 SC_FORBIDDEN
const sal_uInt16 USC_CONNECTION_TIMED_OUT
const sal_uInt16 SC_GATEWAY_TIMEOUT
const sal_uInt16 SC_SERVICE_UNAVAILABLE
const sal_uInt16 SC_EXPECTATION_FAILED
const sal_uInt16 SC_UNPROCESSABLE_ENTITY
const sal_uInt16 SC_PRECONDITION_FAILED
const sal_uInt16 SC_NOT_MODIFIED
const sal_uInt16 SC_NONE
const sal_uInt16 SC_PROXY_AUTHENTICATION_REQUIRED
const sal_uInt16 SC_OK
const sal_uInt16 SC_NO_CONTENT
const sal_uInt16 SC_REQUEST_URI_TOO_LONG
const sal_uInt16 SC_CONFLICT
const sal_uInt16 SC_REQUESTED_RANGE_NOT_SATISFIABLE
const sal_uInt16 SC_UNSUPPORTED_MEDIA_TYPE
const sal_uInt16 SC_MOVED_PERMANENTLY
const sal_uInt16 SC_PARTIAL_CONTENT
const sal_uInt16 SC_SWITCHING_PROTOCOLS
const sal_uInt16 SC_INSUFFICIENT_STORAGE
const sal_uInt16 SC_UNAUTHORIZED
const sal_uInt16 SC_REQUEST_ENTITY_TOO_LARGE
const sal_uInt16 SC_HTTP_VERSION_NOT_SUPPORTED
const sal_uInt16 SC_BAD_REQUEST
const sal_uInt16 SC_MULTISTATUS
const sal_uInt16 SC_INTERNAL_SERVER_ERROR
const sal_uInt16 SC_LENGTH_REQUIRED
const sal_uInt16 SC_ACCEPTED
const sal_uInt16 SC_NOT_FOUND
const sal_uInt16 SC_METHOD_NOT_ALLOWED
const sal_uInt16 SC_PAYMENT_REQUIRED
const sal_uInt16 USC_AUTH_FAILED
const sal_uInt16 SC_RESET_CONTENT
const sal_uInt16 SC_CREATED
const sal_uInt16 SC_REQUEST_TIMEOUT