org.springframework.extensions.surf.extensibility

Interface ExtensionModuleEvaluator

All Known Implementing Classes:

ApproveAllModulesEvaluator, ConfigApprovalEvaluator

public interface ExtensionModuleEvaluator

Implementations of this interface can be used to determine whether or not an extension module should be applied to an existing extensibility model.

Author:

David Draper

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applyModule(RequestContext context, Map<String,String> evaluationProperties) Determines whether or not to apply a module.
String[]	getRequiredProperties() Returns the names of the required evaluation properties that are needed to successfully perform an evaluation.

Method Detail

applyModule

boolean applyModule(RequestContext context,
                  Map<String,String> evaluationProperties)

Determines whether or not to apply a module. The module being processed will already have been matched to the path being processed but an evaluator can still be used to only apply the module in certain circumstances. These will typically be dictated by whether or not some data in the supplied model matches the criteria defined in the supplied evaluationProperties.

Parameters:

context - The current RequestContext

evaluationProperties - The evaluation properties defined in the module.

Returns:

true if the module should be applied and false otherwise.

getRequiredProperties

String[] getRequiredProperties()

Returns the names of the required evaluation properties that are needed to successfully perform an evaluation. This information is used when provided a user-interface that allows a ExtensionModuleEvaluator to be dynamically configured for a module.

Returns:

A String array containing the names of the properties that are required by the evaluator.