org.apache.catalina.startup

Class Embedded

Implemented Interfaces:
Lifecycle, MBeanRegistration, Service
Known Direct Subclasses:
Catalina

public class Embedded
extends StandardService
implements Lifecycle

Convenience class to embed a Catalina servlet container environment inside another application. You must call the methods of this class in the following order to ensure correct operation. After normal operations have begun, you can add and remove Connectors, Engines, Hosts, and Contexts on the fly. However, once you have removed a particular component, it must be thrown away -- you can create a new one with the same characteristics if you merely want to do a restart.

To initiate a normal shutdown, call the stop() method of this object.

IMPLEMENTATION NOTE: The main() method of this class is a simple example that exercizes the features of dynamically starting and stopping various components. You can execute this by executing the following steps (on a Unix platform):

   cd $CATALINA_HOME
   ./bin/catalina.sh embedded
 

Version:
$Revision: 1.16 $ $Date: 2004/06/10 18:59:48 $

Author:
Craig R. McClanahan

Field Summary

protected boolean
await
Use await.
protected Engine[]
engines
The set of Engines that have been deployed in this server.
protected static String
info
Descriptive information about this server implementation.
protected LifecycleSupport
lifecycle
The lifecycle event support for this component.
protected Logger
logger
The default logger to be used by this component itself.
protected Realm
realm
The default realm to be used by all containers associated with this compoennt.
protected static StringManager
sm
The string manager for this package.
protected String
socketFactory
The socket factory that will be used when a secure Connector is created.
protected boolean
started
Has this component been started yet?
protected boolean
useNaming
Is naming enabled ?

Fields inherited from class org.apache.catalina.core.StandardService

connectors, container, controller, debug, domain, initialized, mserver, oname, suffix, support, 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

Embedded()
Construct a new instance of this class with default properties.
Embedded(Logger logger, Realm realm)
Construct a new instance of this class with specified properties.

Method Summary

void
addConnector(Connector connector)
Add a new Connector to the set of defined Connectors.
void
addEngine(Engine engine)
Add a new Engine to the set of defined Engines.
void
addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.
Connector
createConnector(InetAddress address, int port, String protocol)
Connector
createConnector(InetAddress address, int port, boolean secure)
Create, configure, and return a new TCP/IP socket connector based on the specified properties.
Connector
createConnector(String address, int port, String protocol)
Connector
createConnector(String address, int port, boolean secure)
Context
createContext(String path, String docBase)
Create, configure, and return a Context that will process all HTTP requests received from one of the associated Connectors, and directed to the specified context path on the virtual host to which this Context is connected.
Engine
createEngine()
Create, configure, and return an Engine that will process all HTTP requests received from one of the associated Connectors, based on the specified properties.
Host
createHost(String name, String appBase)
Create, configure, and return a Host that will process all HTTP requests received from one of the associated Connectors, and directed to the specified virtual host.
Loader
createLoader(ClassLoader parent)
Create and return a class loader manager that can be customized, and then attached to a Context, before it is started.
LifecycleListener[]
findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle.
String
getCatalinaBase()
String
getCatalinaHome()
String
getInfo()
Return descriptive information about this Server implementation and the corresponding version number, in the format <description>/<version>.
Logger
getLogger()
Return the Logger for this component.
Realm
getRealm()
Return the default Realm for our Containers.
String
getSocketFactory()
Return the secure socket factory class name.
protected void
initDirs()
protected void
initNaming()
Initialize naming - this should only enable java:env and root naming.
boolean
isAwait()
boolean
isUseNaming()
Return true if naming is enabled.
void
removeContext(Context context)
Remove the specified Context from the set of defined Contexts for its associated Host.
void
removeEngine(Engine engine)
Remove the specified Engine from the set of defined Engines, along with all of its related Hosts and Contexts.
void
removeHost(Host host)
Remove the specified Host, along with all of its related Contexts, from the set of defined Hosts for its associated Engine.
void
removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.
void
setAwait(boolean b)
void
setCatalinaBase(String s)
void
setCatalinaHome(String s)
void
setLogger(Logger logger)
Set the Logger for this component.
void
setRealm(Realm realm)
Set the default Realm for our Containers.
protected void
setSecurityProtection()
Set the security package access/protection.
void
setSocketFactory(String socketFactory)
Set the secure socket factory class name.
void
setUseNaming(boolean useNaming)
Enables or disables naming support.
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.

