org.apache.xindice.server
Interface ScriptFilter
- All Superinterfaces:
- Named, ScriptComponent, Versioning
- All Known Implementing Classes:
- BasicAuthentication
- public interface ScriptFilter
- extends ScriptComponent
ScriptFilter implementations are treated as interception modules for
accessing Scripts via a ScriptManager implementation. A
ScriptFilter should perform pre-processing of the provided
Gateway instance and decided whether or not the calling
ScriptManager should continue processing on to either the next
ScriptFilter or the Script itself.
Method Summary |
boolean |
isPackageFiltered(java.lang.String name)
isPackageFiltered returns whether or not this ScriptFilter will attempt
to filter the specified Package name. |
boolean |
run(Script script,
Gateway gateway)
run executes the ScriptFilter, passing to it the Script that will
ultimately be executed as part of the request, and the Gateway object
that will ultimately be passed to the Script. |
Methods inherited from interface org.apache.xindice.util.Named |
getName |
isPackageFiltered
public boolean isPackageFiltered(java.lang.String name)
- isPackageFiltered returns whether or not this ScriptFilter will attempt
to filter the specified Package name. If not, the ScriptManager should
pass over this filter in its processing.
- Parameters:
name
- The package name to check- Returns:
- Whether or not the package is filtered
- See Also:
Versioning
run
public boolean run(Script script,
Gateway gateway)
- run executes the ScriptFilter, passing to it the Script that will
ultimately be executed as part of the request, and the Gateway object
that will ultimately be passed to the Script.
- Parameters:
script
- The requested Scriptgateway
- The Gateway object to process- Returns:
- Whether or not to continue processing
- See Also:
Script
Copyright (c) 1999-2001 The Apache Software Foundation