org.jboss.modcluster.container

Interface Engine

All Known Implementing Classes:

CatalinaEngine

public interface Engine

SPI for an engine, defined as collection of one or more hosts associated with a collection of Connectors. The only Connector of significance is the one used to communicate with a proxy.

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method and Description
Host	findHost(String name) Returns the host identified by the specified host name.
Iterable<Connector>	getConnectors() The connector to which this engine uses to communicate with its proxies.
String	getDefaultHost() Returns the default host of this engine.
Iterable<Host>	getHosts() The hosts associated with this engine.
String	getJvmRoute() The jvm route of this servlet engine.
String	getName() The name of this engine.
Connector	getProxyConnector() The connector to which this engine uses to communicate with its proxies.
Server	getServer() The server to which this engine is associated.
String	getSessionCookieName() Returns the cookie name used for sessions.
String	getSessionParameterName() Returns the url parameter name used for sessions.
void	setJvmRoute(String jvmRoute) Set this jvm route for this servlet engine.

Method Detail

getName

String getName()

The name of this engine.

Returns:

the engine name

getServer

Server getServer()

The server to which this engine is associated.

Returns:

a server.

getHosts

Iterable<Host> getHosts()

The hosts associated with this engine.

Returns:

the engine's hosts.

getProxyConnector

Connector getProxyConnector()

The connector to which this engine uses to communicate with its proxies.

Returns:

the connector used by mod_cluster

getConnectors

Iterable<Connector> getConnectors()

The connector to which this engine uses to communicate with its proxies.

Returns:

the connector used by mod_cluster

getJvmRoute

String getJvmRoute()

The jvm route of this servlet engine. This uniquely identifies this node within the proxy.

Returns:

the servlet engine's jvm route

setJvmRoute

void setJvmRoute(String jvmRoute)

Set this jvm route for this servlet engine. Used to create a reasonable default value, if no explicit route is defined.

Parameters:

jvmRoute - a unique jvm route.

findHost

Host findHost(String name)

Returns the host identified by the specified host name.

Parameters:

name - the host name

Returns:

a servlet engine host

getSessionCookieName

String getSessionCookieName()

Returns the cookie name used for sessions.

Returns:

a cookie name

getSessionParameterName

String getSessionParameterName()

Returns the url parameter name used for sessions.

Returns:

a parameter name

getDefaultHost

String getDefaultHost()

Returns the default host of this engine.

Returns:

the default host