org.ops4j.pax.web.service.spi.task

Interface BatchVisitor

All Known Implementing Classes:

ServerModel, ServiceModel

public interface BatchVisitor

Single interface that aims to replace all other interfaces with methods like registerServlet, unregisterServlet, ...

In Pax Web 8, we've tried to decrease duplication of such interfaces (similar methods were available in interfaces representing HttpService, ServerController, server abstraction, server state, ... Now, if any class wants to handle actual (un/re)registrations, it just needs to implement the visitor and correctly configured Batch can accept such visitor.

Method Summary

Modifier and Type	Method and Description
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
default void	visitContextMetadataModelChange(ContextMetadataModelChange change) Process a change related to metadata of the context.
default void	visitContextParamsChange(ContextParamsChange contextParamsChange) Process a change related to context parameters setup
default void	visitContextStartChange(ContextStartChange contextStartChange) Process a change related to starting a context - action created on the visitor side to schedule start of the context in different thread/event tick.
default void	visitContextStopChange(ContextStopChange contextStopChange) Process a change related to stopping a context
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.
default void	visitMimeAndLocaleMappingChange(MimeAndLocaleMappingChange change) Process a change related to full MIME mapping for the context.
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.
default void	visitSecurityConfigChange(SecurityConfigChange securityConfigChange) Process a changed related to security configuration of web context.
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.
default void	visitTransactionStateChange(TransactionStateChange change) Process a change related to transactions for a context (path).
void	visitWebSocketModelChange(WebSocketModelChange change) Process a change related to WebSocketModel
void	visitWelcomeFileModelChange(WelcomeFileModelChange change) Process a change related to welcome files.

Method Detail

visitServletContextModelChange

void visitServletContextModelChange(ServletContextModelChange change)

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

Parameters:

change -

visitOsgiContextModelChange

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.

Parameters:

change -

visitServletModelChange

void visitServletModelChange(ServletModelChange change)

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

Parameters:

change -

visitFilterModelChange

void visitFilterModelChange(FilterModelChange change)

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

Parameters:

change -

visitFilterStateChange

void visitFilterStateChange(FilterStateChange change)

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.

Parameters:

change -

visitEventListenerModelChange

void visitEventListenerModelChange(EventListenerModelChange change)

Processing a change related to EventListenerModel

Parameters:

change -

visitWelcomeFileModelChange

void visitWelcomeFileModelChange(WelcomeFileModelChange change)

Process a change related to welcome files.

Parameters:

change -

visitErrorPageModelChange

void visitErrorPageModelChange(ErrorPageModelChange change)

Process a change related to error pages

Parameters:

change -

visitErrorPageStateChange

void visitErrorPageStateChange(ErrorPageStateChange change)

Process full change of the state of error pages per context

Parameters:

change -

visitContainerInitializerModelChange

void visitContainerInitializerModelChange(ContainerInitializerModelChange change)

Process a change related to ContainerInitializerModel

Parameters:

change -

visitWebSocketModelChange

void visitWebSocketModelChange(WebSocketModelChange change)

Process a change related to WebSocketModel

Parameters:

change -

visitTransactionStateChange

default void visitTransactionStateChange(TransactionStateChange change)

Process a change related to transactions for a context (path). There's no need to implement this method in a BatchVisitor.

Parameters:

change -

visitContextMetadataModelChange

default void visitContextMetadataModelChange(ContextMetadataModelChange change)

Process a change related to metadata of the context. No need to "uninstall" such change.

Parameters:

change -

visitMimeAndLocaleMappingChange

default void visitMimeAndLocaleMappingChange(MimeAndLocaleMappingChange change)

Process a change related to full MIME mapping for the context. No add/remove/modify operations - just full set.

Parameters:

change -

visitClearDynamicRegistrationsChange

void visitClearDynamicRegistrationsChange(ClearDynamicRegistrationsChange change)

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

Parameters:

change -

visitContextStartChange

default void visitContextStartChange(ContextStartChange contextStartChange)

Process a change related to starting a context - action created on the visitor side to schedule start of the context in different thread/event tick.

Parameters:

contextStartChange -

visitContextStopChange

default void visitContextStopChange(ContextStopChange contextStopChange)

Process a change related to stopping a context

Parameters:

contextStopChange -

visitContextParamsChange

default void visitContextParamsChange(ContextParamsChange contextParamsChange)

Process a change related to context parameters setup

Parameters:

contextParamsChange -

visitSecurityConfigChange

default void visitSecurityConfigChange(SecurityConfigChange securityConfigChange)

Process a changed related to security configuration of web context.

Parameters:

securityConfigChange -