org.ops4j.pax.web.service

Interface WebContainer

All Superinterfaces:

org.osgi.service.http.HttpService

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

WebContainer allows bundles to dynamically: register and unregister event listeners, for better control over the life cycle of ServletContext, HttpSession and ServletRequest; register and unregister filters into the URI namespace of Http Service

Since:

0.5.2

Author:

Alin Dreghiciu

Method Summary

Modifier and Type	Method and Description
void	begin(org.osgi.service.http.HttpContext httpContext) Start modifying the http context.
org.osgi.service.http.runtime.dto.RequestInfoDTO	calculateRequestInfoDTO(String path, Iterator<WhiteboardElement> iterator)
org.osgi.service.http.HttpContext	createDefaultHttpContext(String contextID) Creates a default HttpContext as defined for HttpService.createDefaultHttpContext()
SharedWebContainerContext	createDefaultSharedHttpContext() Creates a default implementation of a SharedWebContainerContext
org.osgi.service.http.runtime.dto.RuntimeDTO	createWhiteboardRuntimeDTO(Iterator<WhiteboardElement> iterator)
void	end(org.osgi.service.http.HttpContext httpContext) Validate changes on the given http context
SharedWebContainerContext	getDefaultSharedHttpContext()
WebContainerDTO	getWebcontainerDTO()
void	registerConstraintMapping(String constraintName, String mapping, String url, String dataConstraint, boolean authentication, List<String> roles, org.osgi.service.http.HttpContext httpContext) Registers constraint mappings....
void	registerErrorPage(String error, String location, org.osgi.service.http.HttpContext httpContext) Registers an error page to customize the response sent back to the web client in case that an exception or error propagates back to the web container, or the servlet/filter calls sendError() on the response object for a specific status code.
void	registerEventListener(EventListener listener, org.osgi.service.http.HttpContext httpContext) Registers an event listener.
void	registerFilter(Class<? extends javax.servlet.Filter> filterClass, String[] urlPatterns, String[] servletNames, Dictionary<String,String> initParams, boolean asyncSupported, org.osgi.service.http.HttpContext httpContext) Registers a servlet filter.
void	registerFilter(Class<? extends javax.servlet.Filter> filterClass, String[] urlPatterns, String[] servletNames, Dictionary<String,String> initParams, org.osgi.service.http.HttpContext httpContext) Registers a servlet filter.
void	registerFilter(javax.servlet.Filter filter, String[] urlPatterns, String[] servletNames, Dictionary<String,?> initparams, org.osgi.service.http.HttpContext httpContext) Registers a servlet filter.
void	registerFilter(javax.servlet.Filter filter, String[] urlPatterns, String[] servletNames, Dictionary<String,String> initParams, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext)
void	registerJettyWebXml(URL jettyWebXmlURL, org.osgi.service.http.HttpContext httpContext)
void	registerJspConfigPropertyGroup(List<String> includeCodes, List<String> includePreludes, List<String> urlPatterns, Boolean elIgnored, Boolean scriptingInvalid, Boolean isXml, org.osgi.service.http.HttpContext httpContext)
void	registerJspConfigTagLibs(String tagLibLocation, String tagLibUri, org.osgi.service.http.HttpContext httpContext)
void	registerJsps(String[] urlPatterns, Dictionary<String,?> initParams, org.osgi.service.http.HttpContext httpContext) Enable jsp support.
void	registerJsps(String[] urlPatterns, org.osgi.service.http.HttpContext httpContext) Enable jsp support.
void	registerJspServlet(String[] urlPatterns, Dictionary<String,?> dictionary, org.osgi.service.http.HttpContext httpContext, String jspF)
void	registerJspServlet(String[] urlPatterns, org.osgi.service.http.HttpContext httpContext, String jspF)
void	registerLoginConfig(String authMethod, String realmName, String formLoginPage, String formErrorPage, org.osgi.service.http.HttpContext httpContext) Registers login configuration, with authorization method and realm name.
void	registerServlet(Class<? extends javax.servlet.Servlet> servletClass, String[] urlPatterns, Dictionary<String,?> initParams, org.osgi.service.http.HttpContext httpContext) Register a Servlet by a given Classname instead of an instance ...
void	registerServlet(Class<? extends javax.servlet.Servlet> servletClass, String[] urlPatterns, Dictionary<String,?> initParams, Integer loadOnStartup, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext) Register a Servlet by a given Classname instead of an instance ...
void	registerServlet(Class<? extends javax.servlet.Servlet> servletClass, String[] urlPatterns, Dictionary<String,?> initParams, Integer loadOnStartup, Boolean asyncSupported, javax.servlet.MultipartConfigElement multiPartConfig, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(javax.servlet.Servlet servlet, String[] urlPatterns, Dictionary<String,?> initParams, org.osgi.service.http.HttpContext httpContext) Registers a servlet.
void	registerServlet(javax.servlet.Servlet servlet, String[] urlPatterns, Dictionary<String,?> initParams, Integer loadOnStartup, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext) Registers a servlet with enhanced support.
void	registerServlet(javax.servlet.Servlet servlet, String servletName, String[] urlPatterns, Dictionary<String,?> initParams, org.osgi.service.http.HttpContext httpContext) Registers a named servlet.
void	registerServlet(javax.servlet.Servlet servlet, String servletName, String[] urlPatterns, Dictionary<String,?> initParams, Integer loadOnStartup, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext) Registers a named servlet.
void	registerServlet(javax.servlet.Servlet servlet, String servletName, String[] urlPatterns, Dictionary<String,?> initParams, Integer loadOnStartup, Boolean asyncSupported, javax.servlet.MultipartConfigElement multiPartConfig, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(String alias, javax.servlet.Servlet servlet, Dictionary initParams, Integer loadOnStartup, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext) Registers a servlet into the URI namespace.
void	registerServletContainerInitializer(javax.servlet.ServletContainerInitializer servletContainerInitializer, Class<?>[] classes, org.osgi.service.http.HttpContext httpContext) Register ServletContainerInitializer....
void	registerWebSocket(Object webSocket, org.osgi.service.http.HttpContext httpContext)
void	registerWelcomeFiles(String[] welcomeFiles, boolean redirect, org.osgi.service.http.HttpContext httpContext) Registers an ordered list of partial URIs.
void	setConnectorsAndVirtualHosts(List<String> connectors, List<String> virtualHosts, org.osgi.service.http.HttpContext httpContext)
void	setContextParam(Dictionary<String,?> params, org.osgi.service.http.HttpContext httpContext) Sets context paramaters to be used in the servlet context corresponding to specified http context.
void	setSessionCookieConfig(String domain, String name, Boolean httpOnly, Boolean secure, String path, Integer maxAge, org.osgi.service.http.HttpContext httpContext)
void	setSessionTimeout(Integer minutes, org.osgi.service.http.HttpContext httpContext) Sets the session timeout of the servlet context corresponding to specified http context.
void	unregisterConstraintMapping(org.osgi.service.http.HttpContext httpContext) Unregisters constraint mappings....
void	unregisterErrorPage(String error, org.osgi.service.http.HttpContext httpContext) Unregisters a previous registered error page.
void	unregisterEventListener(EventListener listener) Unregisters a previously registered listener.
void	unregisterFilter(Class<? extends javax.servlet.Filter> filterClass) Unregisters a previously registered servlet filter.
void	unregisterFilter(javax.servlet.Filter filter) Unregisters a previously registered servlet filter.
void	unregisterFilter(String filterName) Unregisters a previously registered servlet filter.
void	unregisterJsps(org.osgi.service.http.HttpContext httpContext) Unregister jsps and disable jsp support.
void	unregisterJsps(String[] urlPatterns, org.osgi.service.http.HttpContext httpContext) Unregister jsps and disable jsp support.
void	unregisterLoginConfig(org.osgi.service.http.HttpContext httpContext) Unregisters login configuration ....
void	unregisterServlet(javax.servlet.Servlet servlet) Unregisters a previously registered servlet.
void	unregisterServlet(String servletName) Unregister a previously registered servlet by it's name.
void	unregisterServletContainerInitializer(org.osgi.service.http.HttpContext httpContext) Unregister method for ServletContainerInitializers
void	unregisterServlets(Class<? extends javax.servlet.Servlet> servletClass) Unregisters all previously registered servlet with the given class.
void	unregisterWebSocket(Object webSocket, org.osgi.service.http.HttpContext httpContext)
void	unregisterWelcomeFiles(String[] welcomeFiles, org.osgi.service.http.HttpContext httpContext) Unregisters previous registered welcome files.

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

createDefaultHttpContext, registerResources, registerServlet, unregister

Method Detail

registerServlet

void registerServlet(String alias,
                     javax.servlet.Servlet servlet,
                     Dictionary initParams,
                     Integer loadOnStartup,
                     Boolean asyncSupported,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException,
                     org.osgi.service.http.NamespaceException

Registers a servlet into the URI namespace.

The alias is the name in the URI namespace of the Http Service at which the registration will be mapped.

An alias must begin with slash ('/') and must not end with slash ('/'), with the exception that an alias of the form "/" is used to denote the root alias. See the specification text for details on how HTTP requests are mapped to servlet and resource registrations.

The Http Service will call the servlet's init method before returning.

 httpService.registerServlet("/myservlet", servlet, initparams, context);
 

Servlets registered with the same HttpContext object will share the same ServletContext. The Http Service will call the context argument to support the ServletContext methods getResource,getResourceAsStream and getMimeType, and to handle security for requests. If the context argument is null, a default HttpContext object is used (see HttpService.createDefaultHttpContext()).

Parameters:

alias - name in the URI namespace at which the servlet is registered

servlet - the servlet object to register

initParams - initialization arguments for the servlet or null if there are none. This argument is used by the servlet's ServletConfig object.

loadOnStartup - ....

asyncSupported - tells weither this Servlet supports async requests (since Servlet API 3.0)

httpContext - the HttpContext object for the registered servlet, or null if a default HttpContext is to be created and used.

Throws:

org.osgi.service.http.NamespaceException - if the registration fails because the alias is already in use.

javax.servlet.ServletException - if the servlet's init method throws an exception, or the given servlet object has already been registered at a different alias.

IllegalArgumentException - if any of the arguments are invalid

registerServlet

void registerServlet(javax.servlet.Servlet servlet,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Registers a servlet.

Parameters:

servlet - a servlet. Cannot be null.

urlPatterns - url patterns this servlet maps to

initParams - initialization arguments for the servlet or null if there are none. This argument is used by the servlet's ServletConfig object.

httpContext - the http context this servlet is for. If null a default http context will be used.

Throws:

IllegalArgumentException - if servlet is null, urlPattern is null or empty, or urlPattern is invalid

javax.servlet.ServletException - if servlet was already registered

registerServlet

void registerServlet(javax.servlet.Servlet servlet,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     Integer loadOnStartup,
                     Boolean asyncSupported,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Registers a servlet with enhanced support.

Parameters:

servlet - a servlet. Cannot be null.

urlPatterns - url patterns this servlet maps to

initParams - initialization arguments for the servlet or null if there are none. This argument is used by the servlet's ServletConfig object.

loadOnStartup - this is used by the Servlet Holder for configuration of how much instances should be loaded on startup.

asyncSupported - this is new with Servlet 3.0 and tells wether this servlet supports this type of requests.

httpContext - the http context this servlet is for. If null a default http context will be used.

Throws:

IllegalArgumentException - if servlet is null, urlPattern is null or empty, or urlPattern is invalid

javax.servlet.ServletException - if servlet was already registered

registerServlet

void registerServlet(javax.servlet.Servlet servlet,
                     String servletName,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Registers a named servlet. A named servlet can then be referenced by name while registering a filter.

Parameters:

servlet - a servlet. Cannot be null.

servletName - servlet name. If null, acts as for the registration method that does not take a servlet name

urlPatterns - url patterns this servlet maps to

initParams - initialization arguments for the servlet or null if there are none. This argument is used by the servlet's ServletConfig object.

httpContext - the http context this servlet is for. If null a default http context will be used.

Throws:

IllegalArgumentException - if servlet is null, urlPattern is null or empty, or urlPattern is invalid

javax.servlet.ServletException - if servlet was already registered

registerServlet

void registerServlet(javax.servlet.Servlet servlet,
                     String servletName,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     Integer loadOnStartup,
                     Boolean asyncSupported,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Registers a named servlet. A named servlet can then be referenced by name while registering a filter.

Parameters:

servlet - a servlet. Cannot be null.

servletName - servlet name. If null, acts as for the registration method that does not take a servlet name

urlPatterns - url patterns this servlet maps to

initParams - initialization arguments for the servlet or null if there are none. This argument is used by the servlet's ServletConfig object.

loadOnStartup - this is used by the Servlet Holder for configuration of how much instances should be loaded on startup.

asyncSupported - this is new with Servlet 3.0 and tells wether this servlet supports this type of requests.

httpContext - the http context this servlet is for. If null a default http context will be used.

Throws:

IllegalArgumentException - if servlet is null, urlPattern is null or empty, or urlPattern is invalid

javax.servlet.ServletException - if servlet was already registered

registerServlet

void registerServlet(Class<? extends javax.servlet.Servlet> servletClass,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Register a Servlet by a given Classname instead of an instance ... See PAXWEB-xxx

Parameters:

servletClass - the class of a Servlet to be registered

urlPatterns - url patterns this servlet maps to

initParams - initialization arguments for the servlet or null if there are none. This argument is used by the servlet's ServletConfig object.

httpContext - the http context this servlet is for. If null a default http context will be used.

Throws:

javax.servlet.ServletException - if servlet was already registered

registerServlet

void registerServlet(Class<? extends javax.servlet.Servlet> servletClass,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     Integer loadOnStartup,
                     Boolean asyncSupported,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Register a Servlet by a given Classname instead of an instance ... See PAXWEB-xxx

Parameters:

servletClass - the class of a Servlet to be registered

urlPatterns - url patterns this servlet maps to

initParams - initialization arguments for the servlet or null if there are none. This argument is used by the servlet's ServletConfig object.

loadOnStartup - this is used by the Servlet Holder for configuration of how much instances should be loaded on startup.

asyncSupported - this is new with Servlet 3.0 and tells wether this servlet supports this type of requests.

httpContext - the http context this servlet is for. If null a default http context will be used.

Throws:

javax.servlet.ServletException - if servlet was already registered

unregisterServlet

void unregisterServlet(javax.servlet.Servlet servlet)

Unregisters a previously registered servlet.

Parameters:

servlet - the servlet to be unregistered

Throws:

IllegalArgumentException - if the servlet is null

unregisterServlet

void unregisterServlet(String servletName)

Unregister a previously registered servlet by it's name.

Parameters:

servletName - the servlet identified by it's name.

Throws:

IllegalArgumentException - if the servlet is null

unregisterServlets

void unregisterServlets(Class<? extends javax.servlet.Servlet> servletClass)

Unregisters all previously registered servlet with the given class.

Parameters:

servletClass - the servlet class to be unregistered

Throws:

IllegalArgumentException - if the servlet class is null

registerEventListener

void registerEventListener(EventListener listener,
                           org.osgi.service.http.HttpContext httpContext)

Registers an event listener. Depending on the listener type, the listener will be notified on different life cycle events. The following listeners are supported: HttpSessionActivationListener, HttpSessionAttributeListener, HttpSessionBindingListener, HttpSessionListener, ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener. Check out Servlet specification for details on what type of event the registered listener will be notified.

Parameters:

listener - an event listener to be registered. If null an IllegalArgumentException is thrown.

httpContext - the http context this listener is for. If null a default http context will be used.

unregisterEventListener

void unregisterEventListener(EventListener listener)

Unregisters a previously registered listener.

Parameters:

listener - the event listener to be unregistered.

Throws:

IllegalArgumentException - if the listener is unknown to the http service (never registered or unregistered before) or the listener is null

registerFilter

void registerFilter(javax.servlet.Filter filter,
                    String[] urlPatterns,
                    String[] servletNames,
                    Dictionary<String,?> initparams,
                    org.osgi.service.http.HttpContext httpContext)

Registers a servlet filter.

Parameters:

filter - a servlet filter. If null an IllegalArgumentException is thrown.

urlPatterns - url patterns this filter maps to

servletNames - servlet names this filter maps to

initparams - initialization arguments for the filter or null if there are none. This argument is used by the filters FilterConfig object.

httpContext - the http context this filter is for. If null a default http context will be used.

registerFilter

void registerFilter(javax.servlet.Filter filter,
                    String[] urlPatterns,
                    String[] servletNames,
                    Dictionary<String,String> initParams,
                    Boolean asyncSupported,
                    org.osgi.service.http.HttpContext httpContext)

registerFilter

void registerFilter(Class<? extends javax.servlet.Filter> filterClass,
                    String[] urlPatterns,
                    String[] servletNames,
                    Dictionary<String,String> initParams,
                    org.osgi.service.http.HttpContext httpContext)

Registers a servlet filter.

Parameters:

filterClass - a servlet filter class. If null an IllegalArgumentException is thrown.

urlPatterns - url patterns this filter maps to

servletNames - servlet names this filter maps to

initParams - initialization arguments for the filter or null if there are none. This argument is used by the filters FilterConfig object.

httpContext - the http context this filter is for. If null a default http context will be used.

registerFilter

void registerFilter(Class<? extends javax.servlet.Filter> filterClass,
                    String[] urlPatterns,
                    String[] servletNames,
                    Dictionary<String,String> initParams,
                    boolean asyncSupported,
                    org.osgi.service.http.HttpContext httpContext)

Registers a servlet filter.

Parameters:

filterClass - a servlet filter class. If null an IllegalArgumentException is thrown.

urlPatterns - url patterns this filter maps to

servletNames - servlet names this filter maps to

initParams - initialization arguments for the filter or null if there are none. This argument is used by the filters FilterConfig object.

asyncSupported - flag if the filter supports async calls.

httpContext - the http context this filter is for. If null a default http context will be used.

unregisterFilter

void unregisterFilter(javax.servlet.Filter filter)

Unregisters a previously registered servlet filter.

Parameters:

filter - the servlet filter to be unregistered

Throws:

IllegalArgumentException - if the filter is unknown to the http service (never registered or unregistered before) or the filter is null

unregisterFilter

void unregisterFilter(Class<? extends javax.servlet.Filter> filterClass)

Unregisters a previously registered servlet filter.

Parameters:

filterClass - the servlet filter to be unregistered, found by the Filter class

Throws:

IllegalArgumentException - if the filter is unknown to the http service (never registered or unregistered before) or the filter is null

unregisterFilter

void unregisterFilter(String filterName)

Unregisters a previously registered servlet filter.

Parameters:

filterName - the servlet filter name to be unregistered

Throws:

IllegalArgumentException - if the filter is unknown to the http service (never registered or unregistered before) or the filter is null

setContextParam

void setContextParam(Dictionary<String,?> params,
                     org.osgi.service.http.HttpContext httpContext)

Sets context paramaters to be used in the servlet context corresponding to specified http context. This method must be used before any register method that uses the specified http context, otherwise an IllegalStateException will be thrown.

Parameters:

params - context parameters for the servlet context corresponding to specified http context

httpContext - http context. Cannot be null.

Throws:

IllegalArgumentException - if http context is null

IllegalStateException - if the call is made after the http context was already used into a registration

setSessionTimeout

void setSessionTimeout(Integer minutes,
                       org.osgi.service.http.HttpContext httpContext)

Sets the session timeout of the servlet context corresponding to specified http context. This method must be used before any register method that uses the specified http context, otherwise an IllegalStateException will be thrown.

Parameters:

minutes - session timeout of the servlet context corresponding to specified http context

httpContext - http context. Cannot be null.

Throws:

IllegalArgumentException - if http context is null

IllegalStateException - if the call is made after the http context was already used into a registration

registerJsps

void registerJsps(String[] urlPatterns,
                  org.osgi.service.http.HttpContext httpContext)

Enable jsp support.

Parameters:

urlPatterns - an array of url patterns this jsp support maps to. If null, a default "*.jsp" will be used

httpContext - the http context for which the jsp support should be enabled. If null a default http context will be used.

Throws:

UnsupportedOperationException - if optional org.ops4j.pax.web.jsp package is not resolved

Since:

0.3.0, January 07, 2007

registerJsps

void registerJsps(String[] urlPatterns,
                  Dictionary<String,?> initParams,
                  org.osgi.service.http.HttpContext httpContext)

Enable jsp support.

Parameters:

urlPatterns - an array of url patterns this jsp support maps to. If null, a default "*.jsp" will be used

initParams - initialization arguments or null if there are none.

httpContext - the http context for which the jsp support should be enabled. If null a default http context will be used.

Throws:

UnsupportedOperationException - if optional org.ops4j.pax.web.jsp package is not resolved

Since:

2.0.0

unregisterJsps

void unregisterJsps(org.osgi.service.http.HttpContext httpContext)

Unregister jsps and disable jsp support.

Parameters:

httpContext - the http context for which the jsp support should be disabled

Throws:

IllegalArgumentException - if http context is null or jsp support was not enabled for the http context

UnsupportedOperationException - if optional org.ops4j.pax.web.jsp package is not resolved

Since:

0.3.0, January 07, 2007

unregisterJsps

void unregisterJsps(String[] urlPatterns,
                    org.osgi.service.http.HttpContext httpContext)

Unregister jsps and disable jsp support.

Parameters:

urlPatterns - an array of url patterns this jsp support maps to. If null, a default "*.jsp" will be used

httpContext - the http context for which the jsp support should be disabled

Throws:

IllegalArgumentException - if http context is null or jsp support was not enabled for the http context

UnsupportedOperationException - if optional org.ops4j.pax.web.jsp package is not resolved

Since:

2.0.0

registerErrorPage

void registerErrorPage(String error,
                       String location,
                       org.osgi.service.http.HttpContext httpContext)

Registers an error page to customize the response sent back to the web client in case that an exception or error propagates back to the web container, or the servlet/filter calls sendError() on the response object for a specific status code.

Parameters:

error - a fully qualified Exception class name or an error status code

location - the request path that will fill the response page. The location must start with an "/"

httpContext - the http context this error page is for. If null a default http context will be used.

Throws:

IllegalArgumentException - if: error is null or empty location is null location does not start with a slash "/"

Since:

0.3.0, January 12, 2007

unregisterErrorPage

void unregisterErrorPage(String error,
                         org.osgi.service.http.HttpContext httpContext)

Unregisters a previous registered error page.

Parameters:

error - a fully qualified Exception class name or an error status code

httpContext - the http context from which the error page should be unregistered. Cannot be null.

Throws:

IllegalArgumentException - if: error is null or empty error page was not registered before httpContext is null

Since:

0.3.0, January 12, 2007

registerWelcomeFiles

void registerWelcomeFiles(String[] welcomeFiles,
                          boolean redirect,
                          org.osgi.service.http.HttpContext httpContext)

Registers an ordered list of partial URIs. The purpose of this mechanism is to allow the deployer to specify an ordered list of partial URIs for the container to use for appending to URIs when there is a request for a URI that corresponds to a directory entry in the WAR not mapped to a Web component

Parameters:

welcomeFiles - an array of welcome files paths. Paths must not start or end with "/"

redirect - true if the client should be redirected to welcome file or false if forwarded

httpContext - the http context this error page is for. If null a default http context will be used.

Throws:

IllegalArgumentException - if: welcome files param is null or empty entries in array are null or empty entries in array start or end with "/"

IllegalStateException - if welcome files are already registered

Since:

0.3.0, January 16, 2007

unregisterWelcomeFiles

void unregisterWelcomeFiles(String[] welcomeFiles,
                            org.osgi.service.http.HttpContext httpContext)

Unregisters previous registered welcome files.

Parameters:

httpContext - the http context from which the welcome files should be unregistered. Cannot be null.

Throws:

IllegalArgumentException - if httpContext is null

Since:

0.3.0, January 16, 2007

registerLoginConfig

void registerLoginConfig(String authMethod,
                         String realmName,
                         String formLoginPage,
                         String formErrorPage,
                         org.osgi.service.http.HttpContext httpContext)

Registers login configuration, with authorization method and realm name.

Parameters:

authMethod -

realmName -

formLoginPage -

formErrorPage -

httpContext -

unregisterLoginConfig

void unregisterLoginConfig(org.osgi.service.http.HttpContext httpContext)

Unregisters login configuration ....

Parameters:

httpContext -

registerConstraintMapping

void registerConstraintMapping(String constraintName,
                               String mapping,
                               String url,
                               String dataConstraint,
                               boolean authentication,
                               List<String> roles,
                               org.osgi.service.http.HttpContext httpContext)

Registers constraint mappings....

Parameters:

constraintName -

mapping -

url -

dataConstraint -

authentication -

roles -

httpContext -

unregisterConstraintMapping

void unregisterConstraintMapping(org.osgi.service.http.HttpContext httpContext)

Unregisters constraint mappings....

Parameters:

httpContext -

registerServletContainerInitializer

void registerServletContainerInitializer(javax.servlet.ServletContainerInitializer servletContainerInitializer,
                                         Class<?>[] classes,
                                         org.osgi.service.http.HttpContext httpContext)

Register ServletContainerInitializer....

Parameters:

servletContainerInitializer -

classes -

httpContext -

getDefaultSharedHttpContext

SharedWebContainerContext getDefaultSharedHttpContext()

Returns:

the default shared http Context

unregisterServletContainerInitializer

void unregisterServletContainerInitializer(org.osgi.service.http.HttpContext httpContext)

Unregister method for ServletContainerInitializers

Parameters:

httpContext - the http Context to unregister from

registerJettyWebXml

void registerJettyWebXml(URL jettyWebXmlURL,
                         org.osgi.service.http.HttpContext httpContext)

setConnectorsAndVirtualHosts

void setConnectorsAndVirtualHosts(List<String> connectors,
                                  List<String> virtualHosts,
                                  org.osgi.service.http.HttpContext httpContext)

registerJspServlet

void registerJspServlet(String[] urlPatterns,
                        org.osgi.service.http.HttpContext httpContext,
                        String jspF)

registerJspServlet

void registerJspServlet(String[] urlPatterns,
                        Dictionary<String,?> dictionary,
                        org.osgi.service.http.HttpContext httpContext,
                        String jspF)

begin

void begin(org.osgi.service.http.HttpContext httpContext)

Start modifying the http context. If this method is called, all changed to the given http context can be bufferered until end() is called.

Parameters:

httpContext -

end

void end(org.osgi.service.http.HttpContext httpContext)

Validate changes on the given http context

Parameters:

httpContext -

createDefaultSharedHttpContext

SharedWebContainerContext createDefaultSharedHttpContext()

Creates a default implementation of a SharedWebContainerContext

Returns:

SharedWebContainerContext

createDefaultHttpContext

org.osgi.service.http.HttpContext createDefaultHttpContext(String contextID)

Creates a default HttpContext as defined for HttpService.createDefaultHttpContext()

Parameters:

contextID - the context.id which is used while registering the HttpContext as service.

Returns:

HttpContext

registerServlet

void registerServlet(javax.servlet.Servlet servlet,
                     String servletName,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     Integer loadOnStartup,
                     Boolean asyncSupported,
                     javax.servlet.MultipartConfigElement multiPartConfig,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

registerServlet

void registerServlet(Class<? extends javax.servlet.Servlet> servletClass,
                     String[] urlPatterns,
                     Dictionary<String,?> initParams,
                     Integer loadOnStartup,
                     Boolean asyncSupported,
                     javax.servlet.MultipartConfigElement multiPartConfig,
                     org.osgi.service.http.HttpContext httpContext)
              throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

registerJspConfigTagLibs

void registerJspConfigTagLibs(String tagLibLocation,
                              String tagLibUri,
                              org.osgi.service.http.HttpContext httpContext)

registerJspConfigPropertyGroup

void registerJspConfigPropertyGroup(List<String> includeCodes,
                                    List<String> includePreludes,
                                    List<String> urlPatterns,
                                    Boolean elIgnored,
                                    Boolean scriptingInvalid,
                                    Boolean isXml,
                                    org.osgi.service.http.HttpContext httpContext)

registerWebSocket

void registerWebSocket(Object webSocket,
                       org.osgi.service.http.HttpContext httpContext)

unregisterWebSocket

void unregisterWebSocket(Object webSocket,
                         org.osgi.service.http.HttpContext httpContext)

calculateRequestInfoDTO

org.osgi.service.http.runtime.dto.RequestInfoDTO calculateRequestInfoDTO(String path,
                                                                         Iterator<WhiteboardElement> iterator)

createWhiteboardRuntimeDTO

org.osgi.service.http.runtime.dto.RuntimeDTO createWhiteboardRuntimeDTO(Iterator<WhiteboardElement> iterator)

getWebcontainerDTO

WebContainerDTO getWebcontainerDTO()

setSessionCookieConfig

void setSessionCookieConfig(String domain,
                            String name,
                            Boolean httpOnly,
                            Boolean secure,
                            String path,
                            Integer maxAge,
                            org.osgi.service.http.HttpContext httpContext)