Package io.jmix.flowui.observation

Class UiObservationSupport

java.lang.Object
io.jmix.flowui.observation.UiObservationSupport
@Component("flowui_UiObservationSupport") public class UiObservationSupport extends Object
Support class for observing UI events such as view lifecycle events and action executions.

This class uses an ObservationRegistry if observation functionality is enabled in the application configuration.

Observation functionality can be turned on or off using the jmix.ui.ui-observation-enabled property in the application's configuration.

See Also:

  • Field Details

    • VIEW_OBSERVATION_NAME

      public static final String VIEW_OBSERVATION_NAME
      See Also:

    • FRAGMENT_OBSERVATION_NAME

      public static final String FRAGMENT_OBSERVATION_NAME
      See Also:

    • ACTION_OBSERVATION_NAME

      public static final String ACTION_OBSERVATION_NAME
      See Also:

    • observationRegistry

      @Autowired(required=false) protected io.micrometer.observation.ObservationRegistry observationRegistry

    • observationEnabled

      protected boolean observationEnabled

  • Constructor Details

    • UiObservationSupport

      public UiObservationSupport(UiProperties uiProperties)

  • Method Details

    • createViewLifecycleObservation

      public io.micrometer.observation.Observation createViewLifecycleObservation(View<?> view, com.vaadin.flow.component.ComponentEvent<?> viewEvent)

    • createViewLifecycleObservation

      public io.micrometer.observation.Observation createViewLifecycleObservation(View<?> view, ViewLifecycle lifecycle)

    • createViewLifecycleObservation

      public io.micrometer.observation.Observation createViewLifecycleObservation(ViewLifecycleObservationInfo observationInfo, ViewLifecycle lifecycle)

    • createFragmentLifecycleObservation

      public io.micrometer.observation.Observation createFragmentLifecycleObservation(Fragment<?> fragment, FragmentLifecycle lifecycle)

    • createFragmentLifecycleObservation

      public io.micrometer.observation.Observation createFragmentLifecycleObservation(FragmentLifecycleObservationInfo observationInfo, FragmentLifecycle lifecycle)

    • createActionExecutionObservation

      public io.micrometer.observation.Observation createActionExecutionObservation(Action action)

    • eventToLifecycle

      @Nullable protected ViewLifecycle eventToLifecycle(com.vaadin.flow.component.ComponentEvent<?> event)

    • isObservationAvailable

      protected boolean isObservationAvailable()