com.atlassian.plugins.rest.common.filter
Class ExtensionJerseyFilter

java.lang.Object
  com.atlassian.plugins.rest.common.filter.ExtensionJerseyFilter

All Implemented Interfaces:

com.sun.jersey.spi.container.ContainerRequestFilter

@Provider
public class ExtensionJerseyFilter
extends java.lang.Object
implements com.sun.jersey.spi.container.ContainerRequestFilter

A filter to handle URI with extensions. It will set the correct accept header for each extension and remove the extension from the URI to allow for normal processing of the request.

Currently supported extension and their matching headers are defined in the extension to header mapping.

One can exclude URIs from being processed by this filter. Simply create the filter with a collection of patterns to be excluded.

Example: URI http://localhost:8080/app/rest/my/resource.json would be automatically mapped to URI http://localhost:8080/app/rest/my/resource with its accept header set to application/json

Constructor Summary

ExtensionJerseyFilter()

ExtensionJerseyFilter(java.util.Collection<java.lang.String> pathExcludePatterns)

Method Summary

com.sun.jersey.spi.container.ContainerRequest

filter(com.sun.jersey.spi.container.ContainerRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionJerseyFilter

public ExtensionJerseyFilter()

ExtensionJerseyFilter

public ExtensionJerseyFilter(java.util.Collection<java.lang.String> pathExcludePatterns)

Method Detail

filter

public com.sun.jersey.spi.container.ContainerRequest filter(com.sun.jersey.spi.container.ContainerRequest request)

Specified by:

filter in interface com.sun.jersey.spi.container.ContainerRequestFilter