Package org.cometd.server.filter

Class JSONDataFilter

java.lang.Object

org.cometd.server.filter.JSONDataFilter

All Implemented Interfaces:

DataFilter

Direct Known Subclasses:

NoMarkupFilter, NoScriptsFilter, RegexFilter

public class JSONDataFilter
extends Object
implements DataFilter

JSONDataFilter walks an object to see if it is a JSON data structure and calls the appropriate methods filterString(ServerSession, ServerChannel, String), filterNumber(ServerSession, ServerChannel, Number), filterBoolean(ServerSession, ServerChannel, Boolean), filterArray(ServerSession, ServerChannel, Object), filterCollection(ServerSession, ServerChannel, Collection), filterList(ServerSession, ServerChannel, List), filterMap(ServerSession, ServerChannel, Map).

Derived filters may override one or more of these methods to provide filtering of specific types.

Nested Class Summary

Nested classes/interfaces inherited from interface org.cometd.server.filter.DataFilter

DataFilter.Abort, DataFilter.AbortException

Constructor Summary

Constructors

Constructor	Description
JSONDataFilter()

Method Summary

Modifier and Type	Method	Description
Object	filter(ServerSession session, ServerChannel channel, Object data)	Modifies the given message data.
protected Object	filterArray(ServerSession session, ServerChannel channel, Object array)
protected Object	filterBoolean(Boolean bool)	Deprecated. use filterBoolean(ServerSession, ServerChannel, Boolean) instead
protected Object	filterBoolean(ServerSession session, ServerChannel channel, Boolean bool)
protected Object	filterCollection(ServerSession session, ServerChannel channel, Collection<Object> collection)
protected Object	filterList(ServerSession session, ServerChannel channel, List<Object> list)
protected Object	filterMap(ServerSession session, ServerChannel channel, Map<String,Object> map)
protected Object	filterNumber(Number number)	Deprecated. use filterNumber(ServerSession, ServerChannel, Number) instead
protected Object	filterNumber(ServerSession session, ServerChannel channel, Number number)
protected Object	filterObject(ServerSession session, ServerChannel channel, Object data)
protected Object	filterString(String string)	Deprecated. use filterString(ServerSession, ServerChannel, String) instead
protected Object	filterString(ServerSession session, ServerChannel channel, String string)
void	init(Object init)

Methods inherited from class java.lang.Object

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

Constructor Details

JSONDataFilter

public JSONDataFilter()

Method Details

init

public void init(Object init)

filter

public Object filter(ServerSession session, ServerChannel channel, Object data)

Description copied from interface: DataFilter

Modifies the given message data.

Returning null or throwing DataFilter.AbortException results in the message processing being interrupted and the message itself discarded.

If the returned object is different (as returned by the != operator) from the data parameter then it is set as the new message data via Message.Mutable.setData(Object).

Specified by:

filter in interface DataFilter

Parameters:

session - the ServerSession that sends the data

channel - the channel the data is being sent on

data - the data being sent

Returns:

the transformed data or null if the message should be ignored

filterString

protected Object filterString(ServerSession session, ServerChannel channel, String string)

filterString

@Deprecated protected Object filterString(String string)

Deprecated.

use filterString(ServerSession, ServerChannel, String) instead

Parameters:

string - the string to filter

Returns:

a filtered object

filterBoolean

protected Object filterBoolean(ServerSession session, ServerChannel channel, Boolean bool)

filterBoolean

@Deprecated protected Object filterBoolean(Boolean bool)

Deprecated.

use filterBoolean(ServerSession, ServerChannel, Boolean) instead

Parameters:

bool - the boolean to filter

Returns:

a filtered object

filterNumber

protected Object filterNumber(ServerSession session, ServerChannel channel, Number number)

filterNumber

@Deprecated protected Object filterNumber(Number number)

Deprecated.

use filterNumber(ServerSession, ServerChannel, Number) instead

Parameters:

number - the number to filter

Returns:

a filtered object

filterArray

protected Object filterArray(ServerSession session, ServerChannel channel, Object array)

filterList

protected Object filterList(ServerSession session, ServerChannel channel, List<Object> list)

filterCollection

protected Object filterCollection(ServerSession session, ServerChannel channel, Collection<Object> collection)

filterMap

protected Object filterMap(ServerSession session, ServerChannel channel, Map<String,Object> map)

filterObject

protected Object filterObject(ServerSession session, ServerChannel channel, Object data)