org.ops4j.pax.web.service.spi.model

Class ServiceModel

java.lang.Object

org.ops4j.pax.web.service.spi.model.ServiceModel

All Implemented Interfaces:

BatchVisitor

public class ServiceModel
extends Object
implements BatchVisitor

Service Model is kept at HttpService level, which is bundle-scoped in Pax Web (though Http Service specification doesn't mention the scope of Http Service). Its goal is to remember which web elements were registered from given bundle (both HttpService usage and Whiteboard service registrations).

This is just organizational separation, because the models are kept anyway at ServerModel and OsgiContextModel levels. It's required to correctly handle bundle-scoped unregistrations.

This bundle-scoped model is the main BatchVisitor, though it may delegate some visiting methods to other parts of the model.

Even if model elements (like ServletModel are added here, initial validation (whether given model can be added at all without causing conflicts), validation is performed at ServerModel level.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
ServiceModel(ServerModel serverModel, ServerController serverController, org.osgi.framework.Bundle serviceBundle, WebElementEventListener eventDispatcher)

Method Summary

Modifier and Type	Method and Description
OsgiContextModel	createDefaultHttpContext(String contextId) Creates named OsgiContextModel for the bundle from this ServiceModel and ensures that this OsgiContextModel is stored at ServerModel level.
Map<String,Map<String,ServletModel>>	getAliasMapping()
Set<ContainerInitializerModel>	getContainerInitializerModels()
Set<ErrorPageModel>	getErrorPageModels()
Set<EventListenerModel>	getEventListenerModels()
Set<FilterModel>	getFilterModels()
org.ops4j.pax.web.service.WebContainerContext	getOrCreateDefaultHttpContext(String contextId)
org.ops4j.pax.web.service.MultiBundleWebContainerContext	getOrCreateDefaultSharedHttpContext(String contextId)
Set<ServletModel>	getServletModels()
Set<WebSocketModel>	getWebSocketModels()
Set<WelcomeFileModel>	getWelcomeFileModels()
void	reRegisterWebElementsIfNeeded(OsgiContextModel oldContext, OsgiContextModel newContext, Batch batch) Fragile method that should check all the web elements registered into this ServiceModel but only if these elements were NOT registered through Whiteboard and were registered using oldContext.
void	visitClearDynamicRegistrationsChange(ClearDynamicRegistrationsChange change) Process a change related to reset of dynamic registrations (like ServletContext.addServlet(java.lang.String, java.lang.String)
void	visitContainerInitializerModelChange(ContainerInitializerModelChange change) Process a change related to ContainerInitializerModel
void	visitErrorPageModelChange(ErrorPageModelChange change) Process a change related to error pages
void	visitErrorPageStateChange(ErrorPageStateChange change) Process full change of the state of error pages per context
void	visitEventListenerModelChange(EventListenerModelChange change) Processing a change related to EventListenerModel
void	visitFilterModelChange(FilterModelChange change) Processing a change related to FilterModel.
void	visitFilterStateChange(FilterStateChange change) Processing full change of registered filters for all the affected contexts.
void	visitOsgiContextModelChange(OsgiContextModelChange change) Processing a change related to OsgiContextModel - a model that affects one ServletContextModel thought the relation is not 1:1, but N:1 - many OsgiContextModels may be associated with single ServletContextModel.
void	visitServletContextModelChange(ServletContextModelChange change) Processing the most high-level change - related to ServletContextModel, which creates (or destroys) entire context (1:1 with "context path").
void	visitServletModelChange(ServletModelChange change) Processing a change related to ServletModel.
void	visitWebSocketModelChange(WebSocketModelChange change) Process a change related to WebSocketModel
void	visitWelcomeFileModelChange(WelcomeFileModelChange change) Process a change related to welcome files.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ops4j.pax.web.service.spi.task.BatchVisitor

visitContextMetadataModelChange, visitContextParamsChange, visitContextStartChange, visitContextStopChange, visitMimeAndLocaleMappingChange, visitSecurityConfigChange, visitTransactionStateChange

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

ServiceModel

public ServiceModel(ServerModel serverModel,
                    ServerController serverController,
                    org.osgi.framework.Bundle serviceBundle,
                    WebElementEventListener eventDispatcher)

Method Detail

getOrCreateDefaultHttpContext

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

createDefaultHttpContext

public OsgiContextModel createDefaultHttpContext(String contextId)

Creates named OsgiContextModel for the bundle from this ServiceModel and ensures that this OsgiContextModel is stored at ServerModel level.

Parameters:

contextId -

Returns:

getOrCreateDefaultSharedHttpContext

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

getAliasMapping

public Map<String,Map<String,ServletModel>> getAliasMapping()

getServletModels

public Set<ServletModel> getServletModels()

getFilterModels

public Set<FilterModel> getFilterModels()

getEventListenerModels

public Set<EventListenerModel> getEventListenerModels()

getWelcomeFileModels

public Set<WelcomeFileModel> getWelcomeFileModels()

getErrorPageModels

public Set<ErrorPageModel> getErrorPageModels()

getContainerInitializerModels

public Set<ContainerInitializerModel> getContainerInitializerModels()

getWebSocketModels

public Set<WebSocketModel> getWebSocketModels()

visitServletContextModelChange

public void visitServletContextModelChange(ServletContextModelChange change)

Description copied from interface: BatchVisitor

Processing the most high-level change - related to ServletContextModel, which creates (or destroys) entire context (1:1 with "context path").

Specified by:

visitServletContextModelChange in interface BatchVisitor

visitOsgiContextModelChange

public void visitOsgiContextModelChange(OsgiContextModelChange change)

Description copied from interface: BatchVisitor

Processing a change related to OsgiContextModel - a model that affects one ServletContextModel thought the relation is not 1:1, but N:1 - many OsgiContextModels may be associated with single ServletContextModel.

Specified by:

visitOsgiContextModelChange in interface BatchVisitor

visitServletModelChange

public void visitServletModelChange(ServletModelChange change)

Description copied from interface: BatchVisitor

Processing a change related to ServletModel. Related to registration or unregistration of servlets.

Specified by:

visitServletModelChange in interface BatchVisitor

visitFilterModelChange

public void visitFilterModelChange(FilterModelChange change)

Description copied from interface: BatchVisitor

Processing a change related to FilterModel. Related to registration or unregistration of filter.

Specified by:

visitFilterModelChange in interface BatchVisitor

visitFilterStateChange

public void visitFilterStateChange(FilterStateChange change)

Description copied from interface: BatchVisitor

Processing full change of registered filters for all the affected contexts. It's necessary for filters, because registration of single filter may require reorganization (ordering) of currently registered filters.

Specified by:

visitFilterStateChange in interface BatchVisitor

visitEventListenerModelChange

public void visitEventListenerModelChange(EventListenerModelChange change)

Description copied from interface: BatchVisitor

Processing a change related to EventListenerModel

Specified by:

visitEventListenerModelChange in interface BatchVisitor

visitContainerInitializerModelChange

public void visitContainerInitializerModelChange(ContainerInitializerModelChange change)

Description copied from interface: BatchVisitor

Process a change related to ContainerInitializerModel

Specified by:

visitContainerInitializerModelChange in interface BatchVisitor

visitWelcomeFileModelChange

public void visitWelcomeFileModelChange(WelcomeFileModelChange change)

Description copied from interface: BatchVisitor

Process a change related to welcome files.

Specified by:

visitWelcomeFileModelChange in interface BatchVisitor

visitErrorPageModelChange

public void visitErrorPageModelChange(ErrorPageModelChange change)

Description copied from interface: BatchVisitor

Process a change related to error pages

Specified by:

visitErrorPageModelChange in interface BatchVisitor

visitErrorPageStateChange

public void visitErrorPageStateChange(ErrorPageStateChange change)

Description copied from interface: BatchVisitor

Process full change of the state of error pages per context

Specified by:

visitErrorPageStateChange in interface BatchVisitor

visitWebSocketModelChange

public void visitWebSocketModelChange(WebSocketModelChange change)

Description copied from interface: BatchVisitor

Process a change related to WebSocketModel

Specified by:

visitWebSocketModelChange in interface BatchVisitor

visitClearDynamicRegistrationsChange

public void visitClearDynamicRegistrationsChange(ClearDynamicRegistrationsChange change)

Description copied from interface: BatchVisitor

Process a change related to reset of dynamic registrations (like ServletContext.addServlet(java.lang.String, java.lang.String)

Specified by:

visitClearDynamicRegistrationsChange in interface BatchVisitor

reRegisterWebElementsIfNeeded

public void reRegisterWebElementsIfNeeded(OsgiContextModel oldContext,
                                          OsgiContextModel newContext,
                                          Batch batch)

Fragile method that should check all the web elements registered into this ServiceModel but only if these elements were NOT registered through Whiteboard and were registered using oldContext. If conditions match, each such element should be unregistered and then registered again in order to switch its HttpService-related context.

This method is an equivalent of org.ops4j.pax.web.extender.whiteboard.internal.WhiteboardContext#reRegisterWebElements().

Parameters:

oldContext -

newContext - may be null - in such case we have to determine new context

batch -