From 394319f54bcdbfc728da34f95239ac3d67935b1e Mon Sep 17 00:00:00 2001
From: Greg Turnquist <gturnquist@pivotal.io>
Date: Fri, 29 May 2015 12:54:09 -0500
Subject: [PATCH] DATAREST-535 - Add documentation about overriding SDR
 handlers

---
 src/main/asciidoc/customizing-sdr.adoc        |  1 +
 .../overriding-sdr-response-handlers.adoc     | 42 +++++++++++++++++++
 2 files changed, 43 insertions(+)
 create mode 100644 src/main/asciidoc/overriding-sdr-response-handlers.adoc

diff --git a/src/main/asciidoc/customizing-sdr.adoc b/src/main/asciidoc/customizing-sdr.adoc
index e475c1f7e..c9ca6d264 100644
--- a/src/main/asciidoc/customizing-sdr.adoc
+++ b/src/main/asciidoc/customizing-sdr.adoc
@@ -5,5 +5,6 @@ There are many options to tailor Spring Data REST. These subsections show how.
 
 include::configuring-the-rest-url-path.adoc[leveloffset=+1]
 include::adding-sdr-to-spring-mvc-app.adoc[leveloffset=+1]
+include::overriding-sdr-response-handlers.adoc[leveloffset=+1]
 include::customizing-json-output.adoc[leveloffset=+1]
 include::custom-jackson-deserialization.adoc[leveloffset=+1]
\ No newline at end of file
diff --git a/src/main/asciidoc/overriding-sdr-response-handlers.adoc b/src/main/asciidoc/overriding-sdr-response-handlers.adoc
new file mode 100644
index 000000000..daf92cae2
--- /dev/null
+++ b/src/main/asciidoc/overriding-sdr-response-handlers.adoc
@@ -0,0 +1,42 @@
+[[customizing-sdr.overriding-sdr-response-handlers]]
+= Overriding Spring Data REST Response Handlers
+
+Sometimes you may want to write a custom handler for a specific resource. To take advantage of Spring Data REST's settings, message converters, exception handling, and more, use the `@RepositoryRestController` annotation instead of a standard Spring MVC `@Controller` or `@RestController`:
+
+[source,java]
+----
+@RepositoryRestController
+public class ScannerController {
+
+    private final ScannerRepository repository;
+
+    @Autowired
+    public ScannerController(ScannerRepository repo) { // <1>
+        repository = repo;
+    }
+
+    @RequestMapping(method = GET, value = "/scanners/search/listProducers") // <2>
+    public @ResponseBody List<String> getProducers() {
+        List<String> producers = repository.listProducers(); // <3>
+
+        //
+        // do some intermediate processing, logging, etc. with the producers
+        //
+
+        return producers; // or some filtered/altered/mapped version
+    }
+
+}
+----
+
+This controller will be served from the same API base path defined in `RepositoryRestConfiguration.setBasePath` that is used by all other RESTful endpoints (e.g. */api*). It also has these characteristics:
+
+<1> This example uses constructor injection.
+<2> This handler plugs in a custom handler for a Spring Data finder method.
+<3> This handler is using the underlying repository to fetch data, but will tehn do some form of post processing before returning the final data set to the client.
+
+IMPORTANT: In this example, the combined path will be `RepositoryRestConfiguration.getBasePath()` + `/scanners/search/listProducers`.  
+
+If you're NOT interested in entity-specific operations but still want to build custom operations underneath `basePath`, such as Spring MVC views, resources, etc. use `@BasePathAwareController`.
+
+WARNING: If you use `@Controller` or `@RestController` for anything, that code will be totally outside the scope of Spring Data REST. This extends to request handling, message converters, exception handling, etc.
\ No newline at end of file