ghoward 2003/06/30 21:40:00
Added: src/scratchpad/src/org/apache/cocoon/acting
CacheEventAction.java
Log:
Action to manually fire Cache Events - for testing/sample mainly.
Revision Changes Path
1.1
cocoon-2.1/src/scratchpad/src/org/apache/cocoon/acting/CacheEventAction.java
Index: CacheEventAction.java
===================================================================
/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
[EMAIL PROTECTED]
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Stefano Mazzocchi <[EMAIL PROTECTED]>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.acting;
import java.util.Map;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.cocoon.caching.Cache;
import org.apache.cocoon.caching.impl.EventAwareCacheImpl;
import org.apache.cocoon.caching.validity.NamedEvent;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Redirector;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.SourceResolver;
/**
* Very experimental start at external cache invalidation.
* Warning - API very unstable. Do not use! In fact, if this
* becomes useful, it would probably move to Excalibur SourceResolve.
*
* 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.
*
* @author Geoff Howard ([EMAIL PROTECTED])
* @version $CVS$
*/
public class CacheEventAction extends ComposerAction implements ThreadSafe {
/**
* Lookup the cache and call its processEvent method. Returns an
* empty map to signal success.
*/
public Map act(Redirector redirector,
SourceResolver resolver,
Map objectModel,
String src,
Parameters par
) throws Exception {
Cache cache = (Cache)this.manager.lookup(Cache.ROLE);
if (cache instanceof EventAwareCacheImpl) {
Request request = ObjectModelHelper.getRequest(objectModel);
String eventParam = par.getParameter("event");
String eventName = request.getParameter(eventParam);
if (getLogger().isDebugEnabled()) {
getLogger().debug("Configured for cache event named: " + eventName);
}
if (eventName == null || "".equals(eventName)) {
return null;
}
((EventAwareCacheImpl)cache).processEvent(new NamedEvent(eventName));
}
this.manager.release( cache );
return EMPTY_MAP;
}
}
