org.ops4j.pax.web.service.spi.whiteboard

Interface WhiteboardWebContainerView

All Superinterfaces:

org.ops4j.pax.web.service.views.PaxWebContainerView

public interface WhiteboardWebContainerView
extends org.ops4j.pax.web.service.views.PaxWebContainerView

SPI interface which is used by pax-web-extender-whiteboard to gain lower-level access to WebContainer managed and lifecycle-scoped to pax-web-runtime bundle.

This is a loose (as loose as possible) coupling between pax-web-runtime (an implementation of HttpService specification) and pax-web-extender-whiteboard (an implementation of Whiteboard Service specification).

The most important difference with direct usage of WebContainer is that the passed models already have OsgiContextModels associated, while in the WebContainer case these have to be translated from HttpContext.

Method Summary

Modifier and Type	Method and Description
void	addWhiteboardOsgiContextModel(OsgiContextModel model) Passes Whiteboard-registered (customized) OsgiContextModel to be managed in WebContainer.
void	clearFailedDTOInformation(ElementModel<?,?> webElement) Sned information that given ElementModel is no longer Whiteboard-tracked, so possible failure DTOs have to be cleared
void	clearFailedDTOInformation(OsgiContextModel webContext) Sned information that given OsgiContextModel is no longer Whiteboard-tracked, so possible failure DTOs have to be cleared
void	failedDTOInformation(ElementModel<?,?> webElement) Send information about failure DTO related to given ElementModel.
void	failedDTOInformation(OsgiContextModel webContext) Send information about failure DTO related to given OsgiContextModel.
List<OsgiContextModel>	getOsgiContextModels(org.osgi.framework.Bundle bundle) Returns all the contexts (customized to unified OsgiContextModel internal representation) managed at Http Service level.
void	registerErrorPages(ErrorPageModel model) Registers error pages into associated contexts
void	registerFilter(FilterModel model) One-stop method to register a Filter described using FilterModel.
void	registerJsp(JspModel model) Registration of JSP model
void	registerListener(EventListenerModel model) Registers a EventListenerModel.
void	registerResources(ServletModel model) Registers a ServletModel as a resource servlet, which means that first proper resource servlet has to be created.
void	registerSecurityConfiguration(SecurityConfigurationModel model) Registration of SecurityConfigurationModel
void	registerServlet(ServletModel model) One-stop method to register a Servlet described using ServletModel.
void	registerWabOsgiContextListener(WebContextEventListener whiteboardExtenderContext) Register a listener/hook, that'll be called when there's OsgiContextModel created for the WAB.
void	registerWebSocket(WebSocketModel model) Registration of WebSocketModel
void	registerWelcomeFiles(WelcomeFileModel model) Registers welcome files into associated contexts
void	removeWhiteboardOsgiContextModel(OsgiContextModel model) Removes Whiteboard-registered (customized) OsgiContextModel from WebContainer, which may then switch to using "default" HttpContext
void	unregisterErrorPages(ErrorPageModel model) Unregisters error pages
void	unregisterFilter(FilterModel model) Unregistration of FilterModel using any set criteria.
void	unregisterJsp(JspModel model) Unregistration of JSP model
void	unregisterListener(EventListenerModel model) Unregisters a EventListenerModel.
void	unregisterResources(ServletModel model) Unregisters a ServletModel as a resource servlet.
void	unregisterSecurityConfiguration(SecurityConfigurationModel model) Unregistration of SecurityConfigurationModel
void	unregisterServlet(ServletModel model) Unregistration of ServletModel using any set criteria.
void	unregisterWebSocket(WebSocketModel model) Unregistration of WebSocketModel
void	unregisterWelcomeFiles(WelcomeFileModel model) Unregisters welcome files

Method Detail

registerWabOsgiContextListener

void registerWabOsgiContextListener(WebContextEventListener whiteboardExtenderContext)

Register a listener/hook, that'll be called when there's OsgiContextModel created for the WAB. Such OsgiContextModel should be always used for given context path, hiding all other context models.

Parameters:

whiteboardExtenderContext -

getOsgiContextModels

List<OsgiContextModel> getOsgiContextModels(org.osgi.framework.Bundle bundle)

Returns all the contexts (customized to unified OsgiContextModel internal representation) managed at Http Service level. These are either bound to given bundle or "shared"

Parameters:

bundle -

Returns:

registerServlet

void registerServlet(ServletModel model)

One-stop method to register a Servlet described using ServletModel. ServletModel should always be associated with target (one or many) OsgiContextModel, because differently than with HttpService scenario, contexts are targeted by logical name (or LDAP selector) and not as any instance.

Parameters:

model -

unregisterServlet

void unregisterServlet(ServletModel model)

Unregistration of ServletModel using any set criteria.

Parameters:

model -

registerFilter

void registerFilter(FilterModel model)

One-stop method to register a Filter described using FilterModel. FilterModel should always be associated with target (one or many) OsgiContextModel.

Parameters:

model -

unregisterFilter

void unregisterFilter(FilterModel model)

Unregistration of FilterModel using any set criteria.

Parameters:

model -

registerWelcomeFiles

void registerWelcomeFiles(WelcomeFileModel model)

Registers welcome files into associated contexts

Parameters:

model -

unregisterWelcomeFiles

void unregisterWelcomeFiles(WelcomeFileModel model)

Unregisters welcome files

Parameters:

model -

registerErrorPages

void registerErrorPages(ErrorPageModel model)

Registers error pages into associated contexts

Parameters:

model -

unregisterErrorPages

void unregisterErrorPages(ErrorPageModel model)

Unregisters error pages

Parameters:

model -

addWhiteboardOsgiContextModel

void addWhiteboardOsgiContextModel(OsgiContextModel model)

Passes Whiteboard-registered (customized) OsgiContextModel to be managed in WebContainer. Such OsgiContextModel should have HttpContext / WebContainerContext configured directly. That's the requirement, when Whiteboard cedes the management of such context from pax-web-extender-whiteboard to pax-web-runtime.

Parameters:

model -

removeWhiteboardOsgiContextModel

void removeWhiteboardOsgiContextModel(OsgiContextModel model)

Removes Whiteboard-registered (customized) OsgiContextModel from WebContainer, which may then switch to using "default" HttpContext

Parameters:

model -

registerResources

void registerResources(ServletModel model)

Registers a ServletModel as a resource servlet, which means that first proper resource servlet has to be created.

Parameters:

model -

unregisterResources

void unregisterResources(ServletModel model)

Unregisters a ServletModel as a resource servlet.

Parameters:

model -

registerListener

void registerListener(EventListenerModel model)

Registers a EventListenerModel.

Parameters:

model -

unregisterListener

void unregisterListener(EventListenerModel model)

Unregisters a EventListenerModel.

Parameters:

model -

registerJsp

void registerJsp(JspModel model)

Registration of JSP model

Parameters:

model -

unregisterJsp

void unregisterJsp(JspModel model)

Unregistration of JSP model

Parameters:

model -

registerWebSocket

void registerWebSocket(WebSocketModel model)

Registration of WebSocketModel

Parameters:

model -

unregisterWebSocket

void unregisterWebSocket(WebSocketModel model)

Unregistration of WebSocketModel

Parameters:

model -

registerSecurityConfiguration

void registerSecurityConfiguration(SecurityConfigurationModel model)

Registration of SecurityConfigurationModel

Parameters:

model -

unregisterSecurityConfiguration

void unregisterSecurityConfiguration(SecurityConfigurationModel model)

Unregistration of SecurityConfigurationModel

Parameters:

model -

failedDTOInformation

void failedDTOInformation(ElementModel<?,?> webElement)

Send information about failure DTO related to given ElementModel. Successful DTO is sent/calculated together with the registration - Whiteboard service tracking failures are normally not sent as element registrations to pax-web-runtime.

Parameters:

webElement -

failedDTOInformation

void failedDTOInformation(OsgiContextModel webContext)

Send information about failure DTO related to given OsgiContextModel. Successful DTO is sent/calculated togehter with the registration.

Parameters:

webContext -

clearFailedDTOInformation

void clearFailedDTOInformation(ElementModel<?,?> webElement)

Sned information that given ElementModel is no longer Whiteboard-tracked, so possible failure DTOs have to be cleared

Parameters:

webElement -

clearFailedDTOInformation

void clearFailedDTOInformation(OsgiContextModel webContext)

Sned information that given OsgiContextModel is no longer Whiteboard-tracked, so possible failure DTOs have to be cleared

Parameters:

webContext -