org.apache.cocoon.components.source.impl
Interface Refresher

All Known Implementing Classes:
DelayRefresher

public interface Refresher

A Refresher is a component that updates the cached contents of a Source.

Implementations can for instance trigger updates based on a timeout value or in response to an external event.

Since:
2.1.1
Version:
CVS $Id: Refresher.java 30941 2004-07-29 19:56:58Z vgritsenko $

Field Summary
static String ROLE
           
 
Method Summary
 void refresh(IdentifierCacheKey cacheKey, String uri, String cacheRole, Parameters params)
          Add a uri to the Refresher.
 

Field Detail

ROLE

public static final String ROLE
Method Detail

refresh

public void refresh(IdentifierCacheKey cacheKey,
                    String uri,
                    String cacheRole,
                    Parameters params)
             throws SourceException
Add a uri to the Refresher.

Parameters:
cacheKey - The key used to cache the content
uri - The uri to cache, every valid protocol can be used (except the Cocoon protocol!)
cacheRole - The role of the cache component to store the content
params - Additional parameters such as a timout value
Throws:
SourceException


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.