Moved to Maven layout
This commit is contained in:
Rachel Walker
314
exception-handler/pom.xml
Normal file
314
exception-handler/pom.xml
Normal file
@@ -0,0 +1,314 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>com.raychatter</groupId>
|
||||
<artifactId>spring-restful-exception-handler</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
<version>1.0-SNAPSHOT</version>
|
||||
<name>spring-restful-exception-handler</name>
|
||||
<description>Custom exception handler annotation for Spring to unify the error handling.</description>
|
||||
<url>https://github.com/raychatter/spring-restful-exception-handler</url>
|
||||
<parent>
|
||||
<groupId>com.raychatter</groupId>
|
||||
<artifactId>spring-restful-exception-handler-parent</artifactId>
|
||||
<version>1.0-SNAPSHOT</version>
|
||||
</parent>
|
||||
<organization>
|
||||
<name>ThoughtWorks</name>
|
||||
<url>http://www.thoughtworks.com/</url>
|
||||
</organization>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<project.reporting.outputEncoding>${project.build.sourceEncoding}</project.reporting.outputEncoding>
|
||||
<siteProjectVersion>${project.version}</siteProjectVersion>
|
||||
<manifest.builtBy>Rachel Walker</manifest.builtBy>
|
||||
<manifest.addDefaultImplementationEntries>true</manifest.addDefaultImplementationEntries>
|
||||
<manifest.addClasspath>true</manifest.addClasspath>
|
||||
<manifest.packageName>${project.groupId}</manifest.packageName>
|
||||
<manifest.mainClass>${project.groupId}.Main</manifest.mainClass>
|
||||
<manifest.compress>true</manifest.compress>
|
||||
<compileSource>1.6</compileSource>
|
||||
</properties>
|
||||
<licenses>
|
||||
<license>
|
||||
<name>The Apache Software License, Version 2.0</name>
|
||||
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
|
||||
<distribution>repo</distribution>
|
||||
<comments>A business-friendly OSS license</comments>
|
||||
</license>
|
||||
</licenses>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>javax.servlet</groupId>
|
||||
<artifactId>servlet-api</artifactId>
|
||||
<version>2.5</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework</groupId>
|
||||
<artifactId>spring-webmvc</artifactId>
|
||||
<version>3.1.1.RELEASE</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>junit</groupId>
|
||||
<artifactId>junit</artifactId>
|
||||
<version>4.10</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mockito</groupId>
|
||||
<artifactId>mockito-all</artifactId>
|
||||
<version>1.9.0</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<build>
|
||||
<finalName>${project.artifactId}-${project.version}</finalName>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-jar-plugin</artifactId>
|
||||
<version>2.4</version>
|
||||
<configuration>
|
||||
<archive>
|
||||
<compress>${manifest.compress}</compress>
|
||||
<manifest>
|
||||
<addDefaultImplementationEntries>
|
||||
${manifest.addDefaultImplementationEntries}
|
||||
</addDefaultImplementationEntries>
|
||||
<addClasspath>${manifest.addClasspath}</addClasspath>
|
||||
<mainClass>${manifest.mainClass}</mainClass>
|
||||
<packageName>${manifest.packageName}</packageName>
|
||||
</manifest>
|
||||
<manifestEntries>
|
||||
<Built-By>${manifest.builtBy}</Built-By>
|
||||
<Implementation-Version>${project.version}</Implementation-Version>
|
||||
</manifestEntries>
|
||||
</archive>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-source-plugin</artifactId>
|
||||
<version>2.2.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-sources-jar</id>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>jar</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<useDefaultManifestFile>false</useDefaultManifestFile>
|
||||
<archive>
|
||||
<compress>${manifest.compress}</compress>
|
||||
<manifest>
|
||||
<addDefaultImplementationEntries>
|
||||
${manifest.addDefaultImplementationEntries}
|
||||
</addDefaultImplementationEntries>
|
||||
<addClasspath>${manifest.addClasspath}</addClasspath>
|
||||
<mainClass>${manifest.mainClass}</mainClass>
|
||||
<packageName>${manifest.packageName}</packageName>
|
||||
</manifest>
|
||||
<manifestEntries>
|
||||
<Built-By>${manifest.builtBy}</Built-By>
|
||||
<Implementation-Version>${project.version}</Implementation-Version>
|
||||
</manifestEntries>
|
||||
</archive>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>2.9</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-javadocs-jar</id>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>jar</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<quiet>true</quiet>
|
||||
<javadocVersion>${compileSource}</javadocVersion>
|
||||
<archive>
|
||||
<compress>${manifest.compress}</compress>
|
||||
<manifest>
|
||||
<addDefaultImplementationEntries>
|
||||
${manifest.addDefaultImplementationEntries}
|
||||
</addDefaultImplementationEntries>
|
||||
<addClasspath>${manifest.addClasspath}</addClasspath>
|
||||
<mainClass>${manifest.mainClass}</mainClass>
|
||||
<packageName>${manifest.packageName}</packageName>
|
||||
</manifest>
|
||||
<manifestEntries>
|
||||
<Built-By>${manifest.builtBy}</Built-By>
|
||||
<Implementation-Version>${project.version}</Implementation-Version>
|
||||
</manifestEntries>
|
||||
</archive>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-surefire-plugin</artifactId>
|
||||
<version>2.12.4</version>
|
||||
<configuration>
|
||||
<skip>false</skip>
|
||||
<threadCount>50</threadCount>
|
||||
<parallel>classes</parallel>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-site-plugin</artifactId>
|
||||
<version>3.0</version>
|
||||
<configuration>
|
||||
<reportPlugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-jxr-plugin</artifactId>
|
||||
<version>2.3</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>findbugs-maven-plugin</artifactId>
|
||||
<version>2.5.2</version>
|
||||
<configuration>
|
||||
<effort>Max</effort>
|
||||
<threshold>Exp</threshold>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-pmd-plugin</artifactId>
|
||||
<version>2.7.1</version>
|
||||
<configuration>
|
||||
<targetJdk>${compileSource}</targetJdk>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
<version>2.9.1</version>
|
||||
<configuration>
|
||||
<suppressionsLocation>
|
||||
${project.basedir}/checkstyleSupressions.xml
|
||||
</suppressionsLocation>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>2.8</version>
|
||||
<configuration>
|
||||
<quiet>true</quiet>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-surefire-report-plugin</artifactId>
|
||||
<version>2.12.4</version>
|
||||
</plugin>
|
||||
</reportPlugins>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-release-plugin</artifactId>
|
||||
<version>2.3.2</version>
|
||||
<configuration>
|
||||
<arguments>-Dgpg.passphrase=${gpg.passphrase}</arguments>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-antrun-plugin</artifactId>
|
||||
<version>1.7</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>deploy</phase>
|
||||
<id>default-cli</id>
|
||||
<configuration>
|
||||
<target>
|
||||
<delete>
|
||||
<fileset dir="${project.basedir}/artifacts" includes="*.${project.packaging}"/>
|
||||
</delete>
|
||||
<copy todir="${project.basedir}/artifacts">
|
||||
<fileset dir="${project.build.directory}">
|
||||
<include name="${project.build.finalName}*.${project.packaging}"/>
|
||||
</fileset>
|
||||
</copy>
|
||||
</target>
|
||||
</configuration>
|
||||
<goals>
|
||||
<goal>run</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>sign</id>
|
||||
<activation>
|
||||
<property>
|
||||
<name>performRelease</name>
|
||||
<value>true</value>
|
||||
</property>
|
||||
</activation>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-gpg-plugin</artifactId>
|
||||
<version>1.4</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>sign-artifacts</id>
|
||||
<phase>verify</phase>
|
||||
<goals>
|
||||
<goal>sign</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.sonatype.plugins</groupId>
|
||||
<artifactId>nexus-maven-plugin</artifactId>
|
||||
<version>1.7</version>
|
||||
<configuration>
|
||||
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
|
||||
<serverAuthId>oss-sonatype-org</serverAuthId>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
<scm>
|
||||
<connection>scm:git:git@github.com:raychatter/spring-restful-exception-handler.git</connection>
|
||||
<developerConnection>scm:git:git@github.com:raychatter/spring-restful-exception-handler.git</developerConnection>
|
||||
<url>git@github.com:raychatter/spring-restful-exception-handler.git</url>
|
||||
<tag>spring-restful-exception-handler-0.1</tag>
|
||||
</scm>
|
||||
<issueManagement>
|
||||
<system>GitHub</system>
|
||||
<url>https://github.com/raychatter/spring-restful-exception-handler/issues/</url>
|
||||
</issueManagement>
|
||||
<developers>
|
||||
<developer>
|
||||
<id>raychatter</id>
|
||||
<name>Rachel Walker</name>
|
||||
<email>rachel.e.walker@gmail.com</email>
|
||||
<roles>
|
||||
<role>author</role>
|
||||
</roles>
|
||||
<organization>ThoughtWorks</organization>
|
||||
<organizationUrl>http://www.ThoughtWorks.com</organizationUrl>
|
||||
</developer>
|
||||
</developers>
|
||||
</project>
|
||||
@@ -0,0 +1,57 @@
|
||||
package com.raychatter.common.annotation;
|
||||
|
||||
import org.springframework.core.io.ClassPathResource;
|
||||
import org.springframework.web.servlet.HandlerExceptionResolver;
|
||||
import org.springframework.web.servlet.ModelAndView;
|
||||
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.util.Scanner;
|
||||
|
||||
public class AnnotationHandler implements HandlerExceptionResolver {
|
||||
|
||||
@Override
|
||||
public ModelAndView resolveException(final HttpServletRequest request,
|
||||
final HttpServletResponse response,
|
||||
final Object handler,
|
||||
final Exception thrownException) {
|
||||
|
||||
final ExceptionHandler exceptionHandlerAnnotation = thrownException.getClass().getAnnotation(ExceptionHandler.class);
|
||||
if (exceptionHandlerAnnotation == null) {
|
||||
return new ModelAndView();
|
||||
}
|
||||
|
||||
return doStuffWithAnnotation(exceptionHandlerAnnotation, thrownException, response);
|
||||
}
|
||||
|
||||
private ModelAndView doStuffWithAnnotation(final ExceptionHandler exceptionHandlerAnnotation, final Exception thrownException, final HttpServletResponse response) {
|
||||
|
||||
response.setContentType(exceptionHandlerAnnotation.contentType());
|
||||
response.setStatus(exceptionHandlerAnnotation.httpStatus().value());
|
||||
try {
|
||||
response.getWriter().write(formatMessage(thrownException));
|
||||
} catch (IOException e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
return new ModelAndView();
|
||||
}
|
||||
|
||||
// Customize your output message here. If you have multiple dynamic parameters to
|
||||
// put into your template, you can assign them all in this method.
|
||||
private String formatMessage(final Exception thrownException) {
|
||||
return String.format(readTemplate(), thrownException.getMessage());
|
||||
}
|
||||
|
||||
// Reads the template file until the end of the line
|
||||
private String readTemplate() {
|
||||
try {
|
||||
final InputStream templateFile = new ClassPathResource("error.template").getInputStream();
|
||||
return new Scanner(templateFile, "UTF-8").useDelimiter("\\A").next().trim();
|
||||
} catch (IOException exception) {
|
||||
return "Default Error Message: %s";
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
package com.raychatter.common.annotation;
|
||||
|
||||
import org.springframework.http.HttpStatus;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@Target({
|
||||
ElementType.ANNOTATION_TYPE,
|
||||
ElementType.CONSTRUCTOR,
|
||||
ElementType.FIELD,
|
||||
ElementType.LOCAL_VARIABLE,
|
||||
ElementType.METHOD,
|
||||
ElementType.PARAMETER,
|
||||
ElementType.TYPE})
|
||||
public @interface ExceptionHandler {
|
||||
HttpStatus httpStatus() default HttpStatus.OK;
|
||||
String contentType();
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
package com.raychatter.common.annotation;
|
||||
|
||||
import junit.framework.TestCase;
|
||||
import org.junit.Test;
|
||||
|
||||
public class AnnotationHandlerTest extends TestCase {
|
||||
|
||||
@Test
|
||||
public void shouldReturnModelAndViewIfAnnotationIsNull() {
|
||||
AnnotationHandler annotationHandler = new AnnotationHandler();
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user