Interface I_CmsEventListener

All Known Subinterfaces:
I_CmsModuleAction
All Known Implementing Classes:
A_CmsModuleAction, CmsADECache, CmsDriverManager, CmsExplorerTypeAccessFlushListener, CmsFlexCache, CmsGlobalConfigurationCacheEventHandler, CmsGwtServiceContext, CmsIconUtil, CmsImageLoader, CmsJspLoader, CmsLocaleManager, CmsMemoryObjectCache, CmsSearchManager, CmsSearchManager.CmsSearchOfflineHandler, CmsSiteManagerImpl, CmsStaticExportManager, CmsVfsBundleManager, CmsVfsCache, CmsVfsMemoryObjectCache, CmsWorkplaceManager, CmsXmlEntityResolver

public interface I_CmsEventListener
Implement this interface in case your class has to react to CmsEvents that are thrown by system.

In order to receive system events, your class must register with the OpenCms event mechanism. This can be done in the constructor of a class like this:

 org.opencms.main.OpenCms.addCmsEventListener(this);
 
A typical implementation might look like this:
 public void cmsEvent(org.opencms.main.CmsEvent event) {
     switch (event.getType()) {
         case org.opencms.main.I_CmsEventListener.EVENT_PUBLISH_PROJECT:
         case org.opencms.main.I_CmsEventListener.EVENT_CLEAR_CACHES:
             // do something
             break;
         case org.opencms.main.I_CmsEventListener.EVENT_LOGIN_USER:
            // do something else
             break;
         }
 }
 
Since:
6.0.0
See Also: