Modifier and Type	Class and Description
private class	SmartServiceInfoRefs.Chain

Modifier and Type	Field and Description
private final Filter[]	filters
private final String	svc

Access	Constructor and Description
pack-priv	SmartServiceInfoRefs(String service, List<Filter> filters)

Method Summary

Modifier and Type	Method and Description
protected abstract void	advertise(HttpServletRequest request req, RefAdvertiser.PacketLineOutRefAdvertiser used to frame lines in PacketLineOut format pck) Advertise.
protected abstract void	begin(HttpServletRequest request req, Repository repository db) Begin service.
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.
public void	init(FilterConfig a `FilterConfig` object containing the filter's configuration and initialization parameters config) Overrides default jakarta.servlet.Filter.init. Called by the web container to indicate to a filter that it is being placed into service.
protected void	respond(HttpServletRequest request req, PacketLineOut destination of response pckOut, String service name to be written out in protocol v0; may or may not be used in other versions serviceName) Writes the appropriate response to an info/refs request received by a smart service.
private void	service(ServletRequest request, ServletResponse response)

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

Field Detail

filters	back to summary
private final Filter[] filters

svc	back to summary
private final String svc

Constructor Detail

SmartServiceInfoRefs	back to summary
pack-priv SmartServiceInfoRefs(String service, List<Filter> filters)

Method Detail

advertise	back to summary
protected abstract void advertise(HttpServletRequest req, RefAdvertiser.PacketLineOutRefAdvertiser pck) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException Advertise. Parameters req:HttpServletRequest request pck:RefAdvertiser.PacketLineOutRefAdvertiser used to frame lines in PacketLineOut format Exceptions IOException: if an IO error occurred ServiceNotEnabledException: if a service is not available ServiceNotAuthorizedException: if service requires authentication and the current user didn't provide credentials

advertise

back to summary

protected abstract void advertise(HttpServletRequest req, RefAdvertiser.PacketLineOutRefAdvertiser pck) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException

Advertise.

Parameters

req:HttpServletRequest: request
pck:RefAdvertiser.PacketLineOutRefAdvertiser: used to frame lines in PacketLineOut format

Exceptions

IOException:: if an IO error occurred
ServiceNotEnabledException:: if a service is not available
ServiceNotAuthorizedException:: if service requires authentication and the current user didn't provide credentials

begin	back to summary
protected abstract void begin(HttpServletRequest req, Repository db) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException Begin service. Parameters req:HttpServletRequest request db:Repository repository Exceptions IOException: if an IO error occurred ServiceNotEnabledException: if a service is not available ServiceNotAuthorizedException: if service requires authentication and the current user didn't provide credentials

begin

back to summary

protected abstract void begin(HttpServletRequest req, Repository db) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException

Begin service.

Parameters

req:HttpServletRequest: request
db:Repository: repository

Exceptions

IOException:: if an IO error occurred
ServiceNotEnabledException:: if a service is not available
ServiceNotAuthorizedException:: if service requires authentication and the current user didn't provide credentials

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(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: 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 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

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:

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
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

init back to summary

init	back to summary
public void init(FilterConfig config) 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 config: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 config) 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

config: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

respond back to summary

respond	back to summary
protected void respond(HttpServletRequest req, PacketLineOut pckOut, String serviceName) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException Writes the appropriate response to an info/refs request received by a smart service. In protocol v0, this starts with "# service=serviceName" followed by a flush packet, but this is not necessarily the case in other protocol versions. The default implementation writes "# service=serviceName" and a flush packet, then calls `advertise`. Subclasses should override this method if they support protocol versions other than protocol v0. Parameters req:HttpServletRequest request pckOut:PacketLineOut destination of response serviceName:String service name to be written out in protocol v0; may or may not be used in other versions Exceptions IOException: if an IO error occurred ServiceNotEnabledException: if a service is not available ServiceNotAuthorizedException: if service requires authentication and the current user didn't provide credentials

protected void respond(HttpServletRequest req, PacketLineOut pckOut, String serviceName) throws IOException, ServiceNotEnabledException, ServiceNotAuthorizedException

Writes the appropriate response to an info/refs request received by a smart service. In protocol v0, this starts with "# service=serviceName" followed by a flush packet, but this is not necessarily the case in other protocol versions.

The default implementation writes "# service=serviceName" and a flush packet, then calls advertise. Subclasses should override this method if they support protocol versions other than protocol v0.

Parameters

req:HttpServletRequest: request
pckOut:PacketLineOut: destination of response
serviceName:String: service name to be written out in protocol v0; may or may not be used in other versions

Exceptions

IOException:: if an IO error occurred
ServiceNotEnabledException:: if a service is not available
ServiceNotAuthorizedException:: if service requires authentication and the current user didn't provide credentials

service	back to summary
private void service(ServletRequest request, ServletResponse response) throws IOException

org.eclipse.jgit.http.server back to summary

private Class SmartServiceInfoRefs.Chain

Class Inheritance

extends Object
implements FilterChain

java.lang.Object
org.eclipse.jgit.http.server.SmartServiceInfoRefs.Chain

All Implemented Interfaces

jakarta.servlet.FilterChain

Field Summary

Modifier and Type	Field and Description
private int	filterIdx

Constructor Summary

Access	Constructor and Description
private	Chain()

Method Summary

Modifier and Type	Method and Description
public void	doFilter(ServletRequest the request to pass along the chain. req, ServletResponse the response to pass along the chain. rsp) Implements jakarta.servlet.FilterChain.doFilter. Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the resource at the end of the chain to be invoked.

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

Field Detail

filterIdx	back to summary
private int filterIdx

Constructor Detail

Chain	back to summary
private Chain()

Method Detail

doFilter	back to summary
public void doFilter(ServletRequest req, ServletResponse rsp) throws IOException, ServletException Implements jakarta.servlet.FilterChain.doFilter. Doc from jakarta.servlet.FilterChain.doFilter. Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the resource at the end of the chain to be invoked. Parameters req:ServletRequest the request to pass along the chain. rsp:ServletResponse the response to pass along the chain. Annotations @Override Exceptions IOException: if an I/O related error has occurred during the processing ServletException: if an exception has occurred that interferes with the filterChain's normal operation

doFilter

back to summary

public void doFilter(ServletRequest req, ServletResponse rsp) throws IOException, ServletException

Implements jakarta.servlet.FilterChain.doFilter.

Doc from jakarta.servlet.FilterChain.doFilter.

Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the resource at the end of the chain to be invoked.

Parameters

req:ServletRequest: the request to pass along the chain.
rsp:ServletResponse: the response to pass along the chain.

Annotations

@Override

Exceptions

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

pack-priv abstract Class SmartServiceInfoRefs

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SmartServiceInfoRefs.Chain

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail