move controller endpoint

The endpoint for the postback controller is now at
`/webhook/blitline/image` to facilitate CSRF exemption for
Webhooks/postbacks generally.

Author: chrylis

blitline-image-client-example/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.blitline</groupId>
 		<artifactId>blitline-java-parent</artifactId>
-		<version>0.16.0-SNAPSHOT</version>
+		<version>0.16.0</version>
 	</parent>
 
 	<artifactId>blitline-image-client-example</artifactId>

blitline-image-client-spring/README.md

@@ -53,7 +53,7 @@ it can find in the Spring environment (see below).
 arguments.
 - If the `builtinPostback` property of the `@EnableBlitlineImageService`
 annotation is **not** set to `false`, a skeleton Spring MVC controller mapped
-to `/blitline/image`. This controller will accept the postbacks sent from
+to `/webhook/blitline/image`. This controller will accept the postbacks sent from
 Blitline and pass them on to a handler, which you must define.
 
 ####Properties
@@ -105,6 +105,20 @@ logic for what the system should do when a postback arrives. Register a bean
 implementing the `BlitlinePostbackHandler` interface, and it will be invoked
 whenever postbacks show up. See the example for a minimal implementation.
 
+You may be interested in custom HTTP headers that you specify to Blitline,
+such as a job-correlation ID. Simply register Spring beans of type `String`
+annotated with `@BlitlinePostbackHeader`, and any headers matching those
+names will be passed to the handler.
+
+Spring Integration's service-activator support can handle Blitline postbacks
+easily. Use the following declaration:
+
+````xml
+<int:gateway
+	service-interface="com.blitline.image.spring.postback.BlitlinePostbackHandler"
+    default-request-channel="your-postback-channel" />
+````
+
 #####Use your own endpoint
 
 If you want to heavily customize the postback handling, or if you would like
@@ -118,13 +132,9 @@ disable the built-in postback controller:
 In this case, if you want to use postbacks, you **must** specify the URL
 explicitly, as the system has no way of finding your custom endpoint.
 
-Spring Integration's inbound HTTP channel adapter can handle Blitline postbacks
-easily. Use the following declaration:
+####Security
 
-````xml
-<int-http:inbound-channel-adapter
-	path="/blitline"
-	channel="blitline-postback-announce"
-	request-payload-type="com.blitline.image.BlitlinePostback"
-	message-converters="blitlinePostbackHttpMessageConverter" />
-````
+Since postbacks will be coming in asynchronously, CSRF protection will need
+to be disabled for the postback endpoint. The built-in controller is mapped
+under `/webhook`, and it is suggested that `/webhook/**` be exempted from the
+CSRF policy and used to aggregate all such handlers.

blitline-image-client-spring/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.blitline</groupId>
 		<artifactId>blitline-java-parent</artifactId>
-		<version>0.16.0-SNAPSHOT</version>
+		<version>0.16.0</version>
 	</parent>
 
 	<artifactId>blitline-image-client-spring</artifactId>

blitline-image-client-spring/src/main/java/com/blitline/image/spring/web/BlitlinePostbackController.java

@@ -39,7 +39,7 @@
 @RequestMapping(BlitlinePostbackController.BASE_ENDPOINT)
 public class BlitlinePostbackController {
 
-    public static final String BASE_ENDPOINT = "/blitline";
+    public static final String BASE_ENDPOINT = "/webhook/blitline";
     public static final String IMAGE_PATH = "/image";
 
     private final Log log = LogFactory.getLog(BlitlinePostbackController.class);

blitline-image-client/README.md

@@ -40,7 +40,7 @@ API](https://www.blitline.com/docs/functions) will need to be reflected here.**
 
 BlitlineImageJob j = BlitlineImageJob.forApplication("myApplicationId")
     .fromUrl("http://cdn.blitline.com/filters/boys.jpeg") // also supports S3
-    .withPostback("https://backend.example.com/blitline") // for job status
+    .withPostback("https://backend.example.com/webhook/blitline/image") // for job status
     .apply( // function pipeline starts here
         Blitline.drawEllipse(150,150,200,100).andSaveResult("ellipse-overlay"),
         Blitline.cropToSquare().gravity(Gravity.SOUTHWEST).andSaveResult("square-color").thenApply(
@@ -49,14 +49,14 @@ BlitlineImageJob j = BlitlineImageJob.forApplication("myApplicationId")
                 )
             )
         );
-        
+
 String json = mapper.writeValueAsString(j);
 ````
 
 ````java
 // using Spring injection for identifiers and RestTemplate for HTTP operations
 
-final String IMAGE_IDENTIFIER = "ellipse-overlay"; 
+final String IMAGE_IDENTIFIER = "ellipse-overlay";
 
 @Autowired BlitlineImageService bis; // applicationId and optionally postbackUrl read from properties
 

blitline-image-client/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.blitline</groupId>
 		<artifactId>blitline-java-parent</artifactId>
-		<version>0.16.0-SNAPSHOT</version>
+		<version>0.16.0</version>
 	</parent>
 
 	<artifactId>blitline-image-client</artifactId>

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.blitline</groupId>
     <artifactId>blitline-java-parent</artifactId>
-    <version>0.16.0-SNAPSHOT</version>
+    <version>0.16.0</version>
     <packaging>pom</packaging>
     <name>Blitline Java client</name>
     <description>Java client libraries for Blitline</description>