Top Description Fields Constructors Methods
org.eclipse.jgit.http.server.glue

public Class MetaFilter

extends Object
implements Filter
Class Inheritance
All Implemented Interfaces
jakarta.servlet.Filter
Known Direct Subclasses
org.eclipse.jgit.http.server.GitFilter
Imports
java.io.IOException, java.text.MessageFormat, java.util.AbstractSet, .ArrayList, .IdentityHashMap, .Iterator, .List, .Set, java.util.regex.Pattern, jakarta.servlet.Filter, .FilterChain, .FilterConfig, .ServletContext, .ServletException, .ServletRequest, .ServletResponse, jakarta.servlet.http.HttpServletRequest, .HttpServletResponse, org.eclipse.jgit.http.server.HttpServerText
Generic container filter to manage routing to different pipelines.

Callers can create and configure a new processing pipeline by using one of the serve(String) or serveRegex(String) methods to allocate a binder for a particular URL pattern.

Registered filters and servlets are initialized lazily, usually during the first request. Once initialized the bindings in this servlet cannot be modified without destroying the servlet and thereby destroying all registered filters and servlets.

Field Summary

Modifier and TypeField and Description
private final List<ServletBinderImpl>
bindings

private volatile UrlPipeline[]
pipelines

pack-priv static final String
REGEX_GROUPS

private ServletContext
servletContext

Constructor Summary

AccessConstructor and Description
public
MetaFilter()

Empty filter with no bindings.

Method Summary

Modifier and TypeMethod and Description
private UrlPipeline[]
createPipelines()

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(ServletRequest
the ServletRequest object contains the client's request
request, ServletResponse
the ServletResponse object contains the filter's response
response, FilterChain
the FilterChain for invoking the next filter or the resource
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.

private UrlPipeline
find(HttpServletRequest req)

private UrlPipeline[]
getPipelines()

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.

private static Set<Object>
newIdentitySet()

private ServletBinder
register(ServletBinderImpl b)

protected ServletBinder

Returns:

binder for the caller, potentially after adding one or more filters into the pipeline.
register(ServletBinder
the newly created binder.
b)

Configure a newly created binder.

public ServletBinder

Returns:

binder for the passed path.
serve(String
pattern to match.
path)

Construct a binding for a specific path.

public ServletBinder

Returns:

binder for the passed expression.
serveRegex(String
the regular expression to pattern match the URL against.
expression)

Construct a binding for a regular expression.

public ServletBinder

Returns:

binder for the passed expression.
serveRegex(Pattern
the regular expression to pattern match the URL against.
pattern)

Construct a binding for a regular expression.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bindingsback to summary
private final List<ServletBinderImpl> bindings
pipelinesback to summary
private volatile UrlPipeline[] pipelines
REGEX_GROUPSback to summary
pack-priv static final String REGEX_GROUPS
servletContextback to summary
private ServletContext servletContext

Constructor Detail

MetaFilterback to summary
public MetaFilter()

Empty filter with no bindings.

Method Detail

createPipelinesback to summary
private UrlPipeline[] createPipelines() throws ServletException
destroyback 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
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
    • 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
  5. 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

chain: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
findback to summary
private UrlPipeline find(HttpServletRequest req) throws ServletException
getPipelinesback to summary
private UrlPipeline[] getPipelines() throws ServletException
initback 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

  1. Throws a ServletException
  2. 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
newIdentitySetback to summary
private static Set<Object> newIdentitySet()
registerback to summary
private ServletBinder register(ServletBinderImpl b)
registerback to summary
protected ServletBinder register(ServletBinder b)

Configure a newly created binder.

Parameters
b:ServletBinder

the newly created binder.

Returns:ServletBinder

binder for the caller, potentially after adding one or more filters into the pipeline.

serveback to summary
public ServletBinder serve(String path)

Construct a binding for a specific path.

Parameters
path:String

pattern to match.

Returns:ServletBinder

binder for the passed path.

serveRegexback to summary
public ServletBinder serveRegex(String expression)

Construct a binding for a regular expression.

Parameters
expression:String

the regular expression to pattern match the URL against.

Returns:ServletBinder

binder for the passed expression.

serveRegexback to summary
public ServletBinder serveRegex(Pattern pattern)

Construct a binding for a regular expression.

Parameters
pattern:Pattern

the regular expression to pattern match the URL against.

Returns:ServletBinder

binder for the passed expression.