org.apache.xindice.server
Class SimpleScriptComponent

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

All Implemented Interfaces:

Configurable, Disposable, KernelAccess, Named, ScriptComponent, Versioning

Direct Known Subclasses:

BasicAuthentication, DBConduit, SimpleScript

public class SimpleScriptComponent

extends SimpleConfigurable

implements ScriptComponent, KernelAccess, Disposable

SimpleScriptComponent is an extendable implementation of the ScriptComponent interface. By default, SimpleScriptComponent sets the returned name of the component to whatever the package-relative class name is. This can be overridden by subclasses or by setting the Name property when registering the component.

Field Summary

static java.lang.String	NAME
static java.lang.String	PACKAGE

Constructor Summary

SimpleScriptComponent()

Method Summary

void	dispose() dispose disposes of the object instance.
java.lang.String	getName() getName retrieves the contextually important name of the object
java.lang.String	getPackageName() getPackageName returns the package name for this Versioning object.
float	getVersion() getVersion returns the version number for this package.
void	setKernel(Kernel kernel) setKernel provides a Kernel callback interface to the implementing object.

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

getConfig, setConfig

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

PACKAGE

public static final java.lang.String PACKAGE

Constructor Detail

SimpleScriptComponent

public SimpleScriptComponent()

Method Detail

setKernel

public void setKernel(Kernel kernel)

Description copied from interface: KernelAccess

setKernel provides a Kernel callback interface to the implementing object.

Specified by:

setKernel in interface KernelAccess

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

Parameters:

kernel - the Kernel reference

getName

public java.lang.String getName()

Description copied from interface: Named

getName retrieves the contextually important name of the object

Specified by:

getName in interface Named

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

Returns:

The object's name

getVersion

public float getVersion()

Description copied from interface: Versioning

getVersion returns the version number for this package. It is conceivable that a single instance of Xindice may be running two different versions of the same appliction. getVersion allows an added ambiguity check to be performed in these cases.

Specified by:

getVersion in interface Versioning

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

Returns:

The package version

getPackageName

public java.lang.String getPackageName()

Description copied from interface: Versioning

getPackageName returns the package name for this Versioning object.

Specified by:

getPackageName in interface Versioning

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

Returns:

The package name

dispose

public void dispose()

Description copied from interface: Disposable

dispose disposes of the object instance.

Specified by:

dispose in interface Disposable