Interface IMonitorManager

    • Method Detail

      • monitor

        IMonitor monitor​(java.lang.String eventId,
                         ITransaction transaction)
                  throws PortalException
        Returns the monitor for an event with the given identifier.

        If no event with the given identifier exists then a warn message will be generated in the LumisXP log.

        If no event with the given identifier exists or if the event is disabled then a dummy monitor object will be returned (a IMonitor implementation that will not persist any data).

        If the given transaction is not null, the monitoring data will be saved after the transaction has terminated (either by a successful commit or by a rollback) and the monitor has been closed.

        If the given transaction is null, the monitoring data will be saved when the monitor has been closed.

        If the given transaction is not null, values for transaction result fields will provided automatically if the event has any of those fields.

        Parameters:
        eventId - the event identifier.
        transaction - the transaction the given monitor will be bound to.
        Returns:
        the monitor.
        Throws:
        java.lang.NullPointerException - if the given eventId is null or empty.
        PortalException
        Since:
        9.0.0
        See Also:
        IMonitor
      • getMonitorContext

        IMonitorContext getMonitorContext()
        Returns the current monitor context.
        Returns:
        the current monitor context, or null if there is no current monitor context.
        Since:
        9.0.0
      • getCurrentMonitorUserId

        java.lang.String getCurrentMonitorUserId()
        Returns the identifier of the current monitor user.
        Returns:
        the monitor user identifier, or null if it is not set.
        Since:
        11.0.0