Package org.ops4j.pax.web.service.internal

Class HttpServiceEnabled

java.lang.Object

org.ops4j.pax.web.service.internal.HttpServiceEnabled

All Implemented Interfaces:

StoppableHttpService, org.ops4j.pax.web.service.WebContainer, org.osgi.service.http.HttpService

public class HttpServiceEnabled
extends Object
implements org.ops4j.pax.web.service.WebContainer, StoppableHttpService

Enabled HttpService means we can register web components. When bundle (for which the Http Service is scoped) is stopped, all available references to this service will switch to disabled HttpService delegate to prevent further registration.

Constructor Summary

Constructors

Constructor	Description
HttpServiceEnabled(org.osgi.framework.Bundle bundle, org.ops4j.pax.web.service.spi.ServerController srvController, org.ops4j.pax.web.service.spi.model.ServerModel serverModel, org.ops4j.pax.web.service.spi.model.events.WebElementEventListener eventDispatcher, org.ops4j.pax.web.service.spi.config.Configuration configuration)

Method Summary

Modifier and Type	Method	Description
<T extends org.ops4j.pax.web.service.views.PaxWebContainerView> T	adapt(Class<T> type)
org.ops4j.pax.web.service.WebContainerContext	createDefaultHttpContext()
org.ops4j.pax.web.service.WebContainerContext	createDefaultHttpContext(String contextId)
org.ops4j.pax.web.service.MultiBundleWebContainerContext	createDefaultSharedHttpContext()
org.ops4j.pax.web.service.MultiBundleWebContainerContext	createDefaultSharedHttpContext(String contextId)
org.ops4j.pax.web.service.spi.model.ServiceModel	getServiceModel()
void	registerErrorPage(String error, String location, org.osgi.service.http.HttpContext httpContext)
void	registerErrorPages(String[] errors, String location, org.osgi.service.http.HttpContext httpContext)
void	registerEventListener(EventListener listener, org.osgi.service.http.HttpContext httpContext)
void	registerFilter(Class<? extends javax.servlet.Filter> filterClass, String[] urlPatterns, String[] servletNames, Dictionary<String,String> initParams, org.osgi.service.http.HttpContext httpContext)
void	registerFilter(Class<? extends javax.servlet.Filter> filterClass, String filterName, String[] urlPatterns, String[] servletNames, Dictionary<String,String> initParams, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext)
void	registerFilter(javax.servlet.Filter filter, String[] urlPatterns, String[] servletNames, Dictionary<String,String> initParams, org.osgi.service.http.HttpContext httpContext)
void	registerFilter(javax.servlet.Filter filter, String filterName, String[] urlPatterns, String[] servletNames, Dictionary<String,String> initParams, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext)
void	registerJspConfigPropertyGroup(List<String> includeCodas, List<String> includePreludes, List<String> urlPatterns, Boolean elIgnored, Boolean scriptingInvalid, Boolean isXml, org.osgi.service.http.HttpContext httpContext)
void	registerJspConfigPropertyGroup(javax.servlet.descriptor.JspPropertyGroupDescriptor descriptor, org.osgi.service.http.HttpContext httpContext)
void	registerJspConfigTagLibs(String taglibLocation, String tagLibUri, org.osgi.service.http.HttpContext httpContext)
void	registerJspConfigTagLibs(Collection<javax.servlet.descriptor.TaglibDescriptor> tagLibs, org.osgi.service.http.HttpContext httpContext)
void	registerJsps(String[] urlPatterns, Dictionary<String,String> initParams, org.osgi.service.http.HttpContext context)
void	registerJspServlet(String jspFile, String[] urlPatterns, Dictionary<String,String> initParams, org.osgi.service.http.HttpContext context)
void	registerResources(String alias, String name, org.osgi.service.http.HttpContext context)
void	registerServlet(Class<? extends javax.servlet.Servlet> servletClass, String[] urlPatterns, Dictionary<String,String> initParams, Integer loadOnStartup, Boolean asyncSupported, javax.servlet.MultipartConfigElement multiPartConfig, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(Class<? extends javax.servlet.Servlet> servletClass, String[] urlPatterns, Dictionary<String,String> initParams, Integer loadOnStartup, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(Class<? extends javax.servlet.Servlet> servletClass, String[] urlPatterns, Dictionary<String,String> initParams, 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)
void	registerServlet(String alias, javax.servlet.Servlet servlet, Dictionary<?,?> initParams, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(javax.servlet.Servlet servlet, String[] urlPatterns, Dictionary<String,String> initParams, Integer loadOnStartup, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(javax.servlet.Servlet servlet, String[] urlPatterns, Dictionary<String,String> initParams, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(javax.servlet.Servlet servlet, String servletName, String[] urlPatterns, Dictionary<String,String> initParams, Integer loadOnStartup, Boolean asyncSupported, javax.servlet.MultipartConfigElement multiPartConfig, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(javax.servlet.Servlet servlet, String servletName, String[] urlPatterns, Dictionary<String,String> initParams, Integer loadOnStartup, Boolean asyncSupported, org.osgi.service.http.HttpContext httpContext)
void	registerServlet(javax.servlet.Servlet servlet, String servletName, String[] urlPatterns, Dictionary<String,String> initParams, org.osgi.service.http.HttpContext httpContext)
void	registerServletContainerInitializer(javax.servlet.ServletContainerInitializer initializer, Class<?>[] classes, org.osgi.service.http.HttpContext httpContext)
void	registerWebSocket(Object webSocket, org.osgi.service.http.HttpContext httpContext)
void	registerWelcomeFiles(String[] welcomeFiles, boolean redirect, org.osgi.service.http.HttpContext httpContext)
void	setContextParams(Dictionary<String,Object> params, org.osgi.service.http.HttpContext httpContext)
void	setSessionCookieConfig(String domain, String name, Boolean httpOnly, Boolean secure, String path, Integer maxAge, org.osgi.service.http.HttpContext httpContext)
void	setSessionCookieConfig(javax.servlet.SessionCookieConfig config, org.osgi.service.http.HttpContext httpContext)
void	setSessionTimeout(Integer minutes, org.osgi.service.http.HttpContext httpContext)
void	stop()	Stop the HttpService.
String	toString()
void	unregister(String alias)
void	unregisterErrorPage(String error, org.osgi.service.http.HttpContext httpContext)
void	unregisterErrorPages(String[] errors, org.osgi.service.http.HttpContext httpContext)
void	unregisterEventListener(EventListener listener)
void	unregisterFilter(String filterName)
void	unregisterFilter(javax.servlet.Filter filter)
void	unregisterFilters(Class<? extends javax.servlet.Filter> filterClass)
void	unregisterJsps(org.osgi.service.http.HttpContext httpContext)
void	unregisterJspServlet(String jspFile, org.osgi.service.http.HttpContext httpContext)
void	unregisterServlet(String servletName)
void	unregisterServlet(javax.servlet.Servlet servlet)
void	unregisterServletContainerInitializer(javax.servlet.ServletContainerInitializer initializer, org.osgi.service.http.HttpContext httpContext)
void	unregisterServlets(Class<? extends javax.servlet.Servlet> servletClass)
void	unregisterWebSocket(Object webSocket, org.osgi.service.http.HttpContext httpContext)
void	unregisterWelcomeFiles(String[] welcomeFiles, org.osgi.service.http.HttpContext httpContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpServiceEnabled

public HttpServiceEnabled(org.osgi.framework.Bundle bundle,
                          org.ops4j.pax.web.service.spi.ServerController srvController,
                          org.ops4j.pax.web.service.spi.model.ServerModel serverModel,
                          org.ops4j.pax.web.service.spi.model.events.WebElementEventListener eventDispatcher,
                          org.ops4j.pax.web.service.spi.config.Configuration configuration)

Method Detail

getServiceModel

public org.ops4j.pax.web.service.spi.model.ServiceModel getServiceModel()

stop

public void stop()

Description copied from interface: StoppableHttpService

Stop the HttpService. It doesn't directly mean stop the underlying HTTP server, it's more like marking a HttpService as no longer open for registration of web elements.

Specified by:

stop in interface StoppableHttpService

adapt

public <T extends org.ops4j.pax.web.service.views.PaxWebContainerView> T adapt(Class<T> type)

Specified by:

adapt in interface org.ops4j.pax.web.service.WebContainer

createDefaultHttpContext

public org.ops4j.pax.web.service.WebContainerContext createDefaultHttpContext()

Specified by:

createDefaultHttpContext in interface org.osgi.service.http.HttpService

createDefaultHttpContext

public org.ops4j.pax.web.service.WebContainerContext createDefaultHttpContext(String contextId)

Specified by:

createDefaultHttpContext in interface org.ops4j.pax.web.service.WebContainer

createDefaultSharedHttpContext

public org.ops4j.pax.web.service.MultiBundleWebContainerContext createDefaultSharedHttpContext()

Specified by:

createDefaultSharedHttpContext in interface org.ops4j.pax.web.service.WebContainer

createDefaultSharedHttpContext

public org.ops4j.pax.web.service.MultiBundleWebContainerContext createDefaultSharedHttpContext(String contextId)

Specified by:

createDefaultSharedHttpContext in interface org.ops4j.pax.web.service.WebContainer

registerServlet

public void registerServlet(String alias,
                            javax.servlet.Servlet servlet,
                            Dictionary<?,?> initParams,
                            org.osgi.service.http.HttpContext httpContext)
                     throws javax.servlet.ServletException,
                            org.osgi.service.http.NamespaceException

Specified by:

registerServlet in interface org.osgi.service.http.HttpService

Throws:

javax.servlet.ServletException

org.osgi.service.http.NamespaceException

registerServlet

public 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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

org.osgi.service.http.NamespaceException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerServlet

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

Specified by:

registerServlet in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

unregister

public void unregister(String alias)

Specified by:

unregister in interface org.osgi.service.http.HttpService

unregisterServlet

public void unregisterServlet(javax.servlet.Servlet servlet)

Specified by:

unregisterServlet in interface org.ops4j.pax.web.service.WebContainer

unregisterServlet

public void unregisterServlet(String servletName)

Specified by:

unregisterServlet in interface org.ops4j.pax.web.service.WebContainer

unregisterServlets

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

Specified by:

unregisterServlets in interface org.ops4j.pax.web.service.WebContainer

registerResources

public void registerResources(String alias,
                              String name,
                              org.osgi.service.http.HttpContext context)
                       throws org.osgi.service.http.NamespaceException

Specified by:

registerResources in interface org.osgi.service.http.HttpService

Throws:

org.osgi.service.http.NamespaceException

registerFilter

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

Specified by:

registerFilter in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerFilter

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

Specified by:

registerFilter in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerFilter

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

Specified by:

registerFilter in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

registerFilter

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

Specified by:

registerFilter in interface org.ops4j.pax.web.service.WebContainer

Throws:

javax.servlet.ServletException

unregisterFilter

public void unregisterFilter(javax.servlet.Filter filter)

Specified by:

unregisterFilter in interface org.ops4j.pax.web.service.WebContainer

unregisterFilter

public void unregisterFilter(String filterName)

Specified by:

unregisterFilter in interface org.ops4j.pax.web.service.WebContainer

unregisterFilters

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

Specified by:

unregisterFilters in interface org.ops4j.pax.web.service.WebContainer

registerEventListener

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

Specified by:

registerEventListener in interface org.ops4j.pax.web.service.WebContainer

unregisterEventListener

public void unregisterEventListener(EventListener listener)

Specified by:

unregisterEventListener in interface org.ops4j.pax.web.service.WebContainer

registerWelcomeFiles

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

Specified by:

registerWelcomeFiles in interface org.ops4j.pax.web.service.WebContainer

unregisterWelcomeFiles

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

Specified by:

unregisterWelcomeFiles in interface org.ops4j.pax.web.service.WebContainer

registerErrorPage

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

Specified by:

registerErrorPage in interface org.ops4j.pax.web.service.WebContainer

registerErrorPages

public void registerErrorPages(String[] errors,
                               String location,
                               org.osgi.service.http.HttpContext httpContext)

Specified by:

registerErrorPages in interface org.ops4j.pax.web.service.WebContainer

unregisterErrorPage

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

Specified by:

unregisterErrorPage in interface org.ops4j.pax.web.service.WebContainer

unregisterErrorPages

public void unregisterErrorPages(String[] errors,
                                 org.osgi.service.http.HttpContext httpContext)

Specified by:

unregisterErrorPages in interface org.ops4j.pax.web.service.WebContainer

registerJsps

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

Specified by:

registerJsps in interface org.ops4j.pax.web.service.WebContainer

registerJspServlet

public void registerJspServlet(String jspFile,
                               String[] urlPatterns,
                               Dictionary<String,String> initParams,
                               org.osgi.service.http.HttpContext context)

Specified by:

registerJspServlet in interface org.ops4j.pax.web.service.WebContainer

registerJspConfigTagLibs

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

Specified by:

registerJspConfigTagLibs in interface org.ops4j.pax.web.service.WebContainer

registerJspConfigTagLibs

public void registerJspConfigTagLibs(Collection<javax.servlet.descriptor.TaglibDescriptor> tagLibs,
                                     org.osgi.service.http.HttpContext httpContext)

Specified by:

registerJspConfigTagLibs in interface org.ops4j.pax.web.service.WebContainer

registerJspConfigPropertyGroup

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

Specified by:

registerJspConfigPropertyGroup in interface org.ops4j.pax.web.service.WebContainer

registerJspConfigPropertyGroup

public void registerJspConfigPropertyGroup(javax.servlet.descriptor.JspPropertyGroupDescriptor descriptor,
                                           org.osgi.service.http.HttpContext httpContext)

Specified by:

registerJspConfigPropertyGroup in interface org.ops4j.pax.web.service.WebContainer

unregisterJsps

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

Specified by:

unregisterJsps in interface org.ops4j.pax.web.service.WebContainer

unregisterJspServlet

public void unregisterJspServlet(String jspFile,
                                 org.osgi.service.http.HttpContext httpContext)

Specified by:

unregisterJspServlet in interface org.ops4j.pax.web.service.WebContainer

registerServletContainerInitializer

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

Specified by:

registerServletContainerInitializer in interface org.ops4j.pax.web.service.WebContainer

unregisterServletContainerInitializer

public void unregisterServletContainerInitializer(javax.servlet.ServletContainerInitializer initializer,
                                                  org.osgi.service.http.HttpContext httpContext)

Specified by:

unregisterServletContainerInitializer in interface org.ops4j.pax.web.service.WebContainer

setSessionTimeout

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

Specified by:

setSessionTimeout in interface org.ops4j.pax.web.service.WebContainer

setSessionCookieConfig

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

Specified by:

setSessionCookieConfig in interface org.ops4j.pax.web.service.WebContainer

setSessionCookieConfig

public void setSessionCookieConfig(javax.servlet.SessionCookieConfig config,
                                   org.osgi.service.http.HttpContext httpContext)

Specified by:

setSessionCookieConfig in interface org.ops4j.pax.web.service.WebContainer

setContextParams

public void setContextParams(Dictionary<String,Object> params,
                             org.osgi.service.http.HttpContext httpContext)

Specified by:

setContextParams in interface org.ops4j.pax.web.service.WebContainer

registerWebSocket

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

Specified by:

registerWebSocket in interface org.ops4j.pax.web.service.WebContainer

unregisterWebSocket

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

Specified by:

unregisterWebSocket in interface org.ops4j.pax.web.service.WebContainer

toString

public String toString()

Overrides:

toString in class Object