Package org.apache.catalina.valves

Class HealthCheckValve

  • All Implemented Interfaces:
    javax.management.MBeanRegistration, Contained, JmxEnabled, Lifecycle, Valve
    public class HealthCheckValve
extends ValveBase
    Simple Valve that responds to cloud orchestrators health checks.

    • Field Detail

      • context

        protected boolean context
        Will be set to true if the valve is associated with a context.

      • checkContainersAvailable

        protected boolean checkContainersAvailable
        Check if all child containers are available.

    • Constructor Detail

      • HealthCheckValve

        public HealthCheckValve()

    • Method Detail

      • getPath

        public final java.lang.String getPath()

      • setPath

        public final void setPath​(java.lang.String path)

      • getCheckContainersAvailable

        public boolean getCheckContainersAvailable()

      • setCheckContainersAvailable

        public void setCheckContainersAvailable​(boolean checkContainersAvailable)

      • invoke

        public void invoke​(Request request,
                   Response response)
            throws java.io.IOException,
                   ServletException
        Description copied from interface: Valve

        Perform request processing as required by this Valve.

        An individual Valve MAY perform the following actions, in the specified order:

        • Examine and/or modify the properties of the specified Request and Response.
        • Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller.
        • Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on.
        • If the corresponding Response was not generated (and control was not returned, call the next Valve in the pipeline (if there is one) by executing getNext().invoke().
        • Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve or Container).

        A Valve MUST NOT do any of the following things:

        • Change request properties that have already been used to direct the flow of processing control for this request (for instance, trying to change the virtual host to which a Request should be sent from a pipeline attached to a Host or Context in the standard implementation).
        • Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline.
        • Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on.
        • Modify the HTTP headers included with the Response after the getNext().invoke() method has returned.
        • Perform any actions on the output stream associated with the specified Response after the getNext().invoke() method has returned.
        Parameters:
        request - The servlet request to be processed
        response - The servlet response to be created
        Throws:
        java.io.IOException - if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet
        ServletException - if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

      • isAvailable

        protected boolean isAvailable​(Container container)