org.apache.xindice.server
Class Kernel

java.lang.Object
  |
  +--org.apache.xindice.server.Kernel

All Implemented Interfaces:

java.lang.Runnable

public final class Kernel

extends java.lang.Object

implements java.lang.Runnable

The Kernel class is the glue that holds the Xindice information system together. It is the central processing unit of the entire Xindice system. Kernel does almost no processing of its own. The kernel's main job is to load in the various API managers and to start the system services.

Inner Class Summary

class

Kernel.TextWriter TextWriter takes a Document, DocumentFragment, or Element and streams it as text to an output source (or a String) -- Stolen from org.apache.xindice.xml

Constructor Summary

Kernel()

Kernel(java.lang.String name)

Kernel(java.lang.String name, boolean exit)

Method Summary

boolean	addComponent(ScriptComponent component)
boolean	addComponent(ScriptComponent component, java.lang.String name)
boolean	addScript(java.lang.String name, Script script)
boolean	addService(Service service)
void	addTask(Task task, long interval)
void	deleteUser(java.lang.String username)
static void	disposeOf(java.lang.Object obj)
Configuration	getCommonConfig()
ScriptComponent	getComponent(java.lang.String name)
FileResource	getFileResource(java.lang.String filename)
ScriptFilter[]	getFilters(Versioning versioning)
java.lang.Object	getResource(java.lang.String name)
java.lang.Object	getResource(Versioning versioning, java.lang.String name)
Script	getScript(java.lang.String name)
Service	getService(java.lang.String name)
FileResource	getTemporaryFileResource()
User	getUser(java.lang.String username)
boolean	isRunning()
java.lang.String[]	listServices()
java.lang.String[]	listUsers()
java.lang.String[]	listUsers(java.lang.String startsWith)
void	lockResource(java.lang.String name)
void	lockResource(Versioning versioning, java.lang.String name)
void	logMessage(int type, java.lang.String message)
void	logMessage(int type, java.lang.String host, java.lang.String message)
void	logMessage(int type, java.lang.String host, java.lang.String user, java.lang.String message)
User	newUser()
boolean	removeComponent(java.lang.String name)
void	removeResource(java.lang.String name)
void	removeResource(Versioning versioning, java.lang.String name)
void	removeScript(java.lang.String name)
boolean	removeService(Service service)
void	removeTask(Task task)
void	run() run is used to keep the kernel alive with no services running and to run interval-scheduled tasks
void	runScript(Script script, Gateway gateway, boolean useFilters)
void	runScript(java.lang.String name, Gateway gateway, boolean useFilters)
void	setKernelOf(java.lang.Object obj)
void	setResource(java.lang.String name, java.lang.Object object)
void	setResource(Versioning versioning, java.lang.String name, java.lang.Object object)
void	setUser(User user)
void	shutDown(int exitCode)
void	shutDown(int exitCode, boolean exit)
boolean	startServices()
void	stopServices()
void	unlockResource(java.lang.String name)
void	unlockResource(Versioning versioning, java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

Kernel

public Kernel()

Kernel

public Kernel(java.lang.String name)

Kernel

public Kernel(java.lang.String name,
              boolean exit)

Method Detail

run

public void run()

run is used to keep the kernel alive with no services running and to run interval-scheduled tasks

Specified by:

run in interface java.lang.Runnable

addTask

public void addTask(Task task,
                    long interval)

removeTask

public void removeTask(Task task)

disposeOf

public static void disposeOf(java.lang.Object obj)

setKernelOf

public void setKernelOf(java.lang.Object obj)

getCommonConfig

public Configuration getCommonConfig()

shutDown

public void shutDown(int exitCode)

shutDown

public void shutDown(int exitCode,
                     boolean exit)

isRunning

public boolean isRunning()

getFileResource

public FileResource getFileResource(java.lang.String filename)

getTemporaryFileResource

public FileResource getTemporaryFileResource()

setResource

public void setResource(Versioning versioning,
                        java.lang.String name,
                        java.lang.Object object)
                 throws ParameterException

setResource

public void setResource(java.lang.String name,
                        java.lang.Object object)
                 throws ParameterException

removeResource

public void removeResource(Versioning versioning,
                           java.lang.String name)

removeResource

public void removeResource(java.lang.String name)

getResource

public java.lang.Object getResource(Versioning versioning,
                                    java.lang.String name)

getResource

public java.lang.Object getResource(java.lang.String name)

lockResource

public void lockResource(Versioning versioning,
                         java.lang.String name)

lockResource

public void lockResource(java.lang.String name)

unlockResource

public void unlockResource(Versioning versioning,
                           java.lang.String name)

unlockResource

public void unlockResource(java.lang.String name)

getScript

public Script getScript(java.lang.String name)

removeScript

public void removeScript(java.lang.String name)

runScript

public void runScript(java.lang.String name,
                      Gateway gateway,
                      boolean useFilters)

runScript

public void runScript(Script script,
                      Gateway gateway,
                      boolean useFilters)

addScript

public boolean addScript(java.lang.String name,
                         Script script)

logMessage

public void logMessage(int type,
                       java.lang.String host,
                       java.lang.String user,
                       java.lang.String message)

logMessage

public void logMessage(int type,
                       java.lang.String host,
                       java.lang.String message)

logMessage

public void logMessage(int type,
                       java.lang.String message)

addComponent

public boolean addComponent(ScriptComponent component,
                            java.lang.String name)

addComponent

public boolean addComponent(ScriptComponent component)

getComponent

public ScriptComponent getComponent(java.lang.String name)

getFilters

public ScriptFilter[] getFilters(Versioning versioning)

removeComponent

public boolean removeComponent(java.lang.String name)

startServices

public boolean startServices()

stopServices

public void stopServices()

addService

public boolean addService(Service service)

removeService

public boolean removeService(Service service)

listServices

public java.lang.String[] listServices()

getService

public Service getService(java.lang.String name)

getUser

public User getUser(java.lang.String username)

newUser

public User newUser()

setUser

public void setUser(User user)

deleteUser

public void deleteUser(java.lang.String username)

listUsers

public java.lang.String[] listUsers(java.lang.String startsWith)

listUsers

public java.lang.String[] listUsers()