org.springframework.extensions.surf.extensibility.impl

Class ApproveAllModulesEvaluator

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.ApproveAllModulesEvaluator

All Implemented Interfaces:

ExtensionModuleEvaluator

public class ApproveAllModulesEvaluator
extends Object
implements ExtensionModuleEvaluator

This ExtensionModuleEvaluator will always approve each module request. It is designed to be the default Spring Surf evaluator and applications should override the Spring bean configuration to provide a new default evaluator and/or additional evaluators that modules can directly specify

Author:

David Draper

Constructor Summary

Constructors

Constructor and Description
ApproveAllModulesEvaluator()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApproveAllModulesEvaluator

public ApproveAllModulesEvaluator()

Method Detail

applyModule

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

Description copied from interface: ExtensionModuleEvaluator

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.

Specified by:

applyModule in interface ExtensionModuleEvaluator

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

public String[] getRequiredProperties()

Description copied from interface: ExtensionModuleEvaluator

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.

Specified by:

getRequiredProperties in interface ExtensionModuleEvaluator

Returns:

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