org.apache.xindice.server.components
Class BasicAuthentication

java.lang.Object
  |
  +--org.apache.xindice.util.SimpleConfigurable
        |
        +--org.apache.xindice.server.SimpleScriptComponent
              |
              +--org.apache.xindice.server.components.BasicAuthentication

All Implemented Interfaces:

Configurable, Disposable, KernelAccess, Named, ScriptComponent, ScriptFilter, Versioning

public class BasicAuthentication

extends SimpleScriptComponent

implements ScriptFilter

BasicAuthentication is an implementation of ScriptFilter that implements HTTP BASIC authentication.

Fields inherited from class org.apache.xindice.server.SimpleScriptComponent

NAME, PACKAGE

Constructor Summary

BasicAuthentication()

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.
void	setConfig(Configuration config) setConfig sets the configuration information for the Configurable object instance.

Methods inherited from class org.apache.xindice.server.SimpleScriptComponent

dispose, getName, getPackageName, getVersion, setKernel

Methods inherited from class org.apache.xindice.util.SimpleConfigurable

getConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.xindice.server.Versioning

getPackageName, getVersion

Methods inherited from interface org.apache.xindice.util.Named

getName

Constructor Detail

BasicAuthentication

public BasicAuthentication()

Method Detail

setConfig

public void setConfig(Configuration config)
               throws XindiceException

Description copied from interface: Configurable

setConfig sets the configuration information for the Configurable object instance.

Overrides:

setConfig in class SimpleConfigurable

Following copied from interface: org.apache.xindice.util.Configurable

Parameters:

config - The configuration Node

isPackageFiltered

public boolean isPackageFiltered(java.lang.String name)

Description copied from interface: ScriptFilter

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.

Specified by:

isPackageFiltered in interface ScriptFilter

Following copied from interface: org.apache.xindice.server.ScriptFilter

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)

Description copied from interface: ScriptFilter

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.

Specified by:

run in interface ScriptFilter

Following copied from interface: org.apache.xindice.server.ScriptFilter

Parameters:

script - The requested Script

gateway - The Gateway object to process

Returns:

Whether or not to continue processing

See Also:

Script