Class ChannelListener

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int order  
    • Constructor Summary

      Constructors 
      Constructor Description
      ChannelListener()
      Constructs a ChannelListener with order = 0
      ChannelListener​(int order)
      Constructs a ChannelListener with the given order
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(java.lang.Object obj)
      Compare this object with the specified object for order.
      boolean equals​(java.lang.Object obj)
      Indicates wheter some other object is "equal to" this one.
      void handleFinalize()
      Called when the channel is finalized
      boolean init​(Plugin plugin)
      Initialize the component with the given plugin configuration
      void initAfterStartup()
      Called at the end of JPlatform startup.
      void initAfterStoreLoad()
      Called just after the store has been loaded and the channel has been initialized.
      void initBeforeHibernateFactoryBuild()
      Called before the build of hibernate session factory (after adding all core/plugins type in configuration).
      void initBeforeStoreLoad()
      Called just before the store has been loaded.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • order

        protected int order
    • Constructor Detail

      • ChannelListener

        public ChannelListener()
        Constructs a ChannelListener with order = 0
        Since:
        jcms-5.0.0
      • ChannelListener

        public ChannelListener​(int order)
        Constructs a ChannelListener with the given order
        Parameters:
        order - the order
        Since:
        jcms-5.5.0
    • Method Detail

      • compareTo

        public int compareTo​(java.lang.Object obj)
        Compare this object with the specified object for order.
        Specified by:
        compareTo in interface java.lang.Comparable
        Parameters:
        obj - the Object to be compared.
        See Also:
        Comparable.compareTo(java.lang.Object)
      • equals

        public boolean equals​(java.lang.Object obj)
        Indicates wheter some other object is "equal to" this one. The comparison is performed with compareTo() method.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the Object to be compared.
      • init

        public boolean init​(Plugin plugin)
        Description copied from interface: PluginComponent
        Initialize the component with the given plugin configuration
        Specified by:
        init in interface PluginComponent
        Parameters:
        plugin - the calling plugin
        Returns:
        true if the component has been correctly initialized.
      • handleFinalize

        public void handleFinalize()
        Called when the channel is finalized
        Since:
        jcms-2.1
      • initBeforeStoreLoad

        public void initBeforeStoreLoad()
                                 throws java.lang.Exception
        Called just before the store has been loaded. If for any reason you want to interrupt JCMS startup, you can throw an exception. The exception's message will be displayed in JCMS status page (to any user!).
        Throws:
        java.lang.Exception - any exception you may want to throw if a problem occurs needing to interrupt JCMS startup.
        Since:
        jcms-5.7.0
      • initAfterStoreLoad

        public void initAfterStoreLoad()
                                throws java.lang.Exception
        Called just after the store has been loaded and the channel has been initialized. If for any reason you want to interrupt JCMS startup, you can throw an exception. The exception's message will be displayed in JCMS status page (to any user!).
        Throws:
        java.lang.Exception - any exception you may want to throw if a problem occurs needing to interrupt JCMS startup.
        Since:
        jcms-5.7.0
      • initAfterStartup

        public void initAfterStartup()
        Called at the end of JPlatform startup.
        Since:
        jcms-10.0.5
      • initBeforeHibernateFactoryBuild

        public void initBeforeHibernateFactoryBuild()
                                             throws java.lang.Exception
        Called before the build of hibernate session factory (after adding all core/plugins type in configuration).
        Throws:
        java.lang.Exception
        Since:
        jcms-10.0.6