org.apache.cocoon.components.source.helpers
Interface SourceRefresher

All Superinterfaces:
Component
All Known Implementing Classes:
DelaySourceRefresher

public interface SourceRefresher
extends Component

A SourceRefresher is a component that invokes the Source.refresh() method on a configured set of Sources.

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

Since:
2.1.1
Version:
$Id: SourceRefresher.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
static String PARAM_CACHE_INTERVAL
          Refresh interval for the Source.
static String ROLE
           
 
Method Summary
 void refresh(String name, String uri, Parameters params)
          Add a uri to the SourceRefresher.
 

Field Detail

ROLE

public static final String ROLE

PARAM_CACHE_INTERVAL

public static final String PARAM_CACHE_INTERVAL
Refresh interval for the Source. Parameter is used by DelaySourceRefresher.

See Also:
Constant Field Values
Method Detail

refresh

public void refresh(String name,
                    String uri,
                    Parameters params)
             throws SourceException
Add a uri to the SourceRefresher.

Parameters:
name - Uniquely identifying name for the source.
uri - The uri to refresh. Every valid protocol can be used.
params - Additional parameters such as an interval between refresh runs.
Throws:
SourceException


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.