Detect unregistered namespace prefixes

...and provide useful error messages in the UI. Resolves: https://www.pivotaltracker.com/story/show/61500542
fcrepo · Sep 10, 2014 · be7d793 · be7d793
1 parent 1737afc
commit be7d793
Show file tree

Hide file tree

Showing 2 changed files with 126 additions and 0 deletions.
diff --git a/...ns/src/main/java/org/fcrepo/http/commons/exceptionhandlers/QueryParseExceptionMapper.java b/...ns/src/main/java/org/fcrepo/http/commons/exceptionhandlers/QueryParseExceptionMapper.java
@@ -0,0 +1,68 @@
+/**
+ * Copyright 2014 DuraSpace, Inc.
+ *
+ * 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.fcrepo.http.commons.exceptionhandlers;
+
+import static javax.ws.rs.core.Response.status;
+import static javax.ws.rs.core.Response.Status.BAD_REQUEST;
+import static org.slf4j.LoggerFactory.getLogger;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+
+import org.slf4j.Logger;
+
+import com.hp.hpl.jena.query.QueryParseException;
+
+
+/**
+ * Handles Sparql query parsing exceptions thrown when querying or updating.
+ *
+ * @author whikloj
+ * @since September 9, 2014
+ */
+@Provider
+public class QueryParseExceptionMapper implements
+ExceptionMapper<QueryParseException> {
+
+    private static final Logger LOGGER = getLogger(QueryParseExceptionMapper.class);
+
+    @Override
+    public Response toResponse(final QueryParseException e) {
+
+        LOGGER.debug("Captured a query parse exception {}", e.getMessage());
+        if (e.getMessage().matches(".* Unresolved prefixed name: .*")) {
+            final Pattern namespacePattern =
+                Pattern.compile("Unresolved prefixed name: (\\w+:\\w+)");
+            final Matcher namespaceMatch =
+                namespacePattern.matcher(e.getMessage());
+            if (namespaceMatch.find()) {
+                final String msg =
+                    String.format(
+                        "There are one or more undefined namespace(s) in your request [ %s ], " +
+                        "please define them before retrying",
+                        namespaceMatch.group(1));
+                return status(BAD_REQUEST).entity(msg).build();
+            }
+        }
+
+        return status(BAD_REQUEST).entity(e.getMessage()).build();
+    }
+
+}
diff --git a/...rc/test/java/org/fcrepo/http/commons/exceptionhandlers/QueryParseExceptionMapperTest.java b/...rc/test/java/org/fcrepo/http/commons/exceptionhandlers/QueryParseExceptionMapperTest.java
@@ -0,0 +1,58 @@
+/**
+ * Copyright 2014 DuraSpace, Inc.
+ *
+ * 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.fcrepo.http.commons.exceptionhandlers;
+
+import static javax.ws.rs.core.Response.Status.BAD_REQUEST;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import javax.ws.rs.core.Response;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import com.hp.hpl.jena.query.QueryParseException;
+
+/**
+ * @author whikloj
+ * @since September 10, 2014
+ */
+public class QueryParseExceptionMapperTest {
+
+    private QueryParseExceptionMapper testObj;
+
+    @Before
+    public void setUp() {
+        testObj = new QueryParseExceptionMapper();
+    }
+
+    @Test
+    public void testInvalidNamespace() {
+        final QueryParseException input = new QueryParseException(
+            "Unresolved prefixed name: invalidNS:title", 14, 10);
+        final Response actual = testObj.toResponse(input);
+        assertEquals(BAD_REQUEST.getStatusCode(), actual.getStatus());
+        assertEquals(actual.getEntity(), input.getMessage());
+    }
+
+    @Test
+    public void testToResponse() {
+        final QueryParseException input = new QueryParseException("An error occurred", 14, 10);
+        final Response actual = testObj.toResponse(input);
+        assertEquals(BAD_REQUEST.getStatusCode(), actual.getStatus());
+        assertNotNull(actual.getEntity());
+    }
+}