Package org.apache.jackrabbit.oak.plugins.observation.filter

Interface EventFilter

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable EventFilter create​(java.lang.String name, org.apache.jackrabbit.oak.spi.state.NodeState before, org.apache.jackrabbit.oak.spi.state.NodeState after)
      Factory for creating a filter instance for the given child node
      boolean includeAdd​(java.lang.String name, org.apache.jackrabbit.oak.spi.state.NodeState after)
      Include an added node
      boolean includeAdd​(org.apache.jackrabbit.oak.api.PropertyState after)
      Include an added property
      boolean includeChange​(org.apache.jackrabbit.oak.api.PropertyState before, org.apache.jackrabbit.oak.api.PropertyState after)
      Include a changed property
      boolean includeDelete​(java.lang.String name, org.apache.jackrabbit.oak.spi.state.NodeState before)
      Include a deleted node
      boolean includeDelete​(org.apache.jackrabbit.oak.api.PropertyState before)
      Include a deleted property
      boolean includeMove​(java.lang.String sourcePath, java.lang.String name, org.apache.jackrabbit.oak.spi.state.NodeState moved)
      Include a moved node
      boolean includeReorder​(java.lang.String destName, java.lang.String name, org.apache.jackrabbit.oak.spi.state.NodeState reordered)
      Include a reordered node

    • Method Detail

      • includeAdd

        boolean includeAdd​(org.apache.jackrabbit.oak.api.PropertyState after)
        Include an added property
        Parameters:
        after - added property
        Returns:
        true if the property should be included

      • includeChange

        boolean includeChange​(org.apache.jackrabbit.oak.api.PropertyState before,
                      org.apache.jackrabbit.oak.api.PropertyState after)
        Include a changed property
        Parameters:
        before - property before the change
        after - property after the change
        Returns:
        true if the property should be included

      • includeDelete

        boolean includeDelete​(org.apache.jackrabbit.oak.api.PropertyState before)
        Include a deleted property
        Parameters:
        before - deleted property
        Returns:
        true if the property should be included

      • includeAdd

        boolean includeAdd​(java.lang.String name,
                   org.apache.jackrabbit.oak.spi.state.NodeState after)
        Include an added node
        Parameters:
        name - name of the node
        after - added node
        Returns:
        true if the node should be included

      • includeDelete

        boolean includeDelete​(java.lang.String name,
                      org.apache.jackrabbit.oak.spi.state.NodeState before)
        Include a deleted node
        Parameters:
        name - name of the node
        before - deleted node
        Returns:
        true if the node should be included

      • includeMove

        boolean includeMove​(java.lang.String sourcePath,
                    java.lang.String name,
                    org.apache.jackrabbit.oak.spi.state.NodeState moved)
        Include a moved node
        Parameters:
        sourcePath - source path of the move operation
        name - name of the moved node
        moved - the moved node
        Returns:
        true if the node should be included

      • includeReorder

        boolean includeReorder​(java.lang.String destName,
                       java.lang.String name,
                       org.apache.jackrabbit.oak.spi.state.NodeState reordered)
        Include a reordered node
        Parameters:
        destName - name of the orderBefore() destination node
        name - name of the reordered node
        reordered - the reordered node
        Returns:
        true if the node should be included

      • create

        @Nullable
@Nullable EventFilter create​(java.lang.String name,
                             org.apache.jackrabbit.oak.spi.state.NodeState before,
                             org.apache.jackrabbit.oak.spi.state.NodeState after)
        Factory for creating a filter instance for the given child node
        Parameters:
        name - name of the child node
        before - before state of the child node
        after - after state of the child node
        Returns:
        filter instance for filtering the child node or null to exclude the sub tree rooted at this child node.