org.apache.cocoon.configuration
Interface PropertyProvider

public interface PropertyProvider

This is an interface for custom components delivering properties to configure Cocoon. This component must be setup as a Spring bean in the root application context using ROLE as the bean identifier. The registered provider is asked once on startup for a set of properties.

Since:

1.0

Version:

$Id: PropertyProvider.java 496688 2007-01-16 13:51:23Z cziegeler $

Field Summary

static String

ROLE The bean must be registered with this name.

Method Summary

Properties

getProperties(Settings settings, String runningMode, String path) Provide the properties.

Field Detail

ROLE

public static final String ROLE

The bean must be registered with this name.

Method Detail

getProperties

public Properties getProperties(Settings settings,
                                String runningMode,
                                String path)

Provide the properties.

Parameters:

settings - The already loaded settings.

runningMode - The current running mode.

path - A path specifying the application context the settings are applied to. A path of null indicates the root application context.

Returns:

The additional properties.