mindol1004/spring-restful-exception-handler
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reorganized README

Browse Source
This commit is contained in:
raychatter
2013-01-15 14:47:28 -08:00
parent a099e1f8c9
commit c579b866c6
1 changed files with 24 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -1,11 +1,28 @@
# spring-restful-exception-handler
An annotation for the Spring framework to handle HTTP responses for custom exceptions. The way it works is you have to change the default exception resolver for Spring to our custom exception resolver by modifying your servlet xml file for Spring:
An annotation for the Spring framework to handle HTTP responses for custom exceptions.
### Bean Setup and Properties:
The way it works is you have to change the default exception resolver for Spring to our custom exception resolver by modifying your servlet xml file for Spring:
```xml
<bean id="exceptionResolver" class="com.github.raychatter.AnnotationHandler" />
<bean id="exceptionResolver" class="com.github.raychatter.AnnotationHandler">
<property name="useHandledExceptionMessage" value="true"/>
<property name="useGetCause" value="true"/>
</bean>
```
There are two boolean properties that can be set within the spring-restful-exception-handler bean:
`useGetCause` (true by default)
If an unannotated exception is thrown and `useGetCause` is true, the spring-restful-exception-handler will call `getCause()` on the exception until the first annotated exception is found. Provided there is no annotated exception or `useGetcause` is set to false, the default httpStatus and contentType will be used with the thrown exception.
`useHandledExceptionMessage` (true by default)
Sometimes it is useful to give the user a "higher level" exception response message than the one associated with the handled (annotated) exception. When `useHandledExceptionMessage` is true (which is the default setting), the message returned will be that from the annotated exception. If this property or `useGetCause` is set to false or there is no annotated exception, the message used will be from the thrown exception.
### Annotate the Custom Exception Class:
After overriding the exception resolving mechanism, just annotate the custom exception classes with `@ExceptionHandler(*httpStatus*, *contentType*)`. The defaults are `httpStatus = HttpStatus.INTERNAL_SERVER_ERROR` and `contentType = MediaType.APPLICATION_XML_VALUE`. So an example exception class would be:
```java
@@ -19,7 +36,11 @@ public class MyCustomException extends Exception {
The custom message is taken from the custom annotation class itself, so any parameters you'd like to insert need to be handled there.
And that's it! Just keep in mind that the exception handler will take care of all the exceptions and by default it will return `Internal Server Error` with an `XML` body described above. If you don't specify any custom template for your error responses, following error template will be used by default:
And that's it! Just keep in mind that the exception handler will take care of all the exceptions and by default it will return `Internal Server Error` with an `XML` body described above.
### Error Response Template:
If you don't specify any custom template for your error responses, following error template will be used by default:
```xml
<?xml version="1.0" encoding="UTF-8"?>
@@ -46,13 +67,3 @@ public class MyCustomException extends Exception {
}
}
```
### Bean Properties:
There are two boolean properties that can be set within the spring-restful-exception-handler bean:
`useGetCause`
If an unannotated exception is thrown, the spring-restful-exception-handler will call `getCause()` on the exception until the first annotated exception is found. Provided there is no annotated exception or `useGetcause` is set to false, the default httpStatus and contentType will be used with the thrown exception.
`useHandledExceptionMessage`
Sometimes it is useful to give the user a "higher level" exception response message than the one associated with the handled (annotated) exception. When `useHandledExceptionMessage` is true (which is the default setting), the message returned will be that from the annotated exception. If this property or `useGetCause` is set to false or there is no annotated exception, the message used will be from the thrown exception.