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 1304258 2012-03-23 10:09:27Z 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

static final String ROLE

PARAM_CACHE_INTERVAL

static final String PARAM_CACHE_INTERVAL

Refresh interval for the Source. Parameter is used by DelaySourceRefresher.

See Also:

Constant Field Values

Method Detail

refresh

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