Drop a FIXME

RestconfDocumentedExceptionMapper should end up being transmogrified
into a better error reporting tool. Drop a FIXME to that effect.

JIRA: NETCONF-1188
Change-Id: I58cd32b5c85c92cd3af8979037aa4bc199d25beb
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/errors/RestconfDocumentedExceptionMapper.java b/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/errors/RestconfDocumentedExceptionMapper.java
index 8247634726394d7a25b0ac3e20c6da56852fdf35..40dd5c852a8ccdf562379384330ce308544b06ea 100644 (file)
--- a/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/errors/RestconfDocumentedExceptionMapper.java
+++ b/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/errors/RestconfDocumentedExceptionMapper.java
@@ -48,9 +48,15 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- *  Mapper that is responsible for transformation of thrown {@link RestconfDocumentedException} to errors structure
- *  that is modelled by RESTCONF module (see section 8 of RFC-8040).
+ * An {@link ExceptionMapper} that is responsible for transformation of thrown {@link RestconfDocumentedException} to
+ * {@code errors} structure that is modelled by RESTCONF module (see section 8 of RFC-8040).
+ *
+ * @see Errors
  */
+// FIXME: NETCONF-1188: eliminate the need for this class by having a separate exception which a has a HTTP status and
+//                      optionally holds an ErrorsBody -- i.e. the equivalent of Errors, perhaps as NormalizedNode,
+//                      with sufficient context to send it to JSON or XML -- very similar to a NormalizedNodePayload
+@Deprecated
 @Provider
 public final class RestconfDocumentedExceptionMapper implements ExceptionMapper<RestconfDocumentedException> {
     private static final Logger LOG = LoggerFactory.getLogger(RestconfDocumentedExceptionMapper.class);