Package org.glassfish.grizzly.osgi.httpservice

Interface HttpServiceExtension

All Superinterfaces:

org.osgi.service.http.HttpService

All Known Implementing Classes:

HttpServiceImpl

public interface HttpServiceExtension
extends org.osgi.service.http.HttpService

An extension to the OSGi HttpService interface allowing the registration/unregistration of Servlet Filter instances.

Since:

2.3.3

Method Summary

Modifier and Type	Method	Description
void	registerFilter(javax.servlet.Filter filter, String urlPattern, Dictionary initParams, org.osgi.service.http.HttpContext context)	Registers a Filter and with the HttpService.
void	unregisterFilter(javax.servlet.Filter filter)	Removes the specified Filter from the service.

Methods inherited from interface org.osgi.service.http.HttpService

createDefaultHttpContext, registerResources, registerServlet, unregister

Method Details

registerFilter

void registerFilter(javax.servlet.Filter filter,
 String urlPattern,
 Dictionary initParams,
 org.osgi.service.http.HttpContext context)
             throws javax.servlet.ServletException

Registers a Filter and with the HttpService. As this is an extension to the standard HttpService and there are no clear rules on how the mapping of filters should occur, this implementation follows the mapping rules as defined by the Servlet specification. Additionally, it should be noted that the registered Filters are effectively associated with a particular HttpContext. Therefore, if you wish to have multiple filters associated with a particular Servlet, then you should use the same HttpContext instance to perform the registration. Filters will be invoked in registration order. This method will invoke Filter.init(javax.servlet.FilterConfig) during the registration process. When registering a Filter, take care not to reuse the same Filter instance across multiple registration invocations. This could cause issues when removing the Filter as it may remove more url matching possibilities than intended.

Parameters:

filter - the Filter to register.

urlPattern - the url pattern that will invoke this Filter.

initParams - the initialization params that will be passed to the filter when Filter.init(javax.servlet.FilterConfig) is invoked.

context - the HttpContext associated with this Filter.

Throws:

javax.servlet.ServletException - if an error occurs during Filter initialization.

unregisterFilter

void unregisterFilter(javax.servlet.Filter filter)

Removes the specified Filter from the service.

Parameters:

filter - the Filter to remove.