Tomcat 10.1.19 · org.apache.catalina.valves.HealthCheckValve

Modifier and Type	Field and Description
protected boolean	checkContainersAvailable Check if all child containers are available.
protected boolean	context Will be set to true if the valve is associated with a context.
private static final String	DOWN
private String	path
private static final String	UP

Access	Constructor and Description
public	HealthCheckValve()

Method Summary

Modifier and Type	Method and Description
public boolean	getCheckContainersAvailable()
public final String	getPath()
public void	invoke(Request The servlet request to be processed request, Response The servlet response to be created response) Implements org.apache.catalina.Valve.invoke. Perform request processing as required by this Valve.
protected boolean	isAvailable(Container container)
public void	setCheckContainersAvailable(boolean checkContainersAvailable)
public final void	setPath(String path)
protected void	startInternal() Overrides org.apache.catalina.valves.ValveBase.startInternal. Start this component and implement the requirements of `org.apache.catalina.util.LifecycleBase#startInternal()`.

Inherited from org.apache.catalina.valves.ValveBase:: backgroundProcess getContainer getDomainInternal getNext getObjectNameKeyProperties initInternal isAsyncSupported setAsyncSupported setContainer setNext stopInternal toString

checkContainersAvailable	back to summary
protected boolean checkContainersAvailable Check if all child containers are available.

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

DOWN	back to summary
private static final String DOWN

path	back to summary
private String path

UP	back to summary
private static final String UP

HealthCheckValve	back to summary
public HealthCheckValve()

Method Detail

getCheckContainersAvailable	back to summary
public boolean getCheckContainersAvailable()

getPath	back to summary
public final String getPath()

invoke back to summary

invoke	back to summary
public void invoke(Request request, Response response) throws IOException, ServletException Implements org.apache.catalina.Valve.invoke. Doc from org.apache.catalina.Valve.invoke. 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:Request The servlet request to be processed response:Response The servlet response to be created Annotations @Override Exceptions 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

public void invoke(Request request, Response response) throws IOException, ServletException

Implements org.apache.catalina.Valve.invoke.

Doc from org.apache.catalina.Valve.invoke.

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:Request: The servlet request to be processed
response:Response: The servlet response to be created

Annotations

@Override

Exceptions

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	back to summary
protected boolean isAvailable(Container container)

setCheckContainersAvailable	back to summary
public void setCheckContainersAvailable(boolean checkContainersAvailable)

setPath	back to summary
public final void setPath(String path)

startInternal back to summary

startInternal	back to summary
protected void startInternal() throws LifecycleException Overrides org.apache.catalina.valves.ValveBase.startInternal. Doc from org.apache.catalina.valves.ValveBase.startInternal. Start this component and implement the requirements of `org.apache.catalina.util.LifecycleBase#startInternal()`. Annotations @Override Exceptions LifecycleException: if this component detects a fatal error that prevents this component from being used

protected void startInternal() throws LifecycleException

Overrides org.apache.catalina.valves.ValveBase.startInternal.

Doc from org.apache.catalina.valves.ValveBase.startInternal.

Start this component and implement the requirements of org.apache.catalina.util.LifecycleBase#startInternal().

Annotations

@Override

Exceptions

LifecycleException:: if this component detects a fatal error that prevents this component from being used

public Class HealthCheckValve

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail