Top Description Fields Constructors Methods
org.apache.tomcat.websocket.server

public Class WsFilter

extends GenericFilter
Class Inheritance
Imports
java.io.IOException, jakarta.servlet.FilterChain, .GenericFilter, .ServletException, .ServletRequest, .ServletResponse, jakarta.servlet.http.HttpServletRequest, .HttpServletResponse
Handles the initial HTTP connection for WebSocket connections.

Field Summary

Modifier and TypeField and Description
private transient WsServerContainer
sc

private static final long
serialVersionUID

Hides jakarta.servlet.GenericFilter.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
WsFilter()

Method Summary

Modifier and TypeMethod and Description
public void
doFilter(ServletRequest
The request to process
request, ServletResponse
The response associated with the request
response, FilterChain
Provides access to the next filter in the chain for this filter to pass the request and response to for further processing
chain)

Implements jakarta.servlet.Filter.doFilter.

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.

public void
init()

Overrides jakarta.servlet.GenericFilter.init.

Convenience method for sub-classes to save them having to call super.init(config).

Inherited from jakarta.servlet.GenericFilter:
getFilterConfiggetFilterNamegetInitParametergetInitParameterNamesgetServletContextinit

Field Detail

scback to summary
private transient WsServerContainer sc
serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.servlet.GenericFilter.serialVersionUID.

Constructor Detail

WsFilterback to summary
public WsFilter()

Method Detail

doFilterback to summary
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException

Implements jakarta.servlet.Filter.doFilter.

Doc from jakarta.servlet.Filter.doFilter.

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Parameters
request:ServletRequest

The request to process

response:ServletResponse

The response associated with the request

chain:FilterChain

Provides access to the next filter in the chain for this filter to pass the request and response to for further processing

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs during this filter's processing of the request
ServletException:
if the processing fails for any other reason
initback to summary
public void init() throws ServletException

Overrides jakarta.servlet.GenericFilter.init.

Doc from jakarta.servlet.GenericFilter.init.

Convenience method for sub-classes to save them having to call super.init(config). This is a NO-OP by default.

Annotations
@Override
Exceptions
ServletException:
If an exception occurs that interrupts the Filter's normal operation