Package de.uplanet.lucy.server.portalserver

Class ServerEventDispatcher

java.lang.Object
de.uplanet.lucy.server.portalserver.ServerEventDispatcher
@Scriptable @SpringBeanAccessor public final class ServerEventDispatcher extends Object
A dispatcher for server events that must be defined in the Spring application context of the portal server.

The dispatcher does not hold strong references to the registered listeners, so the caller must control the lifecycle of the listener instances.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BEAN_NAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    checkAvailable()
    Deprecated.
    Do not use this method.
    static void
    checkAvailable(org.springframework.context.ApplicationContext p_appCtx)
    Check if the serverEventDispatcher bean is defined.
    static de.uplanet.lucy.server.portalserver.IServerEventDispatcher
    getInstance()
    Get the serverEventDispatcher bean.
    static de.uplanet.lucy.server.portalserver.IServerEventDispatcher
    getInstance(org.springframework.context.ApplicationContext p_appCtx)
    Get the serverEventDispatcher bean.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • checkAvailable

      @Deprecated public static void checkAvailable()
      Deprecated.
      Do not use this method.
      Throws:
      IllegalStateException - If the server event dispatcher is not available.

    • checkAvailable

      public static void checkAvailable(org.springframework.context.ApplicationContext p_appCtx)
      Check if the serverEventDispatcher bean is defined.
      Throws:
      IllegalStateException - If the server event dispatcher is not available.

    • getInstance

      public static de.uplanet.lucy.server.portalserver.IServerEventDispatcher getInstance() throws org.springframework.beans.BeansException
      Get the serverEventDispatcher bean.
      Returns:
      The bean.
      Throws:
      org.springframework.beans.factory.NoSuchBeanDefinitionException - If the bean serverEventDispatcher is not defined.
      org.springframework.beans.factory.BeanNotOfRequiredTypeException - If the bean is not of the required type.
      org.springframework.beans.BeansException - If the bean could not be created.

    • getInstance

      public static de.uplanet.lucy.server.portalserver.IServerEventDispatcher getInstance(org.springframework.context.ApplicationContext p_appCtx) throws org.springframework.beans.BeansException
      Get the serverEventDispatcher bean.
      Parameters:
      p_appCtx - The Spring application context.
      Returns:
      The bean.
      Throws:
      org.springframework.beans.factory.NoSuchBeanDefinitionException - If the bean serverEventDispatcher is not defined.
      org.springframework.beans.factory.BeanNotOfRequiredTypeException - If the bean is not of the required type.
      org.springframework.beans.BeansException - If the bean could not be created.