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

Reformatted README file

Browse Source
This commit is contained in:
Rachel Walker
2012-12-03 17:25:18 -08:00
parent 54569e77a9
commit 6bc5bff45e
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -2,17 +2,16 @@
### An annotation for the Spring framework to handle HTTP responses for custom exceptions. ### An annotation for the Spring framework to handle HTTP responses for custom exceptions.
## How to use spring-restful-exception-handler ## How to use spring-restful-exception-handler
Under $PROJECT/resources create a file called *error.template*. Inside this file, place the formatted error template you want to return when a custom exception is thrown. If no custom template is given, the following default template will be used: Under PROJECT/resources create a file called *error.template*. Inside this file, place the formatted error template you want to return when a custom exception is thrown. If no custom template is given, the following default template will be used:
<?xml version="1.0" encoding="UTF-8"?> `<?xml version="1.0" encoding="UTF-8"?>`
<error> `<error>`
%s `%s`
</error> `</error>`
Annotate the custom exception class with Annotate the custom exception class with `@Exception(*httpStatus*, *contentType*)`.
@Exception(*httpStatus*, *contentType*)
The defaults are The defaults are
httpStatus = HttpStatus.INTERNAL_SERVER_ERROR `httpStatus = HttpStatus.INTERNAL_SERVER_ERROR`
contentType = MediaType.APPLICATION_XML_VALUE `contentType = MediaType.APPLICATION_XML_VALUE`
Make sure to add *com.raychatter.common.annotation.AnnotationHandler* as a bean in your XML. Make sure to add `com.raychatter.common.annotation.AnnotationHandler` as a bean in your XML.
And that's it! And that's it!