io.apiman.common.servlet

Class ApimanCorsFilter

java.lang.Object

io.apiman.common.servlet.ApimanCorsFilter

All Implemented Interfaces:

javax.servlet.Filter

public class ApimanCorsFilter
extends Object
implements javax.servlet.Filter

A simple CORS filter for apiman.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
ApimanCorsFilter() Constructor.

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)
protected boolean	hasOriginHeader(javax.servlet.http.HttpServletRequest httpReq) Returns true if the Origin request header is present.
void	init(javax.servlet.FilterConfig config)
protected boolean	isOptionsMethod(javax.servlet.http.HttpServletRequest httpReq) Returns true if it's an OPTIONS http request.
protected boolean	isPreflightRequest(javax.servlet.http.HttpServletRequest httpReq) Determines whether the request is a CORS preflight request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApimanCorsFilter

public ApimanCorsFilter()

Constructor.

Method Detail

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

See Also:

Filter.init(javax.servlet.FilterConfig)

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

See Also:

Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)

isPreflightRequest

protected boolean isPreflightRequest(javax.servlet.http.HttpServletRequest httpReq)

Determines whether the request is a CORS preflight request.

Parameters:

httpReq - the http servlet request

Returns:

true if preflight, else false

isOptionsMethod

protected boolean isOptionsMethod(javax.servlet.http.HttpServletRequest httpReq)

Returns true if it's an OPTIONS http request.

Parameters:

httpReq - the http servlet request

Returns:

true if options method, else false

hasOriginHeader

protected boolean hasOriginHeader(javax.servlet.http.HttpServletRequest httpReq)

Returns true if the Origin request header is present.

Parameters:

httpReq - the http servlet request

Returns:

true if has origin header, else false

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

See Also:

Filter.destroy()