com.owlike.genson.ext.jaxrs

Class UrlQueryParamFilter

java.lang.Object

com.owlike.genson.ext.jaxrs.UrlQueryParamFilter

All Implemented Interfaces:

RuntimePropertyFilter, javax.ws.rs.container.ContainerRequestFilter

public class UrlQueryParamFilter
extends Object
implements RuntimePropertyFilter, javax.ws.rs.container.ContainerRequestFilter

This class will include or exclude (depending on how it is configured) the properties during ser/de based on the content of the query string.

Field Summary

Fields inherited from interface com.owlike.genson.reflect.RuntimePropertyFilter

noFilter

Constructor Summary

Constructors

Constructor and Description
UrlQueryParamFilter()

Method Summary

Modifier and Type	Method and Description
void	filter(javax.ws.rs.container.ContainerRequestContext containerRequestContext)
UrlQueryParamFilter	inclusionFilter(boolean yes) If true this will behave as an inclusion filter.
UrlQueryParamFilter	paramName(String queryParamName) The name of the query parameter to get the properties to filter.
boolean	shouldInclude(BeanProperty property, Context ctx)
UrlQueryParamFilter	splitBy(String pattern) When defined it will be used to split every param value into property names.

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlQueryParamFilter

public UrlQueryParamFilter()

Method Detail

shouldInclude

public boolean shouldInclude(BeanProperty property,
                             Context ctx)

Specified by:

shouldInclude in interface RuntimePropertyFilter

filter

public void filter(javax.ws.rs.container.ContainerRequestContext containerRequestContext)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerRequestFilter

Throws:

IOException

inclusionFilter

public UrlQueryParamFilter inclusionFilter(boolean yes)

If true this will behave as an inclusion filter. Meaning that only properties that are present in the query params will be included during ser/de. If false all properties are included by default and only the ones from the query params are excluded. True by default.

paramName

public UrlQueryParamFilter paramName(String queryParamName)

The name of the query parameter to get the properties to filter. Called "filter" by default.

splitBy

public UrlQueryParamFilter splitBy(String pattern)

When defined it will be used to split every param value into property names. This allows to use the filter in a non standard way like : localhost/foo?filter=age,name,gender