Package org.bedework.sysevents

Class NotificationsHandler

java.lang.Object
org.bedework.sysevents.NotificationsHandler
All Implemented Interfaces:
org.bedework.util.logging.Logged
public abstract class NotificationsHandler extends Object implements org.bedework.util.logging.Logged
Handler which may be called to notify the system that something changed.

Some implementations may be able to call immediately changes take effect, for example the bedework hibernate implementation can call at the point a calendar is changed. Others may have to poll to determine if something has changed.

Author:
Mike Douglass

  • Constructor Summary

    Constructors
    Constructor
    Description
    NotificationsHandler()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    close()
    Does its best to close.
    org.bedework.util.logging.BwLogger
    getLogger()
     
    abstract void
    post(SysEventBase ev)
    Called to notify container that an event occurred.
    abstract void
    registerListener(SysEventListener l, boolean persistent)
    Register a listener.
    abstract void
    removeListener(SysEventListener l)
    Remove a listener.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.bedework.util.logging.Logged

    audit, debug, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, trace, warn

  • Constructor Details

    • NotificationsHandler

      public NotificationsHandler()

  • Method Details

    • post

      public abstract void post(SysEventBase ev)
      Called to notify container that an event occurred.
      Parameters:
      ev - system event
      Throws:
      RuntimeException - on fatal error

    • registerListener

      public abstract void registerListener(SysEventListener l, boolean persistent)
      Register a listener.
      Parameters:
      l - the listener
      persistent - true if this listener is to be stored in the database and reregistered at each system startup.
      Throws:
      RuntimeException - on fatal error

    • removeListener

      public abstract void removeListener(SysEventListener l)
      Remove a listener. If persistent it will be deleted from the database.
      Parameters:
      l - the listener
      Throws:
      RuntimeException - on fatal error

    • close

      public abstract void close()
      Does its best to close.

    • getLogger

      public org.bedework.util.logging.BwLogger getLogger()
      Specified by:
      getLogger in interface org.bedework.util.logging.Logged