com.ibm.events.filter

Interface Filter



  • public interface Filter
    The interface for the filter that is used by an event emitter to determine whether or not an event should be sent to the event service.
    Since:
    5.1.0
    Version:
    1.12 8/15/05
    See Also:
    Emitter
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void close()
      Causes the filter to release all resources that are owned by this object and its dependents.
      com.ibm.events.ComponentMetaData getMetaData()
      Obtains the metadata from this filter instance.
      boolean isEventEnabled(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent event)
      Determines whether or not the passed event matches the configured filtering criteria.
    • Method Detail

      • isEventEnabled

        boolean isEventEnabled(org.eclipse.hyades.logging.events.cbe.CommonBaseEvent event)
                               throws FilterException

        Determines whether or not the passed event matches the configured filtering criteria. The emitter forwards only events that return true from this method.

        Implementations of this method must be threadsafe.

        Parameters:
        event - The event instance that represents the event to be filtered.
        Returns:
        true if the event matches the filtering criteria and should, therefore, be passed to the event service by the emitter; false otherwise.
        Throws:
        FilterException - If an error occurs during filter processing.
      • getMetaData

        com.ibm.events.ComponentMetaData getMetaData()
                                                     throws FilterException
        Obtains the metadata from this filter instance.
        Returns:
        The component metadata for the filter.
        Throws:
        FilterException - If the metadata is not available.
      • close

        void close()
                   throws FilterException
        Causes the filter to release all resources that are owned by this object and its dependents.
        Throws:
        EventsException - If an error occurs when releasing resources held by the filter.
        FilterException
IBM Business Process ManagerTM
Release 8