org.apache.xindice.server.services
Class XindiceService

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

All Implemented Interfaces:

Configurable, KernelAccess, Named, Service

public class XindiceService

extends SimpleConfigurable

implements Service, KernelAccess

XindiceService controls the Xindice server instance. TODO: We need to properly handle the control states for services.

Fields inherited from interface org.apache.xindice.server.Service

RESULT_BUSY, RESULT_FAILED, RESULT_INVALID, RESULT_OK, STATE_STARTED, STATE_STOPPED, STATE_SUSPENDED

Constructor Summary

XindiceService()

Method Summary

Database	getDatabase() Returns the Database instance for the currently running server.
java.lang.String	getName() getName retrieves the contextually important name of the object
int	initialize() initialize will initialize the Service based on its current configuration.
int	resume() resume resumes exection of a suspended Service.
void	setConfig(Configuration config) setConfig sets the configuration information for the Configurable object instance.
void	setKernel(Kernel kernel) setKernel provides a Kernel callback interface to the implementing object.
int	start() start will attempt to start the Service.
int	status() status returns the current operational status of this Service.
java.lang.String	statusMessage() statusMessage returns a textual message about the Service's operational state.
int	stop() stop will attempt to stop the Service.
int	suspend() suspend suspends execution of the Service.
int	uninitialize() uninitialize will uninitialize the Service based on its current configuration and will clean up any existing resources for that configuration.

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

Constructor Detail

XindiceService

public XindiceService()

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

initialize

public int initialize()

Description copied from interface: Service

initialize will initialize the Service based on its current configuration. RESULT_INVALID will be returned if the Service's configuration is invalid.

Specified by:

initialize in interface Service

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

Returns:

The initialization status

getDatabase

public Database getDatabase()

Returns the Database instance for the currently running server.

Returns:

the Database instance.

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

status

public int status()

status returns the current operational status of this Service. This value can either be STATE_STOPPED, STATE_STARTED, or STATE_SUSPENDED.

Specified by:

status in interface Service

Returns:

The Service's status

statusMessage

public java.lang.String statusMessage()

statusMessage returns a textual message about the Service's operational state.

Specified by:

statusMessage in interface Service

Returns:

The Service's status as a text message

start

public int start()

start will attempt to start the Service. Depending on whether the Service was happy about being started or not, a value of RESULT_OK should be returned.

Specified by:

start in interface Service

Returns:

The result of the start attempt

stop

public int stop()

stop will attempt to stop the Service. Depending on whether the Service was happy about being stopped or not, a value of RESULT_OK should be returned.

Specified by:

stop in interface Service

Returns:

The result of the stop attempt

suspend

public int suspend()

suspend suspends execution of the Service. It basically puts it into a paused state until it is resumed or started again. Depending on whether the Service was happy about being suspended or not, a value of RESULT_OK should be returned.

Specified by:

suspend in interface Service

Returns:

The result of the suspend attempt

resume

public int resume()

resume resumes exection of a suspended Service. It will also start a stopped Service. Depending on whether the Service was happy about being resumed or not, a value of RESULT_OK should be returned.

Specified by:

resume in interface Service

Returns:

The result of the resume attempt

uninitialize

public int uninitialize()

uninitialize will uninitialize the Service based on its current configuration and will clean up any existing resources for that configuration. RESULT_INVALID will be returned if the Service's configuration is invalid.

Specified by:

uninitialize in interface Service

Returns:

The uninitialization status

getName

public java.lang.String getName()

getName retrieves the contextually important name of the object

Specified by:

getName in interface Named

Returns:

The object's name