org.apache.isis.core.webapp.routing

Class RedirectToDocsFilter

java.lang.Object

org.apache.isis.core.webapp.routing.RedirectToDocsFilter

All Implemented Interfaces:

javax.servlet.Filter

public class RedirectToDocsFilter
extends Object
implements javax.servlet.Filter

This filter attempts to ensure that would-be users of the framework are directed to the bundled documentation, rather than just hitting the REST API (ie the json viewer).

Specifically, if the request is to "/" but the Accept header is anything other than "application/json" (eg is set to "text/html" and suggesting that the user is using a browser to access the webapp) then the filter redirects to /index.html (the documentation pages).

Only if the Accept header is set to application/json is the request allowed to continue through.

Constructor Summary

Constructors

Constructor and Description
RedirectToDocsFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig cfg)

Methods inherited from class java.lang.Object

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

Constructor Detail

RedirectToDocsFilter

public RedirectToDocsFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig cfg)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException