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

Class Batch

java.lang.Object

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

public class Batch
extends Object

List of tasks to perform on model. Collects primitive operations which can be reverted if something goes wrong, can be delayed if needed or shared between multiple invocations.

The idea is that normal, elementary operation, like registration of a servlet may be associated with model-altering operations. If something goes wrong, we'd like to rollback the changes. If everything is fine, we can use given batch to:

• actually apply the operations to global model
• pass the operations (e.g., create servlet context, create osgi context, register servlet) to ServerController

This class is implemented using the Visitor pattern, where the registration operations (servlet registration, error page registration, context configuration, ...) are elements and the classes that should handle registration operations (like global ServerModel or actual server runtime) implement related vistors.

Constructor Summary

Constructors

Constructor and Description
Batch(String description)

Method Summary

Modifier and Type	Method and Description
void	accept(BatchVisitor visitor) Assuming everything is ok, this method simply invokes all the collected operations which will: alter global ServerModel sequentially. alter actual server runtime ...
void	addContainerInitializerModel(ContainerInitializerModel model, OsgiContextModel... newModels) Add new ContainerInitializerModel
void	addDisabledErrorPageModel(ErrorPageModel model) Add ErrorPageModel to ServerModel but as disabled model
void	addDisabledFilterModel(FilterModel model) Add FilterModel to ServerModel but as disabled model
void	addDisabledServletModel(ServletModel model) Add ServletModel to ServerModel but as disabled model, which can't be registered because other model is registered for the same URL pattern.
void	addDisabledWebSocketModel(WebSocketModel model) Add new WebSocketModel marked as disabled
void	addErrorPageModel(ErrorPageModel model, OsgiContextModel... newModels) Add ErrorPageModel to ServerModel
void	addEventListenerModel(EventListenerModel model, OsgiContextModel... newModels) Add new EventListenerModel
void	addFilterModel(FilterModel model, OsgiContextModel... newModels) Add FilterModel to ServerModel
void	addOsgiContextModel(OsgiContextModel osgiContextModel, ServletContextModel servletContextModel) Add new OsgiContextModel
void	addServletContextModel(ServletContextModel servletContextModel) Add new ServletContextModel
void	addServletModel(ServletModel model, OsgiContextModel... newModels) Add ServletModel to ServerModel
void	addWebSocketModel(WebSocketModel model) Add new WebSocketModel
void	addWelcomeFileModel(WelcomeFileModel model, OsgiContextModel... newModels) Add new WelcomeFileModel
void	associateOsgiContextModel(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel osgiContextModel) Mark OsgiContextModel as associated with WebContainerContext
void	beginTransaction(String contextPath) Mark a Batch as transactional, so accepting visitors can be aware that more changes are coming.
void	changeContainerInitializerModel(ContainerInitializerModel model)
void	clearDynamicRegistrations(List<OsgiContextModel> contextModels) Operation that clears all dynamic registrations from the model and target context.
void	commitTransaction(String contextPath) Complete the transaction, so for example a ServerController knows to finally start the context.
void	configureMetadata(ContextMetadataModel meta, OsgiContextModel ocm) Configure some meta information related to a context.
void	configureMimeAndEncodingMappings(Map<String,String> mimeMapping, Map<String,String> localeEncodingMapping, OsgiContextModel ocm) Configure extension - MIME mapping.
void	disableErrorPageModel(ErrorPageModel model) Disable ErrorPageModel in ServerModel
void	disableFilterModel(FilterModel model) Disable FilterModel from ServerModel
void	disableServletModel(ServletModel model) Disable ServletModel from ServerModel
void	disableWebSocketModel(WebSocketModel model) Disable existing WebSocketModel
void	disassociateOsgiContextModel(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel osgiContextModel) Mark OsgiContextModel as (temporarily) disassociated with WebContainerContext
void	enableErrorPageModel(ErrorPageModel model) Enable ErrorPageModel
void	enableFilterModel(FilterModel model) Enable FilterModel
void	enableServletModel(ServletModel model) Enable ServletModel
void	enableWebSocketModel(WebSocketModel model) Enable existing WebSocketModel
List<Change>	getOperations()
String	getShortDescription()
void	removeContainerInitializerModels(List<ContainerInitializerModel> models) Remove existing ContainerInitializerModel
void	removeErrorPageModels(List<ErrorPageModel> toUnregister) Remove ErrorPageModel from ServerModel
void	removeEventListenerModels(List<EventListenerModel> models) Remove existing EventListenerModel
void	removeFilterModels(List<FilterModel> toUnregister) Remove ServletModel from ServerModel
void	removeOsgiContextModel(OsgiContextModel osgiContextModel) Remove existing OsgiContextModel
void	removeServletModels(Map<ServletModel,Boolean> toUnregister) Remove ServletModel from ServerModel
void	removeWebSocketModels(Map<WebSocketModel,Boolean> models) Remove existing WebSocketModel
void	removeWelcomeFileModel(WelcomeFileModel model) Remove WelcomeFileModel
void	setShortDescription(String shortDescription)
String	toString()
Batch	uninstall(String description) A Batch can create the uninstallation batch consisting of all the operations reversed.
void	updateErrorPages(Map<String,TreeMap<ErrorPageModel,List<OsgiContextModel>>> contextErrorPageModels) Batch (inside batch...) method that passes full information about all error page models that should be enabled in a set of contexts.
void	updateFilters(Map<String,TreeMap<FilterModel,List<OsgiContextModel>>> contextFilters, boolean dynamic) Batch (inside batch...) method that passes full information about all filters that should be enabled in a set of contexts.

Methods inherited from class java.lang.Object

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

Constructor Detail

Batch

public Batch(String description)

Method Detail

getOperations

public List<Change> getOperations()

getShortDescription

public String getShortDescription()

setShortDescription

public void setShortDescription(String shortDescription)

addServletContextModel

public void addServletContextModel(ServletContextModel servletContextModel)

Add new ServletContextModel

Parameters:

servletContextModel -

addOsgiContextModel

public void addOsgiContextModel(OsgiContextModel osgiContextModel,
                                ServletContextModel servletContextModel)

Add new OsgiContextModel

Parameters:

osgiContextModel -

removeOsgiContextModel

public void removeOsgiContextModel(OsgiContextModel osgiContextModel)

Remove existing OsgiContextModel

Parameters:

osgiContextModel -

associateOsgiContextModel

public void associateOsgiContextModel(org.ops4j.pax.web.service.WebContainerContext context,
                                      OsgiContextModel osgiContextModel)

Mark OsgiContextModel as associated with WebContainerContext

Parameters:

context -

osgiContextModel -

disassociateOsgiContextModel

public void disassociateOsgiContextModel(org.ops4j.pax.web.service.WebContainerContext context,
                                         OsgiContextModel osgiContextModel)

Mark OsgiContextModel as (temporarily) disassociated with WebContainerContext

Parameters:

context -

osgiContextModel -

addServletModel

public void addServletModel(ServletModel model,
                            OsgiContextModel... newModels)

Add ServletModel to ServerModel

Parameters:

model -

removeServletModels

public void removeServletModels(Map<ServletModel,Boolean> toUnregister)

Remove ServletModel from ServerModel

Parameters:

toUnregister -

addDisabledServletModel

public void addDisabledServletModel(ServletModel model)

Add ServletModel to ServerModel but as disabled model, which can't be registered because other model is registered for the same URL pattern. Disabled models can later be registered of existing model with higher ranking is unregistered.

Parameters:

model -

enableServletModel

public void enableServletModel(ServletModel model)

Enable ServletModel

Parameters:

model -

disableServletModel

public void disableServletModel(ServletModel model)

Disable ServletModel from ServerModel

Parameters:

model -

addFilterModel

public void addFilterModel(FilterModel model,
                           OsgiContextModel... newModels)

Add FilterModel to ServerModel

Parameters:

model -

removeFilterModels

public void removeFilterModels(List<FilterModel> toUnregister)

Remove ServletModel from ServerModel

Parameters:

toUnregister -

addDisabledFilterModel

public void addDisabledFilterModel(FilterModel model)

Add FilterModel to ServerModel but as disabled model

Parameters:

model -

enableFilterModel

public void enableFilterModel(FilterModel model)

Enable FilterModel

Parameters:

model -

disableFilterModel

public void disableFilterModel(FilterModel model)

Disable FilterModel from ServerModel

Parameters:

model -

updateFilters

public void updateFilters(Map<String,TreeMap<FilterModel,List<OsgiContextModel>>> contextFilters,
                          boolean dynamic)

Batch (inside batch...) method that passes full information about all filters that should be enabled in a set of contexts. To be handled by Server Controller only

Parameters:

contextFilters -

dynamic - should be set to true when adding a FilterModel related to ServletContext.addFilter(java.lang.String, java.lang.String)

addErrorPageModel

public void addErrorPageModel(ErrorPageModel model,
                              OsgiContextModel... newModels)

Add ErrorPageModel to ServerModel

Parameters:

model -

removeErrorPageModels

public void removeErrorPageModels(List<ErrorPageModel> toUnregister)

Remove ErrorPageModel from ServerModel

Parameters:

toUnregister -

addDisabledErrorPageModel

public void addDisabledErrorPageModel(ErrorPageModel model)

Add ErrorPageModel to ServerModel but as disabled model

Parameters:

model -

enableErrorPageModel

public void enableErrorPageModel(ErrorPageModel model)

Enable ErrorPageModel

Parameters:

model -

disableErrorPageModel

public void disableErrorPageModel(ErrorPageModel model)

Disable ErrorPageModel in ServerModel

Parameters:

model -

updateErrorPages

public void updateErrorPages(Map<String,TreeMap<ErrorPageModel,List<OsgiContextModel>>> contextErrorPageModels)

Batch (inside batch...) method that passes full information about all error page models that should be enabled in a set of contexts. To be handled by Server Controller only

Parameters:

contextErrorPageModels -

addEventListenerModel

public void addEventListenerModel(EventListenerModel model,
                                  OsgiContextModel... newModels)

Add new EventListenerModel

Parameters:

model -

removeEventListenerModels

public void removeEventListenerModels(List<EventListenerModel> models)

Remove existing EventListenerModel

Parameters:

models -

addContainerInitializerModel

public void addContainerInitializerModel(ContainerInitializerModel model,
                                         OsgiContextModel... newModels)

Add new ContainerInitializerModel

Parameters:

model -

changeContainerInitializerModel

public void changeContainerInitializerModel(ContainerInitializerModel model)

removeContainerInitializerModels

public void removeContainerInitializerModels(List<ContainerInitializerModel> models)

Remove existing ContainerInitializerModel

Parameters:

models -

addWelcomeFileModel

public void addWelcomeFileModel(WelcomeFileModel model,
                                OsgiContextModel... newModels)

Add new WelcomeFileModel

Parameters:

model -

newModels -

removeWelcomeFileModel

public void removeWelcomeFileModel(WelcomeFileModel model)

Remove WelcomeFileModel

Parameters:

model -

addWebSocketModel

public void addWebSocketModel(WebSocketModel model)

Add new WebSocketModel

Parameters:

model -

addDisabledWebSocketModel

public void addDisabledWebSocketModel(WebSocketModel model)

Add new WebSocketModel marked as disabled

Parameters:

model -

disableWebSocketModel

public void disableWebSocketModel(WebSocketModel model)

Disable existing WebSocketModel

Parameters:

model -

removeWebSocketModels

public void removeWebSocketModels(Map<WebSocketModel,Boolean> models)

Remove existing WebSocketModel

Parameters:

models -

enableWebSocketModel

public void enableWebSocketModel(WebSocketModel model)

Enable existing WebSocketModel

Parameters:

model -

beginTransaction

public void beginTransaction(String contextPath)

Mark a Batch as transactional, so accepting visitors can be aware that more changes are coming. For example, a WAB/WAR configures a set of servlet/filter/... registrations and it's wise to start the context only at the end of the batch.

Parameters:

contextPath - transactions are always (for now?) related to single context path.

commitTransaction

public void commitTransaction(String contextPath)

Complete the transaction, so for example a ServerController knows to finally start the context.

Parameters:

contextPath -

configureMetadata

public void configureMetadata(ContextMetadataModel meta,
                              OsgiContextModel ocm)

Configure some meta information related to a context.

Parameters:

meta -

ocm -

configureMimeAndEncodingMappings

public void configureMimeAndEncodingMappings(Map<String,String> mimeMapping,
                                             Map<String,String> localeEncodingMapping,
                                             OsgiContextModel ocm)

Configure extension - MIME mapping.

Parameters:

mimeMapping -

localeEncodingMapping -

ocm -

clearDynamicRegistrations

public void clearDynamicRegistrations(List<OsgiContextModel> contextModels)

Operation that clears all dynamic registrations from the model and target context. Dynamic registrations are the ones created by e.g., ServletContext.addServlet(java.lang.String, java.lang.String).

Parameters:

contextModels -

accept

public void accept(BatchVisitor visitor)

Assuming everything is ok, this method simply invokes all the collected operations which will:

• alter global ServerModel sequentially.
• alter actual server runtime
• ...

uninstall

public Batch uninstall(String description)

A Batch can create the uninstallation batch consisting of all the operations reversed.

Returns:

toString

public String toString()

Overrides:

toString in class Object