Package jakarta.faces.event

Interface SystemEventListener

All Superinterfaces:
EventListener, FacesListener
All Known Subinterfaces:
ViewMapListener
All Known Implementing Classes:
AjaxExceptionHandlerImpl, AjaxNoAjaxExceptionHandler, ExceptionHandler, ExceptionHandlerImpl, ExceptionHandlerWrapper, StateContext.DynamicAddRemoveListener, StateContext.NoopAddRemoveListener, StateContext.StatelessAddRemoveListener, ValidateComponentNesting, ViewScopeEventListener, ViewScopeManager, WebsocketFacesListener
public interface SystemEventListener extends FacesListener

By implementing this class, an object indicates that it is a listener for one or more kinds of SystemEvents. The exact type of event that will cause the implementing class's processEvent(jakarta.faces.event.SystemEvent) method to be called is indicated by the facesEventClass argument passed when the listener is installed using Application.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Class<?>, jakarta.faces.event.SystemEventListener).

Since:
2.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isListenerForSource(Object source)
    This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.
    void
    processEvent(SystemEvent event)
    When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

  • Method Details

    • processEvent

      void processEvent(SystemEvent event) throws AbortProcessingException

      When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

      Parameters:
      event - the SystemEvent instance that is being processed.
      Throws:
      AbortProcessingException - if lifecycle processing should cease for this request.

    • isListenerForSource

      boolean isListenerForSource(Object source)

      This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.

      Parameters:
      source - the source that is inquiring about the appropriateness of sending an event to this listener instance.
      Returns:
      the value as specified above