Methods inherited from class org.apache.catalina.core.StandardService

addConnector, addLifecycleListener, addPropertyChangeListener, destroy, findConnectors, findLifecycleListeners, getConnectorNames, getContainer, getContainerName, getDebug, getDomain, getInfo, getName, getObjectName, getServer, init, initialize, postDeregister, postRegister, preDeregister, preRegister, removeConnector, removeLifecycleListener, removePropertyChangeListener, setContainer, setDebug, setName, setServer, start, stop, toString

Field Details

await

protected boolean await
Use await.


engines

protected Engine[] engines
The set of Engines that have been deployed in this server. Normally there will only be one.


info

protected static final String info
Descriptive information about this server implementation.


lifecycle

protected LifecycleSupport lifecycle
The lifecycle event support for this component.


logger

protected Logger logger
The default logger to be used by this component itself. Unless this is overridden, log messages will be writted to standard output.


realm

protected Realm realm
The default realm to be used by all containers associated with this compoennt.


sm

protected static StringManager sm
The string manager for this package.


socketFactory

protected String socketFactory
The socket factory that will be used when a secure Connector is created. If a standard Connector is created, the internal (to the Connector class default socket factory class) will be used instead.


started

protected boolean started
Has this component been started yet?


useNaming

protected boolean useNaming
Is naming enabled ?

Constructor Details

Embedded

public Embedded()
Construct a new instance of this class with default properties.


Embedded

public Embedded(Logger logger,
                Realm realm)
Construct a new instance of this class with specified properties.

Parameters:
logger - Logger implementation to be inherited by all components (unless overridden further down the container hierarchy)
realm - Realm implementation to be inherited by all components (unless overridden further down the container hierarchy)

Method Details

addConnector

public void addConnector(Connector connector)
Add a new Connector to the set of defined Connectors. The newly added Connector will be associated with the most recently added Engine.
Specified by:
addConnector in interface Service
Overrides:
addConnector in interface StandardService

Parameters:
connector - The connector to be added


addEngine

public void addEngine(Engine engine)
Add a new Engine to the set of defined Engines.

Parameters:
engine - The engine to be added


addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.
Specified by:
addLifecycleListener in interface Lifecycle
Overrides:
addLifecycleListener in interface StandardService

Parameters:
listener - The listener to add


createConnector

public Connector createConnector(InetAddress address,
                                 int port,
                                 String protocol)


createConnector

public Connector createConnector(InetAddress address,
                                 int port,
                                 boolean secure)
Create, configure, and return a new TCP/IP socket connector based on the specified properties.

Parameters:
address - InetAddress to bind to, or null if the connector is supposed to bind to all addresses on this server
port - Port number to listen to
secure - true if the generated connector is supposed to be SSL-enabled, and false otherwise


createConnector

public Connector createConnector(String address,
                                 int port,
                                 String protocol)


createConnector

public Connector createConnector(String address,
                                 int port,
                                 boolean secure)


createContext

public Context createContext(String path,
                             String docBase)
Create, configure, and return a Context that will process all HTTP requests received from one of the associated Connectors, and directed to the specified context path on the virtual host to which this Context is connected.

After you have customized the properties, listeners, and Valves for this Context, you must attach it to the corresponding Host by calling:

   host.addChild(context);
 
which will also cause the Context to be started if the Host has already been started.

