org.apache.xindice.server
Interface Script

All Superinterfaces:

Named, Versioning

All Known Implementing Classes:

SimpleScript

public interface Script

extends Versioning

Objects that implement the Script interface are used in defining custom-functionality for the Xindice server. The SimpleScript class implements Script to provide common default behavior for a Script.

See Also:

SimpleScript

Field Summary

static int	ACCESS_ADMIN
static int	ACCESS_DESIGN
static int	ACCESS_EXECUTE
static int	ACCESS_NONE
static int	ACCESS_READ
static int	ACCESS_WRITE

Method Summary

int	getAccessMethods() getAccessMethods retrieves the access methods that someone executing this Script will require access to in order to actually run the Script.
void	run(Gateway gateway) run executes the Script, passing a Gateway object to it to serve as a resource provider and server gateway.

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

getPackageName, getVersion

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

getName

Field Detail

ACCESS_NONE

public static final int ACCESS_NONE

ACCESS_READ

public static final int ACCESS_READ

ACCESS_WRITE

public static final int ACCESS_WRITE

ACCESS_EXECUTE

public static final int ACCESS_EXECUTE

ACCESS_DESIGN

public static final int ACCESS_DESIGN

ACCESS_ADMIN

public static final int ACCESS_ADMIN

Method Detail

run

public void run(Gateway gateway)

run executes the Script, passing a Gateway object to it to serve as a resource provider and server gateway.

Parameters:

gateway - The Gateway object to process

getAccessMethods

public int getAccessMethods()

getAccessMethods retrieves the access methods that someone executing this Script will require access to in order to actually run the Script. The returned value will be an ORed (|) result that includes all of the applicable access methods utilized.

Returns:

The access methods