Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.catalina.core.StandardService
org.apache.catalina.startup.Embedded
createEngine()
to create an Engine object, and then
call its property setters as desired.createHost()
to create at least one virtual Host
associated with the newly created Engine, and then call its property
setters as desired. After you customize this Host, add it to the
corresponding Engine with engine.addChild(host)
.createContext()
to create at least one Context
associated with each newly created Host, and then call its property
setters as desired. You SHOULD create a Context with
a pathname equal to a zero-length string, which will be used to process
all requests not mapped to some other Context. After you customize
this Context, add it to the corresponding Host with
host.addChild(context)
.addEngine()
to attach this Engine to the set of
defined Engines for this object.createConnector()
to create at least one TCP/IP
connector, and then call its property setters as desired.addConnector()
to attach this Connector to the set
of defined Connectors for this object. The added Connector will use
the most recently added Engine to process its received requests.start()
to initiate normal operations of all the
attached components.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
Field Summary | |
protected boolean |
|
protected Engine[] |
|
protected static String |
|
protected LifecycleSupport |
|
protected Logger |
|
protected Realm |
|
protected static StringManager |
|
protected String |
|
protected boolean |
|
protected boolean |
|
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 | |
| |
Method Summary | |
void |
|
void | |
void |
|
Connector |
|
Connector |
|
Connector |
|
Connector |
|
Context |
|
Engine |
|
Host |
|
Loader |
|
LifecycleListener[] |
|
String | |
String | |
String |
|
Logger |
|
Realm |
|
String |
|
protected void |
|
protected void |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
void | |
protected void |
|
void |
|
void |
|
void |
|
void |
|
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 |
protected boolean await
Use await.
protected Engine[] engines
The set of Engines that have been deployed in this server. Normally there will only be one.
protected static final String info
Descriptive information about this server implementation.
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.
protected Realm realm
The default realm to be used by all containers associated with this compoennt.
protected String socketFactory
The socket factory that will be used when asecure
Connector is created. If a standard Connector is created, the internal (to the Connector class default socket factory class) will be used instead.
protected boolean started
Has this component been started yet?
protected boolean useNaming
Is naming enabled ?
public Embedded()
Construct a new instance of this class with default properties.
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)
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
public void addEngine(Engine engine)
Add a new Engine to the set of defined Engines.
- Parameters:
engine
- The engine to be added
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
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, ornull
if the connector is supposed to bind to all addresses on this serverport
- Port number to listen tosecure
- true if the generated connector is supposed to be SSL-enabled, and false otherwise
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
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.
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 hostappBase
- Absolute pathname to the application base directory for this virtual host
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
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
public String getCatalinaBase()
public String getCatalinaHome()
public String getInfo()
Return descriptive information about this Server implementation and the corresponding version number, in the format<description>/<version>
.
- Overrides:
- getInfo in interface StandardService
public 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. 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
public boolean isAwait()
public boolean isUseNaming()
Return true if naming is enabled.
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
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
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
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
public void setAwait(boolean b)
public void setCatalinaBase(String s)
public void setCatalinaHome(String s)
public void setLogger(Logger logger)
Set the Logger for this component.
- Parameters:
logger
- The new logger
public void setRealm(Realm realm)
Set the default Realm for our Containers.
- Parameters:
realm
- The new default realm
protected void setSecurityProtection()
Set the security package access/protection.
public void setSocketFactory(String socketFactory)
Set the secure socket factory class name.
- Parameters:
socketFactory
- The new secure socket factory class name
public void setUseNaming(boolean useNaming)
Enables or disables naming support.
- Parameters:
useNaming
- The new use naming value
public void start() throws LifecycleException
Prepare for the beginning of active use of the public methods of this component. This method should be called afterconfigure()
, and before any of the public methods of the component are utilized.
- Overrides:
- start in interface StandardService
- Throws:
LifecycleException
- if this component detects a fatal error that prevents this component from being used
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.
- Overrides:
- stop in interface StandardService
- Throws:
LifecycleException
- if this component detects a fatal error that needs to be reported