Fix for ONOS-1595 - return proper status (405) when using an unsupported method
Change-Id: I66fe2d4783364d5a5b8cccba15115c818ed3a3b3
diff --git a/web/api/src/main/java/org/onosproject/rest/exceptions/WebApplicationExceptionMapper.java b/web/api/src/main/java/org/onosproject/rest/exceptions/WebApplicationExceptionMapper.java
new file mode 100644
index 0000000..f47e604
--- /dev/null
+++ b/web/api/src/main/java/org/onosproject/rest/exceptions/WebApplicationExceptionMapper.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.rest.exceptions;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+
+/**
+ * Exception mapper for WebApplicationExceptions.
+ */
+public class WebApplicationExceptionMapper extends AbstractMapper<WebApplicationException> {
+
+ /**
+ * Extracts and returns the response from a WebApplicationException.
+ *
+ * @param e WebApplicationException that was thrown
+ * @return precomputed Response from the exception
+ */
+ @Override
+ public Response toResponse(WebApplicationException e) {
+ return e.getResponse();
+ }
+
+ @Override
+ public Response.Status responseStatus() {
+ // This should never be called because this class overrides toResponse()
+ throw new UnsupportedOperationException(
+ "responseStatus() for a WebApplicationException should never be called");
+ }
+}
diff --git a/web/api/src/main/webapp/WEB-INF/web.xml b/web/api/src/main/webapp/WEB-INF/web.xml
index ba7e65f..82ad21e 100644
--- a/web/api/src/main/webapp/WEB-INF/web.xml
+++ b/web/api/src/main/webapp/WEB-INF/web.xml
@@ -60,6 +60,7 @@
org.onosproject.rest.exceptions.NotFoundMapper,
org.onosproject.rest.exceptions.ServerErrorMapper,
org.onosproject.rest.exceptions.BadRequestMapper,
+ org.onosproject.rest.exceptions.WebApplicationExceptionMapper,
org.onosproject.rest.JsonBodyWriter,
org.onosproject.rest.ApplicationsWebResource,
diff --git a/web/api/src/test/java/org/onosproject/rest/BadRequestTest.java b/web/api/src/test/java/org/onosproject/rest/BadRequestTest.java
index 1e5e7c4..1b462f6 100644
--- a/web/api/src/test/java/org/onosproject/rest/BadRequestTest.java
+++ b/web/api/src/test/java/org/onosproject/rest/BadRequestTest.java
@@ -28,6 +28,10 @@
* Unit tests for bad REST requests.
*/
public class BadRequestTest extends ResourceTest {
+
+ /**
+ * Tests the response for an invalid URL.
+ */
@Test
public void badUrl() {
WebResource rs = resource();
@@ -39,4 +43,19 @@
containsString("returned a response status of 404 Not Found"));
}
}
+
+ /**
+ * Tests the response for a request with a bad method.
+ */
+ @Test
+ public void badMethod() {
+ WebResource rs = resource();
+ try {
+ rs.path("hosts").delete();
+ fail("Fetch of non-existent URL did not throw an exception");
+ } catch (UniformInterfaceException ex) {
+ assertThat(ex.getMessage(),
+ containsString("returned a response status of 405 Method Not Allowed"));
+ }
+ }
}