org.apache.xindice.server.standard
Class StdResourceManager

java.lang.Object
  |
  +--org.apache.xindice.server.standard.StdResourceManager

All Implemented Interfaces:

Configurable, Disposable, KernelAccess, ResourceManager, Task

public final class StdResourceManager

extends java.lang.Object

implements Configurable, ResourceManager, KernelAccess, Disposable, Task

StdResourceManager

Constructor Summary

StdResourceManager()

Method Summary

void	dispose() dispose disposes of the object instance.
Configuration	getConfig() getConfig retrieves the configuration information for the Configurable object instance.
java.lang.Object	getResource(java.lang.String name) getResource retrieves a resource by name from the ResourceManager.
java.lang.Object	getResource(Versioning versioning, java.lang.String name) getResource retrieves a resource by name from the ResourceManager.
void	lockResource(java.lang.String name) lockResource locks a resource by name in the ResourceManager.
void	lockResource(Versioning versioning, java.lang.String name) lockResource locks a resource by name in the ResourceManager.
void	removeResource(java.lang.String name) removeResource removes a resource by name from the ResourceManager.
void	removeResource(Versioning versioning, java.lang.String name) removeResource removes a resource by name from the ResourceManager.
void	runTask() The runTask method implements StdResourceManager's resource vulture
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.
void	setResource(java.lang.String name, java.lang.Object object) setResource places a resource by name into the ResourceManager.
void	setResource(Versioning versioning, java.lang.String name, java.lang.Object object) setResource places a resource by name into the ResourceManager.
void	unlockResource(java.lang.String name) unlockResource unlocks a resource by name in the ResourceManager.
void	unlockResource(Versioning versioning, java.lang.String name) unlockResource unlocks a resource by name in the ResourceManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

StdResourceManager

public StdResourceManager()

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

setConfig

public void setConfig(Configuration config)

Description copied from interface: Configurable

setConfig sets the configuration information for the Configurable object instance.

Specified by:

setConfig in interface Configurable

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

Parameters:

config - The configuration Node

getConfig

public Configuration getConfig()

Description copied from interface: Configurable

getConfig retrieves the configuration information for the Configurable object instance.

Specified by:

getConfig in interface Configurable

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

Returns:

The configuration Node

runTask

public void runTask()

The runTask method implements StdResourceManager's resource vulture

Specified by:

runTask in interface Task

setResource

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

Description copied from interface: ResourceManager

setResource places a resource by name into the ResourceManager. The resource will be placed into the name space for the provided Versioning object.

Specified by:

setResource in interface ResourceManager

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

Parameters:

versioning - the version space to use

name - the resource name

object - the object resource

Throws:

ParameterException - if the object cannot be stored

setResource

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

Description copied from interface: ResourceManager

setResource places a resource by name into the ResourceManager. The resource will be placed into the default name space.

Specified by:

setResource in interface ResourceManager

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

Parameters:

name - the resource name

object - the object resource

Throws:

ParameterException - if the object cannot be stored

removeResource

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

Description copied from interface: ResourceManager

removeResource removes a resource by name from the ResourceManager. The resource will be removed from the name space for the provided Versioning object.

Specified by:

removeResource in interface ResourceManager

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

Parameters:

versioning - the version space to use

name - the resource name

removeResource

public void removeResource(java.lang.String name)

Description copied from interface: ResourceManager

removeResource removes a resource by name from the ResourceManager. The resource will be removed from the default name space.

Specified by:

removeResource in interface ResourceManager

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

Parameters:

name - the resource name

getResource

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

Description copied from interface: ResourceManager

getResource retrieves a resource by name from the ResourceManager. The resource will be retrived from the name space for the provided Versioning object.

Specified by:

getResource in interface ResourceManager

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

Parameters:

versioning - the version space to use

name - the resource name

Returns:

the object resource

getResource

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

Description copied from interface: ResourceManager

getResource retrieves a resource by name from the ResourceManager. The resource will be retrived from the default name space.

Specified by:

getResource in interface ResourceManager

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

Parameters:

name - the resource name

Returns:

the object resource

lockResource

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

Description copied from interface: ResourceManager

lockResource locks a resource by name in the ResourceManager. Locking protects the resource from being overwritten or vulturized by the ResourceManager's dead object collector. The resource will be locked in the name space for the provided Versioning object.

Specified by:

lockResource in interface ResourceManager

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

Parameters:

versioning - the version space to use

name - the resource name

lockResource

public void lockResource(java.lang.String name)

Description copied from interface: ResourceManager

lockResource locks a resource by name in the ResourceManager. Locking protects the resource from being overwritten or vulturized by the ResourceManager's dead object collector. The resource will be locked in the default name space.

Specified by:

lockResource in interface ResourceManager

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

Parameters:

name - the resource name

unlockResource

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

Description copied from interface: ResourceManager

unlockResource unlocks a resource by name in the ResourceManager. The resource will be locked in the name space for the provided Versioning object.

Specified by:

unlockResource in interface ResourceManager

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

Parameters:

versioning - the version space to use

name - the resource name

unlockResource

public void unlockResource(java.lang.String name)

Description copied from interface: ResourceManager

unlockResource unlocks a resource by name in the ResourceManager. The resource will be locked in the default name space.

Specified by:

unlockResource in interface ResourceManager

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

Parameters:

name - the resource name

dispose

public void dispose()

Description copied from interface: Disposable

dispose disposes of the object instance.

Specified by:

dispose in interface Disposable