Parameters:
path - Context path of this application ("" for the default application for this host, must start with a slash otherwise)
docBase - Absolute pathname to the document base directory for this web application


createEngine

public Engine createEngine()
Create, configure, and return an Engine that will process all HTTP requests received from one of the associated Connectors, based on the specified properties.


createHost

public Host createHost(String name,
                       String appBase)
Create, configure, and return a Host that will process all HTTP requests received from one of the associated Connectors, and directed to the specified virtual host.

After you have customized the properties, listeners, and Valves for this Host, you must attach it to the corresponding Engine by calling:

   engine.addChild(host);
 
which will also cause the Host to be started if the Engine has already been started. If this is the default (or only) Host you will be defining, you may also tell the Engine to pass all requests not assigned to another virtual host to this one:
   engine.setDefaultHost(host.getName());
 

Parameters:
name - Canonical name of this virtual host
appBase - Absolute pathname to the application base directory for this virtual host


createLoader

public Loader createLoader(ClassLoader parent)
Create and return a class loader manager that can be customized, and then attached to a Context, before it is started.

Parameters:
parent - ClassLoader that will be the parent of the one created by this Loader


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
Overrides:
findLifecycleListeners in interface StandardService


getCatalinaBase

public String getCatalinaBase()


getCatalinaHome

public String getCatalinaHome()


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 Service
Overrides:
getInfo in interface StandardService


getLogger

public Logger getLogger()
Return the Logger for this component.


getRealm

public Realm getRealm()
Return the default Realm for our Containers.


getSocketFactory

public String getSocketFactory()
Return the secure socket factory class name.


initDirs

protected void initDirs()


initNaming

protected void initNaming()
Initialize naming - this should only enable java:env and root naming. If tomcat is embeded in an application that already defines those - it shouldn't do it. XXX The 2 should be separated, you may want to enable java: but not the initial context and the reverse XXX Can we "guess" - i.e. lookup java: and if something is returned assume false ? XXX We have a major problem with the current setting for java: url


isAwait

public boolean isAwait()


isUseNaming

public boolean isUseNaming()
Return true if naming is enabled.


removeContext

public void removeContext(Context context)
Remove the specified Context from the set of defined Contexts for its associated Host. If this is the last Context for this Host, the Host will also be removed.

Parameters:
context - The Context to be removed


removeEngine

public void removeEngine(Engine engine)
Remove the specified Engine from the set of defined Engines, along with all of its related Hosts and Contexts. All associated Connectors are also removed.

Parameters:
engine - The Engine to be removed


removeHost

public void removeHost(Host host)
Remove the specified Host, along with all of its related Contexts, from the set of defined Hosts for its associated Engine. If this is the last Host for this Engine, the Engine will also be removed.

Parameters:
host - The Host to be removed


removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.
Specified by:
removeLifecycleListener in interface Lifecycle
Overrides:
removeLifecycleListener in interface StandardService

Parameters:
listener - The listener to remove


setAwait

public void setAwait(boolean b)


setCatalinaBase

public void setCatalinaBase(String s)


setCatalinaHome

public void setCatalinaHome(String s)


setLogger

public void setLogger(Logger logger)
Set the Logger for this component.

Parameters:
logger - The new logger


setRealm

public void setRealm(Realm realm)
Set the default Realm for our Containers.

Parameters:
realm - The new default realm


setSecurityProtection

protected void setSecurityProtection()
Set the security package access/protection.


setSocketFactory

public void setSocketFactory(String socketFactory)
Set the secure socket factory class name.

Parameters:
socketFactory - The new secure socket factory class name


setUseNaming

public void setUseNaming(boolean useNaming)
Enables or disables naming support.

Parameters:
useNaming - The new use naming value


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 after configure(), and before any of the public methods of the component are utilized.
Specified by:
start in interface Lifecycle
Overrides:
start in interface StandardService

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.
Specified by:
stop in interface Lifecycle
Overrides:
stop in interface StandardService

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


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