Package org.jboss.modcluster.container.tomcat

Class TomcatEngine

java.lang.Object
org.jboss.modcluster.container.tomcat.TomcatEngine
All Implemented Interfaces:
Engine
public class TomcatEngine extends Object implements Engine
Engine implementation that wraps a Context.
Author:
Paul Ferraro

  • Field Details

    • registry

      protected final TomcatRegistry registry

    • engine

      protected final org.apache.catalina.Engine engine

    • server

      protected final Server server

  • Constructor Details

    • TomcatEngine

      public TomcatEngine(TomcatRegistry registry, org.apache.catalina.Engine engine)
      Constructs a new CatalinaEngine that wraps the specified catalina engine
      Parameters:
      engine - a catalina engine

  • Method Details

    • getServer

      public Server getServer()
      Description copied from interface: Engine
      The server to which this engine is associated.
      Specified by:
      getServer in interface Engine
      Returns:
      a server

    • getHosts

      public Iterable<Host> getHosts()
      Description copied from interface: Engine
      The hosts associated with this engine.
      Specified by:
      getHosts in interface Engine
      Returns:
      the engine's hosts

    • getDefaultHost

      public String getDefaultHost()
      Description copied from interface: Engine
      Returns the default host of this engine.
      Specified by:
      getDefaultHost in interface Engine
      Returns:
      the default host

    • getJvmRoute

      public String getJvmRoute()
      Description copied from interface: Engine
      The jvm route of this servlet engine. This uniquely identifies this node within the proxy.
      Specified by:
      getJvmRoute in interface Engine
      Returns:
      the servlet engine's jvm route

    • setJvmRoute

      public void setJvmRoute(String jvmRoute)
      Description copied from interface: Engine
      Set this jvm route for this servlet engine. Used to create a reasonable default value, if no explicit route is defined.
      Specified by:
      setJvmRoute in interface Engine
      Parameters:
      jvmRoute - a unique jvm route

    • getName

      public String getName()
      Description copied from interface: Engine
      The name of this engine.
      Specified by:
      getName in interface Engine
      Returns:
      the engine name

    • getConnectors

      public Iterable<Connector> getConnectors()
      Description copied from interface: Engine
      Iteration of all connectors associated with this engine that can be used to communicate with its proxies.
      Specified by:
      getConnectors in interface Engine
      Returns:
      iteration of all connectors associated with this engine

    • getProxyConnector

      public Connector getProxyConnector()
      Description copied from interface: Engine
      The connector which this engine uses to communicate with its proxies.
      Specified by:
      getProxyConnector in interface Engine
      Returns:
      the connector used by mod_cluster

    • findHost

      public Host findHost(String name)
      Description copied from interface: Engine
      Returns the host identified by the specified host name.
      Specified by:
      findHost in interface Engine
      Parameters:
      name - the host name
      Returns:
      a servlet engine host

    • getSessionCookieName

      public String getSessionCookieName()
      Description copied from interface: Engine
      Returns the cookie name used for sessions.
      Specified by:
      getSessionCookieName in interface Engine
      Returns:
      a cookie name

    • getSessionParameterName

      public String getSessionParameterName()
      Description copied from interface: Engine
      Returns the url parameter name used for sessions.
      Specified by:
      getSessionParameterName in interface Engine
      Returns:
      a parameter name

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object