Tyrus 2.2.0 · org.glassfish.tyrus.servlet.TyrusServletFilter

Modifier and Type	Field and Description
private TyrusServletUpgrade	tyrusServletUpgrade

Access	Constructor and Description
pack-priv	TyrusServletFilter(TyrusServletUpgrade tyrusServletUpgrade)

Method Summary

Modifier and Type	Method and Description
private static void	appendTraceHeaders(HttpServletResponse httpServletResponse, TyrusUpgradeResponse tyrusUpgradeResponse)
public void	destroy() Overrides default jakarta.servlet.Filter.destroy. Called by the web container to indicate to a filter that it is being taken out of service.
public void	doFilter(final ServletRequest the `ServletRequest` object contains the client's request request, final ServletResponse the `ServletResponse` object contains the filter's response response, FilterChain the `FilterChain` for invoking the next filter or the resource filterChain) 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(FilterConfig a `FilterConfig` object containing the filter's configuration and initialization parameters filterConfig) Overrides default jakarta.servlet.Filter.init. Called by the web container to indicate to a filter that it is being placed into service.
public void	sessionCreated(HttpSessionEvent the HttpSessionEvent containing the session se) Overrides default jakarta.servlet.http.HttpSessionListener.sessionCreated. Receives notification that a session has been created.
public void	sessionDestroyed(HttpSessionEvent the HttpSessionEvent containing the session se) Overrides default jakarta.servlet.http.HttpSessionListener.sessionDestroyed. Receives notification that a session is about to be invalidated.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

tyrusServletUpgrade	back to summary
private TyrusServletUpgrade tyrusServletUpgrade

TyrusServletFilter	back to summary
pack-priv TyrusServletFilter(TyrusServletUpgrade tyrusServletUpgrade)

Method Detail

appendTraceHeaders	back to summary
private static void appendTraceHeaders(HttpServletResponse httpServletResponse, TyrusUpgradeResponse tyrusUpgradeResponse)

destroy	back to summary
public void destroy() Overrides default jakarta.servlet.Filter.destroy. Doc from jakarta.servlet.Filter.destroy. Called by the web container to indicate to a filter that it is being taken out of service. This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter. This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory. Annotations @Override

destroy

back to summary

public void destroy()

Overrides default jakarta.servlet.Filter.destroy.

Doc from jakarta.servlet.Filter.destroy.

Called by the web container to indicate to a filter that it is being taken out of service.

This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter.

This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.

Annotations

@Override

doFilter back to summary

doFilter	back to summary
public void doFilter(final ServletRequest request, final ServletResponse response, FilterChain filterChain) 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: Examine the request Optionally wrap the request object with a custom implementation to filter content or headers for input filtering Optionally wrap the response object with a custom implementation to filter content or headers for output filtering Either invoke the next entity in the chain using the FilterChain object (`chain.doFilter()`), or not pass on the request/response pair to the next entity in the filter chain to block the request processing Directly set headers on the response after invocation of the next entity in the filter chain. Parameters request:ServletRequest the `ServletRequest` object contains the client's request response:ServletResponse the `ServletResponse` object contains the filter's response filterChain:FilterChain the `FilterChain` for invoking the next filter or the resource Annotations @Override Exceptions IOException: if an I/O related error has occurred during the processing ServletException: if an exception occurs that interferes with the filter's normal operation

public void doFilter(final ServletRequest request, final ServletResponse response, FilterChain filterChain) 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:

Examine the request
Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
- Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
- or not pass on the request/response pair to the next entity in the filter chain to block the request processing
Directly set headers on the response after invocation of the next entity in the filter chain.

Parameters

request:ServletRequest: the ServletRequest object contains the client's request
response:ServletResponse: the ServletResponse object contains the filter's response
filterChain:FilterChain: the FilterChain for invoking the next filter or the resource

Annotations

@Override

Exceptions

IOException:: if an I/O related error has occurred during the processing
ServletException:: if an exception occurs that interferes with the filter's normal operation

init back to summary

init	back to summary
public void init(FilterConfig filterConfig) throws ServletException Overrides default jakarta.servlet.Filter.init. Doc from jakarta.servlet.Filter.init. Called by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work. The container will ensure that actions performed in the `init` method will be visible to any threads that subsequently call the `doFilter` method according to the rules in JSR-133 (i.e. there is a 'happens before' relationship between `init` and `doFilter`). The web container cannot place the filter into service if the init method either Throws a ServletException Does not return within a time period defined by the web container Parameters filterConfig:FilterConfig a `FilterConfig` object containing the filter's configuration and initialization parameters Annotations @Override Exceptions ServletException: if an exception has occurred that interferes with the filter's normal operation

public void init(FilterConfig filterConfig) throws ServletException

Overrides default jakarta.servlet.Filter.init.

Doc from jakarta.servlet.Filter.init.

Called by the web container to indicate to a filter that it is being placed into service.

The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work. The container will ensure that actions performed in the init method will be visible to any threads that subsequently call the doFilter method according to the rules in JSR-133 (i.e. there is a 'happens before' relationship between init and doFilter).

The web container cannot place the filter into service if the init method either

Throws a ServletException
Does not return within a time period defined by the web container

Parameters

filterConfig:FilterConfig: a FilterConfig object containing the filter's configuration and initialization parameters

Annotations

@Override

Exceptions

ServletException:: if an exception has occurred that interferes with the filter's normal operation

sessionCreated	back to summary
public void sessionCreated(HttpSessionEvent se) Overrides default jakarta.servlet.http.HttpSessionListener.sessionCreated. Doc from jakarta.servlet.http.HttpSessionListener.sessionCreated. Receives notification that a session has been created. Parameters se:HttpSessionEvent the HttpSessionEvent containing the session Annotations @Override

sessionCreated

back to summary

public void sessionCreated(HttpSessionEvent se)

Overrides default jakarta.servlet.http.HttpSessionListener.sessionCreated.

Doc from jakarta.servlet.http.HttpSessionListener.sessionCreated.

Receives notification that a session has been created.

Parameters

se:HttpSessionEvent: the HttpSessionEvent containing the session

Annotations

@Override

sessionDestroyed	back to summary
public void sessionDestroyed(HttpSessionEvent se) Overrides default jakarta.servlet.http.HttpSessionListener.sessionDestroyed. Doc from jakarta.servlet.http.HttpSessionListener.sessionDestroyed. Receives notification that a session is about to be invalidated. Parameters se:HttpSessionEvent the HttpSessionEvent containing the session Annotations @Override

sessionDestroyed

back to summary

public void sessionDestroyed(HttpSessionEvent se)

Overrides default jakarta.servlet.http.HttpSessionListener.sessionDestroyed.

Doc from jakarta.servlet.http.HttpSessionListener.sessionDestroyed.

Receives notification that a session is about to be invalidated.

Parameters

se:HttpSessionEvent: the HttpSessionEvent containing the session

Annotations

@Override

pack-priv Class TyrusServletFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail