Package org.jboss.modcluster.container

Interface Engine

  • All Known Implementing Classes:
    TomcatEngine
    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 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 which this engine uses to communicate with its proxies.
        Returns:
        the connector used by mod_cluster

      • getConnectors

        Iterable<Connector> getConnectors()
        Iteration of all connectors associated with this engine that can be used to communicate with its proxies.
        Returns:
        iteration of all connectors associated with this engine

      • 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