Class TopService

java.lang.Object

org.apache.derby.impl.services.monitor.TopService

final class TopService
extends Object

A description of an instance of a module.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	inShutdown
(package private) ProtocolKey	key	The idenity of this service, note that it may not be active yet.
(package private) Vector<ModuleInstance>	moduleInstances
(package private) BaseMonitor	monitor
(package private) Hashtable<ProtocolKey, ModuleInstance>	protocolTable	List of protocols.
(package private) Locale	serviceLocale
(package private) PersistentService	serviceType	The type of service this was created by.
(package private) ModuleInstance	topModule	The top module instance

Constructor Summary

Constructors

Constructor	Description
TopService(BaseMonitor monitor)
TopService(BaseMonitor monitor, ProtocolKey key, PersistentService serviceType, Locale serviceLocale)

Method Summary

Modifier and Type	Method	Description
private boolean	addToProtocol(ProtocolKey key, ModuleInstance module)	Add a running module into the protocol hash table.
(package private) Object	bootModule(boolean create, Object service, ProtocolKey key, Properties properties)	Boot a module, performs three steps.
(package private) Object	findModule(ProtocolKey key, boolean findOnly, Properties properties)	Find an module in the protocol table that supports the required protocol name combination and can handle the properties.
private ModuleInstance	findModuleInstance(Object instance)	Find a ModuleInstance object whose getInstance() method returns the object specified by the instance parameter.
ProtocolKey	getKey()
(package private) Object	getService()
(package private) PersistentService	getServiceType()
(package private) boolean	inService(Object instance)
(package private) boolean	isActiveService()
(package private) boolean	isActiveService(ProtocolKey otherKey)
(package private) boolean	isPotentialService(ProtocolKey otherKey)
(package private) void	setTopModule(Object instance)
(package private) boolean	shutdown()	If the service is already beign shutdown we return false.
private static void	stop(Object instance)

Methods inherited from class Object

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

Field Details

key

ProtocolKey key

The idenity of this service, note that it may not be active yet.

topModule

ModuleInstance topModule

The top module instance

protocolTable

Hashtable<ProtocolKey, ModuleInstance> protocolTable

List of protocols.

moduleInstances

Vector<ModuleInstance> moduleInstances

monitor

BaseMonitor monitor

inShutdown

boolean inShutdown

serviceType

PersistentService serviceType

The type of service this was created by. If null then this is a non-persistent service.

serviceLocale

Locale serviceLocale

Constructor Details

TopService

TopService(BaseMonitor monitor)

TopService

TopService(BaseMonitor monitor,
 ProtocolKey key,
 PersistentService serviceType,
 Locale serviceLocale)

Method Details

setTopModule

void setTopModule(Object instance)

getService

Object getService()

isPotentialService

boolean isPotentialService(ProtocolKey otherKey)

isActiveService

boolean isActiveService()

isActiveService

boolean isActiveService(ProtocolKey otherKey)

findModule

Object findModule(ProtocolKey key,
 boolean findOnly,
 Properties properties)

Find an module in the protocol table that supports the required protocol name combination and can handle the properties. Returns the instance of the module or null if one does not exist in the protocol table.

findModuleInstance

private ModuleInstance findModuleInstance(Object instance)

Find a ModuleInstance object whose getInstance() method returns the object specified by the instance parameter.

Parameters:

instance - the instance to look for

Returns:

a ModuleInstance object, or null if no match was found

bootModule

Object bootModule(boolean create,
 Object service,
 ProtocolKey key,
 Properties properties)
           throws StandardException

Boot a module, performs three steps.

1. Look for an existing module in the protocol table
2. Look for a module in the implementation table that handles this protocol
3. Create an instance that handles this protocol.

Throws:

StandardException

shutdown

boolean shutdown()

If the service is already beign shutdown we return false.

addToProtocol

private boolean addToProtocol(ProtocolKey key,
 ModuleInstance module)

Add a running module into the protocol hash table. Return true if the module was added successfully, false if it couldn't be added. In the latter case the module should be shutdown if its reference count is 0.

inService

boolean inService(Object instance)

getKey

public ProtocolKey getKey()

getServiceType

PersistentService getServiceType()

stop

private static void stop(Object instance)