Package org.opencms.jsp.jsonpart
Class CmsJsonPartFilter
- java.lang.Object
-
- org.opencms.jsp.jsonpart.CmsJsonPartFilter
-
- All Implemented Interfaces:
javax.servlet.Filter
public class CmsJsonPartFilter extends java.lang.Object implements javax.servlet.Filter
This servlet filter post-processes the response output for requests with the parameter '__json=true'.It converts the encoded JSON parts generated by the <cms:jsonpart> tag, converts them to JSON, writes them to the response, and throws everything else away.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
KEY_PARTS
JSON key for the list of part keys.static java.lang.String
PARAM_JSON
Name of the parameter used to enable JSON rendering.
-
Constructor Summary
Constructors Constructor Description CmsJsonPartFilter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
destroy()
void
doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void
init(javax.servlet.FilterConfig filterConfig)
static boolean
isJsonRequest(javax.servlet.ServletRequest request)
Detects whether the filter needs to be used for the given request.
-
-
-
Field Detail
-
KEY_PARTS
public static final java.lang.String KEY_PARTS
JSON key for the list of part keys.- See Also:
- Constant Field Values
-
PARAM_JSON
public static final java.lang.String PARAM_JSON
Name of the parameter used to enable JSON rendering.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsJsonPartFilter
public CmsJsonPartFilter()
-
-
Method Detail
-
isJsonRequest
public static boolean isJsonRequest(javax.servlet.ServletRequest request)
Detects whether the filter needs to be used for the given request.- Parameters:
request
- the request- Returns:
- true if the filter should be used for the request
-
destroy
public void destroy()
- Specified by:
destroy
in interfacejavax.servlet.Filter
- See Also:
Filter.destroy()
-
doFilter
public void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) throws java.io.IOException, javax.servlet.ServletException
- Specified by:
doFilter
in interfacejavax.servlet.Filter
- Throws:
java.io.IOException
javax.servlet.ServletException
- See Also:
Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)
-
init
public void init(javax.servlet.FilterConfig filterConfig)
- Specified by:
init
in interfacejavax.servlet.Filter
- See Also:
Filter.init(javax.servlet.FilterConfig)
-
-