org.apache.catalina.core

Class StandardServer

Implemented Interfaces:
Lifecycle, MBeanRegistration, Server

public final class StandardServer
extends java.lang.Object
implements Lifecycle, Server, MBeanRegistration

Standard implementation of the Server interface, available for use (but not required) when deploying and starting Catalina.

Version:
$Revision: 1.29 $ $Date: 2004/05/28 02:51:39 $

Author:
Craig R. McClanahan

Field Summary

protected String
domain
protected MBeanServer
mserver
protected ObjectName
oname
protected String
suffix
protected PropertyChangeSupport
support
The property change support for this component.
protected String
type

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

StandardServer()
Construct a default instance of this class.

Method Summary

void
addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.
void
addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.
void
addService(Service service)
Add a new Service to the set of defined Services.
void
await()
Wait until a proper shutdown command is received, then return.
LifecycleListener[]
findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle.
Service
findService(String name)
Return the specified Service (if it exists); otherwise return null.
Service[]
findServices()
Return the set of Services defined within this Server.
int
getDebug()
Return the debugging detail level.
String
getDomain()
javax.naming.Context
getGlobalNamingContext()
Return the global naming resources context.
NamingResources
getGlobalNamingResources()
Return the global naming resources.
String
getInfo()
Return descriptive information about this Server implementation and the corresponding version number, in the format <description>/<version>.
ObjectName
getObjectName()
int
getPort()
Return the port number we listen to for shutdown commands.
ObjectName[]
getServiceNames()
String
getShutdown()
Return the shutdown command string we are waiting for.
void
init()
void
initialize()
Invoke a pre-startup initialization.
void
postDeregister()
void
postRegister(Boolean registrationDone)
void
preDeregister()
ObjectName
preRegister(MBeanServer server, ObjectName name)
void
removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.
void
removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.
void
removeService(Service service)
Remove the specified Service from the set associated from this Server.
void
setDebug(int debug)
Set the debugging detail level.
void
setGlobalNamingContext(javax.naming.Context globalNamingContext)
Set the global naming resources context.
void
setGlobalNamingResources(NamingResources globalNamingResources)
Set the global naming resources.
void
setPort(int port)
Set the port number we listen to for shutdown commands.
void
setShutdown(String shutdown)
Set the shutdown command we are waiting for.
void
start()
Prepare for the beginning of active use of the public methods of this component.
void
stop()
Gracefully terminate the active use of the public methods of this component.
void
storeConfig()
Write the configuration information for this entire Server out to the server.xml configuration file.
void
storeContext(Context context)
Write the configuration information for Context out to the specified configuration file.
String
toString()
Return a String representation of this component.

Field Details

domain

protected String domain


mserver

protected MBeanServer mserver


oname

protected ObjectName oname


suffix

protected String suffix


support

protected PropertyChangeSupport support
The property change support for this component.


type

protected String type

Constructor Details

StandardServer

public StandardServer()
Construct a default instance of this class.

Method Details

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component.
Specified by:
addLifecycleListener in interface Lifecycle

Parameters:
listener - The listener to add


addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.

Parameters:
listener - The listener to add


addService

public void addService(Service service)
Add a new Service to the set of defined Services.
Specified by:
addService in interface Server

Parameters:
service - The Service to be added


await

public void await()
Wait until a proper shutdown command is received, then return.
Specified by:
await in interface Server


findLifecycleListeners

public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.
Specified by:
findLifecycleListeners in interface Lifecycle


findService

public Service findService(String name)
Return the specified Service (if it exists); otherwise return null.
Specified by:
findService in interface Server

Parameters:
name - Name of the Service to be returned


findServices

public Service[] findServices()
Return the set of Services defined within this Server.
Specified by:
findServices in interface Server


getDebug

public int getDebug()
Return the debugging detail level.


getDomain

public String getDomain()


getGlobalNamingContext

public javax.naming.Context getGlobalNamingContext()
Return the global naming resources context.


getGlobalNamingResources

public NamingResources getGlobalNamingResources()
Return the global naming resources.
Specified by:
getGlobalNamingResources in interface Server


getInfo

public String getInfo()
Return descriptive information about this Server implementation and the corresponding version number, in the format <description>/<version>.
Specified by:
getInfo in interface Server


getObjectName

public ObjectName getObjectName()


getPort

public int getPort()
Return the port number we listen to for shutdown commands.
Specified by:
getPort in interface Server


getServiceNames

public ObjectName[] getServiceNames()


getShutdown

public String getShutdown()
Return the shutdown command string we are waiting for.
Specified by:
getShutdown in interface Server


init

public void init()
            throws Exception


initialize

public void initialize()
            throws LifecycleException
Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.
Specified by:
initialize in interface Server


postDeregister

public void postDeregister()


postRegister

public void postRegister(Boolean registrationDone)


preDeregister

public void preDeregister()
            throws Exception


preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
            throws Exception


removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component.
Specified by:
removeLifecycleListener in interface Lifecycle

Parameters:
listener - The listener to remove


removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.

Parameters:
listener - The listener to remove


removeService

public void removeService(Service service)
Remove the specified Service from the set associated from this Server.
Specified by:
removeService in interface Server

Parameters:
service - The Service to be removed


setDebug

public void setDebug(int debug)
Set the debugging detail level.

Parameters:
debug - The new debugging detail level


setGlobalNamingContext

public void setGlobalNamingContext(javax.naming.Context globalNamingContext)
Set the global naming resources context.

Parameters:
globalNamingContext - The new global naming resource context


setGlobalNamingResources

public void setGlobalNamingResources(NamingResources globalNamingResources)
Set the global naming resources.
Specified by:
setGlobalNamingResources in interface Server

Parameters:
globalNamingResources - The new global naming resources


setPort

public void setPort(int port)
Set the port number we listen to for shutdown commands.
Specified by:
setPort in interface Server

Parameters:
port - The new port number


setShutdown

public void setShutdown(String shutdown)
Set the shutdown command we are waiting for.
Specified by:
setShutdown in interface Server

Parameters:
shutdown - The new shutdown command


start

public void start()
            throws LifecycleException
Prepare for the beginning of active use of the public methods of this component. This method should be called before any of the public methods of this component are utilized. It should also send a LifecycleEvent of type START_EVENT to any registered listeners.
Specified by:
start in interface Lifecycle

Throws:
LifecycleException - if this component detects a fatal error that prevents this component from being used


stop

public void stop()
            throws LifecycleException
Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component. It should also send a LifecycleEvent of type STOP_EVENT to any registered listeners.
Specified by:
stop in interface Lifecycle

Throws:
LifecycleException - if this component detects a fatal error that needs to be reported


storeConfig

public void storeConfig()
            throws Exception
Write the configuration information for this entire Server out to the server.xml configuration file.


storeContext

public void storeContext(Context context)
            throws Exception
Write the configuration information for Context out to the specified configuration file.


toString

public String toString()
Return a String representation of this component.


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.