Interface PhaseListener

  • All Superinterfaces:
    java.util.EventListener, java.io.Serializable


    public interface PhaseListener
    extends java.util.EventListener, java.io.Serializable

    An interface implemented by objects that wish to be notified at the beginning and ending of processing for each standard phase of the request processing lifecycle.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void afterPhase​(PhaseEvent event)
      Handle a notification that the processing for a particular phase has just been completed.
      void beforePhase​(PhaseEvent event)
      Handle a notification that the processing for a particular phase of the request processing lifecycle is about to begin.
      PhaseId getPhaseId​()
      Return the identifier of the request processing phase during which this listener is interested in processing PhaseEvent events.
    • Method Detail

      • afterPhase

        void afterPhase​(PhaseEvent event)

        Handle a notification that the processing for a particular phase has just been completed.

        Parameters:
        event - the phase event.
      • beforePhase

        void beforePhase​(PhaseEvent event)

        Handle a notification that the processing for a particular phase of the request processing lifecycle is about to begin.

        Parameters:
        event - the phase event.
      • getPhaseId

        PhaseId getPhaseId​()

        Return the identifier of the request processing phase during which this listener is interested in processing PhaseEvent events. Legal values are the singleton instances defined by the PhaseId class, including PhaseId.ANY_PHASE to indicate an interest in being notified for all standard phases.

        Returns:
        the phase id.