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 java.lang.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
    java.lang.Object filter​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Object data)
    Modifies the given message data.
    protected java.lang.Object filterArray​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Object array)  
    protected java.lang.Object filterBoolean​(java.lang.Boolean bool)
    Deprecated.
    use filterBoolean(ServerSession, ServerChannel, Boolean) instead
    protected java.lang.Object filterBoolean​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Boolean bool)  
    protected java.lang.Object filterCollection​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.util.Collection<java.lang.Object> collection)  
    protected java.lang.Object filterList​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.util.List<java.lang.Object> list)  
    protected java.lang.Object filterMap​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.util.Map<java.lang.String,​java.lang.Object> map)  
    protected java.lang.Object filterNumber​(java.lang.Number number)
    Deprecated.
    use filterNumber(ServerSession, ServerChannel, Number) instead
    protected java.lang.Object filterNumber​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Number number)  
    protected java.lang.Object filterObject​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Object data)  
    protected java.lang.Object filterString​(java.lang.String string)
    Deprecated.
    use filterString(ServerSession, ServerChannel, String) instead
    protected java.lang.Object filterString​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.String string)  
    void init​(java.lang.Object init)  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • init

      public void init​(java.lang.Object init)

    • filter

      public java.lang.Object filter​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.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 java.lang.Object filterString​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.String string)

    • filterString

      @Deprecated protected java.lang.Object filterString​(java.lang.String string)
      Deprecated.
      use filterString(ServerSession, ServerChannel, String) instead
      Parameters:
      string - the string to filter
      Returns:
      a filtered object

    • filterBoolean

      protected java.lang.Object filterBoolean​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Boolean bool)

    • filterBoolean

      @Deprecated protected java.lang.Object filterBoolean​(java.lang.Boolean bool)
      Deprecated.
      use filterBoolean(ServerSession, ServerChannel, Boolean) instead
      Parameters:
      bool - the boolean to filter
      Returns:
      a filtered object

    • filterNumber

      protected java.lang.Object filterNumber​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Number number)

    • filterNumber

      @Deprecated protected java.lang.Object filterNumber​(java.lang.Number number)
      Deprecated.
      use filterNumber(ServerSession, ServerChannel, Number) instead
      Parameters:
      number - the number to filter
      Returns:
      a filtered object

    • filterArray

      protected java.lang.Object filterArray​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Object array)

    • filterList

      protected java.lang.Object filterList​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.util.List<java.lang.Object> list)

    • filterCollection

      protected java.lang.Object filterCollection​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.util.Collection<java.lang.Object> collection)

    • filterMap

      protected java.lang.Object filterMap​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.util.Map<java.lang.String,​java.lang.Object> map)

    • filterObject

      protected java.lang.Object filterObject​(org.cometd.bayeux.server.ServerSession session, org.cometd.bayeux.server.ServerChannel channel, java.lang.Object data)