xcapclient 1.0

data/ERRORS.rdoc

@@ -0,0 +1,123 @@
+
+== Errors
+
+The XCAPClient library includes custom Ruby exceptions. All these exceptions inherit from XCAPClient::XCAPClientError exception.
+
+
+=== Exceptions tree
+
+* StandardError
+  * XCAPClientError
+    * ConfigError
+    * ArgumentError
+    * ConnectionError
+    * WrongAUID
+    * DocumentError
+    * HTTPError
+    * HTTPAuthenticationError
+      * HTTPNoMatchingETag
+      * HTTPConflictError
+      * HTTPDocumentNotModified
+      * HTTPDocumentNotFound
+      * HTTPWrongContentType
+      * HTTPBadRequest
+      * HTTPServerError
+      * HTTPUnknownError
+    * XMLParsingError
+
+
+==== ConfigError < XCAPClientError
+
+An error has occurred related to the client settings.
+
+
+==== ArgumentError < XCAPClientError
+
+Wrong argument passed to a method.
+
+
+==== ConnectionError < XCAPClientError
+
+Couldn't contact the server (i.e: network issue).
+
+
+==== WrongAUID < XCAPClientError
+
+There is no application with such auid name.
+
+
+==== DocumentError < XCAPClientError
+
+Error accesing (it doesn't exist) or creating a local document (it already exists).
+
+
+==== HTTPError < XCAPClientError
+
+A non 2XX HTTP response has been received from the XCAP server.
+
+
+==== HTTPAuthenticationError < HTTPError
+
+The server replied "401 Unauthorized" or "407 Proxy Authentication Required". The server requires authentication (XCAPClient allows Digest and Basic authentication). XCAPClient handles it automatically (if "auth_user" and "password" are set), however the client could receive 401/407 due to wrong user/password.
+
+
+==== HTTPNoMatchingETag < HTTPError
+
+The server replied "412 Precondition Failed". It occurs when using ETag in "If-Match" header for a PUT or DELETE request. It means that the server has a more modern version of the document than the client.
+
+Example:
+
+  begin
+    @xcapclient.put("pres-rules")
+  rescue XCAPClientError::HTTPNoMatchingETag
+    STDERR.puts "Error: the document has been modified in the server by other client."
+  end
+
+
+==== HTTPConflictError < HTTPError
+
+The server replied "409 Conflict". It occurs when the request couldn't be performed in the server.
+
+
+==== HTTPDocumentNotModified < HTTPError
+
+The server replied "304 Not Modified". It occurs when using ETag in "If-None-Match" header for a GET request. It means that the document has not been modified in the server so it's not fetched again (as the client already has it in a local cache).
+
+Example:
+
+  begin
+    @xcapclient.get("pres-rules")
+  rescue XCAPClientError::HTTPDocumentNotModified
+    puts "The document has not been modified in the server."
+  end
+
+
+==== HTTPDocumentNotFound < HTTPError
+
+The server replied "404 Document Not Found". It means that the document or node doesn't exist.
+
+
+==== HTTPWrongContentType < HTTPError
+
+The value of the "Content-Type" in the response from the server doesn't match the expected value.
+
+
+==== HTTPBadRequest < HTTPError
+
+The server replied "400 Bad Request". The request was malformed.
+
+
+==== HTTPServerError < HTTPError
+
+The server replied "500 Internal Server Error". The server encountered an unexpected condition which prevented it from fulfilling the request.
+
+
+==== HTTPUnknownError < HTTPError
+
+Any other HTTP error response.
+
+
+==== XMLParsingError < XCAPClientError
+
+An error ocurred when parsing a XML file (i.e: wrong XML syntax). Note that XCAPClient just parses XML when fetching a node namespaces or "xcap-caps" document.
+