| org.apache.catalina.startup.EmbeddedManagerMBean
All known Subclasses: org.apache.catalina.startup.EmbeddedManager,
| EmbeddedManagerMBean | | public interface EmbeddedManagerMBean (Code) | | Embedded MBean interface.
author:
Remy Maucherat
version:
$Revision: 1.4 $ |
| Method Summary | |
| public void | addConnector(Connector connector)
Add a new Connector to the set of defined Connectors. | | public void | addEngine(Engine engine)
Add a new Engine to the set of defined Engines. | | public Connector | createConnector(InetAddress address, int port, boolean secure)
Create, configure, and return a new TCP/IP socket connector
based on the specified properties. | | 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. | | 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. | | public void | destroy()
Destroy servlet container (if any is running). | | public int | getDebug()
Return the debugging detail level for this component. | | public String | getInfo()
Return descriptive information about this Server implementation and
the corresponding version number, in the format
<description>/<version>. | | public Logger | getLogger()
Return the Logger for this component. | | public String | getName()
Retruns the Catalina component name. | | public Realm | getRealm()
Return the default Realm for our Containers. | | public String | getSocketFactory()
Return the secure socket factory class name. | | public int | getState()
Returns the state. | | public String | getStateString()
Returns a String representation of the state. | | public boolean | isUseNaming()
Return true if naming is enabled. | | public void | removeConnector(Connector connector)
Remove the specified Connector from the set of defined Connectors. | | public void | removeContext(Context context)
Remove the specified Context from the set of defined Contexts for its
associated Host. | | public void | removeEngine(Engine engine)
Remove the specified Engine from the set of defined Engines, along with
all of its related Hosts and Contexts. | | 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. | | public void | setDebug(int debug)
Set the debugging detail level for this component. | | public void | setLogger(Logger logger)
Set the Logger for this component. | | public void | setRealm(Realm realm)
Set the default Realm for our Containers. | | public void | setSocketFactory(String socketFactory)
Set the secure socket factory class name. | | public void | setUseNaming(boolean useNaming)
Enables or disables naming support. | | public void | start()
Prepare for the beginning of active use of the public methods of this
component. | | public void | stop()
Gracefully terminate the active use of the public methods of this
component. |
| OBJECT_NAME | | final public static String OBJECT_NAME(Code) | | Object name.
|
| STARTED | | final public static int STARTED(Code) | | |
| STARTING | | final public static int STARTING(Code) | | |
| STOPPED | | final public static int STOPPED(Code) | | |
| STOPPING | | final public static int STOPPING(Code) | | |
| states | | final public static String[] states(Code) | | Status constants.
|
| addConnector | | public void addConnector(Connector connector)(Code) | | Add a new Connector to the set of defined Connectors. The newly
added Connector will be associated with the most recently added Engine.
Parameters:
connector - The connector to be added
exception:
IllegalStateException - if no engines have been added yet |
| addEngine | | public void addEngine(Engine engine)(Code) | | Add a new Engine to the set of defined Engines.
Parameters:
engine - The engine to be added |
| createConnector | | public Connector createConnector(InetAddress address, int port, boolean secure)(Code) | | Create, configure, and return a new TCP/IP socket connector
based on the specified properties.
Parameters:
address - InetAddress to listen to, or nullto listen on all address on this server
Parameters:
port - Port number to listen to
Parameters:
secure - Should this port be SSL-enabled? |
| createContext | | public Context createContext(String path, String docBase)(Code) | | 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 defaultapplication for this host, must start with a slash otherwise)
Parameters:
docBase - Absolute pathname to the document base directoryfor this web application
exception:
IllegalArgumentException - if an invalid parameteris specified |
| createEngine | | public Engine createEngine()(Code) | | 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)(Code) | | 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
Parameters:
appBase - Absolute pathname to the application base directoryfor this virtual host
exception:
IllegalArgumentException - if an invalid parameteris specified |
| destroy | | public void destroy()(Code) | | Destroy servlet container (if any is running).
|
| getDebug | | public int getDebug()(Code) | | Return the debugging detail level for this component.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Server implementation and
the corresponding version number, in the format
<description>/<version>.
|
| getLogger | | public Logger getLogger()(Code) | | Return the Logger for this component.
|
| getName | | public String getName()(Code) | | Retruns the Catalina component name.
|
| getRealm | | public Realm getRealm()(Code) | | Return the default Realm for our Containers.
|
| getSocketFactory | | public String getSocketFactory()(Code) | | Return the secure socket factory class name.
|
| getState | | public int getState()(Code) | | Returns the state.
|
| getStateString | | public String getStateString()(Code) | | Returns a String representation of the state.
|
| isUseNaming | | public boolean isUseNaming()(Code) | | Return true if naming is enabled.
|
| removeConnector | | public void removeConnector(Connector connector)(Code) | | Remove the specified Connector from the set of defined Connectors.
Parameters:
connector - The Connector to be removed |
| removeContext | | public void removeContext(Context context)(Code) | | 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)(Code) | | 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)(Code) | | 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 |
| setDebug | | public void setDebug(int debug)(Code) | | Set the debugging detail level for this component.
Parameters:
debug - The new debugging detail level |
| setLogger | | public void setLogger(Logger logger)(Code) | | Set the Logger for this component.
Parameters:
logger - The new logger |
| setRealm | | public void setRealm(Realm realm)(Code) | | Set the default Realm for our Containers.
Parameters:
realm - The new default realm |
| setSocketFactory | | public void setSocketFactory(String socketFactory)(Code) | | Set the secure socket factory class name.
Parameters:
socketFactory - The new secure socket factory class name |
| setUseNaming | | public void setUseNaming(boolean useNaming)(Code) | | Enables or disables naming support.
Parameters:
useNaming - The new use naming value |
| start | | public void start()(Code) | | 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.
exception:
IllegalStateException - if this component has already beenstarted |
| stop | | public void stop()(Code) | | 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.
exception:
IllegalStateException - if this component has not been started |
|
|