Tomcat 10.1.19 · org.apache.catalina.Valve · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	backgroundProcess() Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container.
public Valve	Returns: the next Valve in the pipeline containing this Valve, or `null` if this is the last Valve in the pipeline. getNext() Returns the next Valve in this pipeline, or `null` if this is the last Valve in the pipeline.
public void	invoke(Request The servlet request to be processed request, Response The servlet response to be created response) Perform request processing as required by this Valve.
public boolean	isAsyncSupported()
public void	setNext(Valve The new next valve, or `null` if none valve) Set the next Valve in the pipeline containing this Valve.

Method Detail

backgroundProcess	back to summary
public void backgroundProcess() Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.

getNext back to summary

getNext	back to summary
public Valve getNext() Returns the next Valve in this pipeline, or `null` if this is the last Valve in the pipeline. Returns:Valve the next Valve in the pipeline containing this Valve, or `null` if this is the last Valve in the pipeline.

public Valve getNext()

Returns the next Valve in this pipeline, or null if this is the last Valve in the pipeline.

Returns:Valve: the next Valve in the pipeline containing this Valve, or null if this is the last Valve in the pipeline.

invoke back to summary

invoke	back to summary
public void invoke(Request request, Response response) throws IOException, ServletException 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 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

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

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

isAsyncSupported	back to summary
public boolean isAsyncSupported()

setNext back to summary

setNext	back to summary
public void setNext(Valve valve) Set the next Valve in the pipeline containing this Valve. Parameters valve:Valve The new next valve, or `null` if none

public void setNext(Valve valve)

Set the next Valve in the pipeline containing this Valve.

Parameters

valve:Valve: The new next valve, or null if none

public Interface Valve

Method Summary

Method Detail