Class CacheEventAction

  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.acting.AbstractAction
          extended by org.apache.cocoon.acting.ServiceableAction
              extended by org.apache.cocoon.acting.CacheEventAction
All Implemented Interfaces:
Component, LogEnabled, Serviceable, ThreadSafe, Action

public class CacheEventAction
extends ServiceableAction
implements ThreadSafe

Simple action to cause notification of a NamedEvent to an EventAwareCacheImpl. The event name is taken from a sitemap parameter named "event". This action returns null (fails) if the configured event is null or the empty string. Otherwise, it succeeds and returns an empty Map. This is used in the Event based cache example.

CVS $Id: CacheEventAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Geoff Howard (

Field Summary
Fields inherited from class org.apache.cocoon.acting.ServiceableAction
Fields inherited from class org.apache.cocoon.acting.AbstractAction
Fields inherited from interface org.apache.cocoon.acting.Action
Constructor Summary
Method Summary
 Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String src, Parameters par)
          Lookup the cache and call its processEvent method.
Methods inherited from class org.apache.cocoon.acting.ServiceableAction
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public CacheEventAction()
Method Detail


public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String src,
               Parameters par)
        throws Exception
Lookup the cache and call its processEvent method. Returns an empty map to signal success.

Specified by:
act in interface Action
resolver - The SourceResolver in charge
objectModel - The Map with object of the calling environment which can be used to select values this controller may need (ie Request, Response).
src - A source String to the Action
par - The Parameters for this invocation
Map The returned Map object with sitemap substitution values which can be used in subsequent elements attributes like src= using a xpath like expression: src="mydir/{myval}/foo" If the return value is null the processing inside the element of the sitemap will be skipped.
Exception - Indicates something is totally wrong

Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.