org.springframework.batch.admin.web.filter

Class ParameterUnpackerFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.batch.admin.web.filter.ParameterUnpackerFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.web.context.ServletContextAware

public class ParameterUnpackerFilter
extends org.springframework.web.filter.OncePerRequestFilter

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor and Description
ParameterUnpackerFilter()

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
protected java.util.Collection<? extends java.lang.String>	extractPathKeys(java.lang.String paramName, java.lang.String delimiter)
void	setDelimiter(java.lang.String delimiter)
void	setPrefix(java.lang.String prefix)
void	setPutEmptyParamsInPath(boolean putEmptyParamsInPath) Flag to say that empty parameter value signal their name should be used as a path parameter.
protected java.util.Map<java.lang.String,java.lang.String[]>	unpack(java.lang.String paramName, java.lang.String delimiter)

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, destroy, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterUnpackerFilter

public ParameterUnpackerFilter()

Method Detail

setPutEmptyParamsInPath

public void setPutEmptyParamsInPath(boolean putEmptyParamsInPath)

Flag to say that empty parameter value signal their name should be used as a path parameter. E.g. /context/path?unpack_foo goes to context/path/foo.

Parameters:

putEmptyParamsInPath - the flag value to set (defaults to false)

setDelimiter

public void setDelimiter(java.lang.String delimiter)

Parameters:

delimiter - the delimiter used to separate parameter names from values

setPrefix

public void setPrefix(java.lang.String prefix)

Parameters:

prefix - the prefix for parameter names that need to be unpacked

doFilterInternal

protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

javax.servlet.ServletException

java.io.IOException

extractPathKeys

protected java.util.Collection<? extends java.lang.String> extractPathKeys(java.lang.String paramName,
                                                                           java.lang.String delimiter)

unpack

protected java.util.Map<java.lang.String,java.lang.String[]> unpack(java.lang.String paramName,
                                                                    java.lang.String delimiter)