vdurmont / jsonp-filter

A J2EE Servlet filter to wrap JSON responses in a JSONP callback

Usage

Include jsonp-filter in your pom.xml:

<dependencies>
  <dependency>
    <groupId>com.earldouglas</groupId>
    <artifactId>jsonp-filter</artifactId>
    <version>1.0.0</version>
  </dependency>
</dependencies>

Add a JsonPFilter to your web.xml:

<filter>
  <filter-name>jsonp-filter</filter-name>
  <filter-class>com.earldouglas.jsonpfilter.JsonPFilter</filter-class>
</filter>
<filter-mapping>
  <filter-name>jsonp-filter</filter-name>
  <url-pattern>/foo</url-pattern>
</filter-mapping>

Optionally configure the callback parameter name (defaults to callback) and the variable parameter name (defaults to variable):

<filter>
  <filter-name>jsonp-filter</filter-name>
  <filter-class>com.earldouglas.jsonpfilter.JsonPFilter</filter-class>
  <init-param>
    <param-name>callbackParam</param-name>
    <param-value>calleybackey</param-value>
  </init-param>
  <init-param>
    <param-name>variableParam</param-name>
    <param-value>custom</param-value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>jsonp-filter</filter-name>
  <url-pattern>/foo</url-pattern>
</filter-mapping>

Now any requests to /foo with the callback query parameter set will have their responses wrapped in callback(...). All responses with the query parameter variable set will be like var variable = ...;. In the second case, responses will be wrapped in calleybackey(...) or set to var custom = ...;.

Java config

If you do not use a web.xml config file and want to instantiate the filter manually, you can use:

JSsonPFilter filter = new JsonPFilter();
filter.setCallbackParam("customCallback");
filter.setVariableParam("customVariable");

Or:

JsonPFilter filter = new JsonPFilter("customCallback", "customVariable");