From 2fd92b045097dc87c373e61125092b6a9d56df53 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Sat, 28 Sep 2013 14:03:59 +0200 Subject: [PATCH] improve exception mapping --- .../rest/DisabledAccountExceptionMapper.java | 58 ++++++++++ .../ExcessiveAttemptsExceptionMapper.java | 58 ++++++++++ .../api/rest/ScmSecurityExceptionMapper.java | 28 +---- .../scm/api/rest/StatusExceptionMapper.java | 106 ++++++++++++++++++ 4 files changed, 226 insertions(+), 24 deletions(-) create mode 100644 scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java create mode 100644 scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java create mode 100644 scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java new file mode 100644 index 0000000000..4df332acfe --- /dev/null +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/DisabledAccountExceptionMapper.java @@ -0,0 +1,58 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. 2. Redistributions in + * binary form must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. 3. Neither the name of SCM-Manager; + * nor the names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.api.rest; + +//~--- non-JDK imports -------------------------------------------------------- + +import org.apache.shiro.authc.DisabledAccountException; + +//~--- JDK imports ------------------------------------------------------------ + +import javax.ws.rs.core.Response; + +/** + * + * @author Sebastian Sdorra + */ +public class DisabledAccountExceptionMapper + extends StatusExceptionMapper +{ + + /** + * Constructs ... + * + */ + public DisabledAccountExceptionMapper() + { + super(DisabledAccountException.class, Response.Status.FORBIDDEN); + } +} diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java new file mode 100644 index 0000000000..42e3e2a766 --- /dev/null +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/ExcessiveAttemptsExceptionMapper.java @@ -0,0 +1,58 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. 2. Redistributions in + * binary form must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. 3. Neither the name of SCM-Manager; + * nor the names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.api.rest; + +//~--- non-JDK imports -------------------------------------------------------- + +import org.apache.shiro.authc.ExcessiveAttemptsException; + +//~--- JDK imports ------------------------------------------------------------ + +import javax.ws.rs.core.Response; + +/** + * + * @author Sebastian Sdorra + */ +public class ExcessiveAttemptsExceptionMapper + extends StatusExceptionMapper +{ + + /** + * Constructs ... + * + */ + public ExcessiveAttemptsExceptionMapper() + { + super(ExcessiveAttemptsException.class, Response.Status.FORBIDDEN); + } +} diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java index 5c3d6b6c36..a8ff0c1727 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/ScmSecurityExceptionMapper.java @@ -35,15 +35,11 @@ package sonia.scm.api.rest; //~--- non-JDK imports -------------------------------------------------------- -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - import sonia.scm.security.ScmSecurityException; //~--- JDK imports ------------------------------------------------------------ import javax.ws.rs.core.Response; -import javax.ws.rs.ext.ExceptionMapper; import javax.ws.rs.ext.Provider; /** @@ -52,31 +48,15 @@ import javax.ws.rs.ext.Provider; */ @Provider public class ScmSecurityExceptionMapper - implements ExceptionMapper + extends StatusExceptionMapper { - /** the logger for ScmSecurityExceptionMapper */ - private static final Logger logger = - LoggerFactory.getLogger(ScmSecurityExceptionMapper.class); - - //~--- methods -------------------------------------------------------------- - /** - * Method description + * Constructs ... * - * - * @param exception - * - * @return */ - @Override - public Response toResponse(ScmSecurityException exception) + public ScmSecurityExceptionMapper() { - if (logger.isWarnEnabled()) - { - logger.warn(exception.getMessage(), exception); - } - - return Response.status(Response.Status.FORBIDDEN).build(); + super(ScmSecurityException.class, Response.Status.FORBIDDEN); } } diff --git a/scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java b/scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java new file mode 100644 index 0000000000..08d6b984d2 --- /dev/null +++ b/scm-webapp/src/main/java/sonia/scm/api/rest/StatusExceptionMapper.java @@ -0,0 +1,106 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. 2. Redistributions in + * binary form must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. 3. Neither the name of SCM-Manager; + * nor the names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.api.rest; + +//~--- non-JDK imports -------------------------------------------------------- + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +//~--- JDK imports ------------------------------------------------------------ + +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; + +/** + * + * @author Sebastian Sdorra + * @param + */ +public class StatusExceptionMapper + implements ExceptionMapper +{ + + /** + * the logger for StatusExceptionMapper + */ + private static final Logger logger = + LoggerFactory.getLogger(StatusExceptionMapper.class); + + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + * + * @param type + * @param status + */ + public StatusExceptionMapper(Class type, Response.Status status) + { + this.type = type; + this.status = status; + } + + //~--- methods -------------------------------------------------------------- + + /** + * Method description + * + * + * @param exception + * + * @return + */ + @Override + public Response toResponse(E exception) + { + if (logger.isDebugEnabled()) + { + StringBuilder msg = new StringBuilder(); + + msg.append("map ").append(type.getSimpleName()).append("to status code "); + msg.append(status.getStatusCode()); + logger.debug(msg.toString()); + } + + return Response.status(status).build(); + } + + //~--- fields --------------------------------------------------------------- + + /** Field description */ + private final Response.Status status; + + /** Field description */ + private final Class type; +}