Uses of Class
org.ops4j.pax.web.service.spi.model.OsgiContextModel

Packages that use OsgiContextModel

Package	Description
org.ops4j.pax.web.service.spi.config
org.ops4j.pax.web.service.spi.model	SPI model hierarchy contains classes to internally represent all the information required during registration (adding to running server) of web components (servlets, filters, welcome files, error pages, security constraints, ...).
org.ops4j.pax.web.service.spi.model.elements	Model subpackage representing actual web elements, while infrastructure elements (like contexts) are kept in the package above.
org.ops4j.pax.web.service.spi.model.events	Package with DTO-like classes that are used to inform about registration/unregistration of web elements and contexts.
org.ops4j.pax.web.service.spi.model.info	This package contains DTO-like classes used when presenting information about Pax Web models.
org.ops4j.pax.web.service.spi.model.views
org.ops4j.pax.web.service.spi.servlet	Package with classes used in different runtimes for common tasks, like wrapping HttpServletRequest.
org.ops4j.pax.web.service.spi.servlet.dynamic
org.ops4j.pax.web.service.spi.task	Package containing tools for batch/transactional operations on Pax Web model and ServerController.
org.ops4j.pax.web.service.spi.util
org.ops4j.pax.web.service.spi.whiteboard

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.config

Methods in org.ops4j.pax.web.service.spi.config with parameters of type OsgiContextModel

Modifier and Type	Method and Description
String	JspConfiguration.getJspScratchDir(OsgiContextModel model) What scratch directory should we use when compiling JSP pages? Default is the work directory for the current web application.

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.model

Fields in org.ops4j.pax.web.service.spi.model declared as OsgiContextModel

Modifier and Type	Field and Description
static OsgiContextModel	OsgiContextModel.DEFAULT_CONTEXT_MODEL The singleton OsgiContextModel used both by pax-web-runtime and pax-web-extender-whiteboard

Methods in org.ops4j.pax.web.service.spi.model that return OsgiContextModel

Modifier and Type	Method and Description
OsgiContextModel	ServiceModel.createDefaultHttpContext(String contextId) Creates named OsgiContextModel for the bundle from this ServiceModel and ensures that this OsgiContextModel is stored at ServerModel level.
OsgiContextModel	ServerModel.createDefaultSharedtHttpContext(String contextId, ServerController controller) Creates named OsgiContextModel as shared OsgiContextModel.
OsgiContextModel	ServerModel.createNewContextModel(org.ops4j.pax.web.service.WebContainerContext webContext, org.osgi.framework.Bundle serviceBundle, String contextPath) Method used to create new instance of OsgiContextModel when the input WebContainerContext is not yet associated with any context.
OsgiContextModel	ServerModel.getBundleContextModel(org.ops4j.pax.web.service.WebContainerContext context) Returns (if exists) bundle-scoped OsgiContextModel for given WebContainerContext.
OsgiContextModel	ServerModel.getBundleContextModel(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel skip) Gets the best bundle OsgiContextModel for given WebContainerContext unless it's the one to skip
OsgiContextModel	ServerModel.getBundleDefaultContextModel(ContextKey key)
OsgiContextModel	ServerModel.getContextModel(String name, org.osgi.framework.Bundle ownerBundle) Returns (if exists) bundle-scoped OsgiContextModel with given name.
OsgiContextModel	ServerModel.getOrCreateOsgiContextModel(org.ops4j.pax.web.service.WebContainerContext context, org.osgi.framework.Bundle serviceBundle, String contextPath, Batch batch) Returns (new or existing) OsgiContextModel associated with HttpContext.
OsgiContextModel	ServerModel.getSharedContextModel(String name) Returns (if exists) bundle-agnostic (shared) OsgiContextModel
OsgiContextModel	ServerModel.getSharedContextModel(String name, OsgiContextModel skip) Gets the best shared OsgiContextModel for given name unless it's the one to skip
OsgiContextModel	ServerModel.getSharedDefaultContextModel(String name)
OsgiContextModel	ServerModel.getWabContext(String contextPath, org.osgi.framework.Bundle wab, boolean create) When dealing with WABs, before WAB's OsgiContextModel is available for other registrations (HttpService and Whiteboard) it has to be allocated - so no two WABs conflict about an OsgiContextModel.
OsgiContextModel	ServerModel.verifyExistingAssociation(org.ops4j.pax.web.service.WebContainerContext context, org.osgi.framework.Bundle bundle) This method ensures that if given WebContainerContext is already mapped to some OsgiContextModel, it is permitted to reference it within a scope of a given bundle.

Methods in org.ops4j.pax.web.service.spi.model that return types with arguments of type OsgiContextModel

Modifier and Type	Method and Description
List<OsgiContextModel>	ServerModel.getAllBundleOsgiContextModels(org.osgi.framework.Bundle bundle)
Set<OsgiContextModel>	ServerModel.getAllWhiteboardContexts()
List<OsgiContextModel>	ServerModel.getOsgiContextModels(org.osgi.framework.Bundle bundle) Returns OsgiContextModel contexts that can be used by given bundle - i.e., can be targets of Whiteboard web element registered withing given bundle.

Methods in org.ops4j.pax.web.service.spi.model with parameters of type OsgiContextModel

Modifier and Type	Method and Description
void	ServerModel.addWhiteboardContext(OsgiContextModel ocm)
void	ServerModel.associateHttpContext(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel osgiContextModel) Mark WebContainerContext as the owner/creator/initiator of given OsgiContextModel whether it's shared or bundle-scoped.
int	OsgiContextModel.compareTo(OsgiContextModel o)
void	ServerModel.disassociateHttpContext(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel osgiContextModel) Simply unmark WebContainerContext as the owner/creator/initiator of given OsgiContextModel whether it's shared or bundle-related.
OsgiContextModel	ServerModel.getBundleContextModel(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel skip) Gets the best bundle OsgiContextModel for given WebContainerContext unless it's the one to skip
OsgiContextModel	ServerModel.getSharedContextModel(String name, OsgiContextModel skip) Gets the best shared OsgiContextModel for given name unless it's the one to skip
static ContextKey	ContextKey.of(OsgiContextModel context)
void	ServerModel.registerOsgiContextModelIfNeeded(OsgiContextModel contextModel, ServiceModel serviceModel, Batch batch) Ensures that OsgiContextModel created and managed in pax-web-extender-whiteboard and passed together with ElementModel is correctly registered in this ServerModel and passed to ServerController.
void	ServerModel.removeWhiteboardContext(OsgiContextModel ocm)
void	ServiceModel.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	ServerModel.unregisterOsgiContextModel(OsgiContextModel contextModel, ServiceModel serviceModel, Batch batch) Called through WhiteboardWebContainerView when the OsgiContextModel managed in pax-web-extender-whiteboard should be removed from the target ServerController and unassociated from any bundle.

Method parameters in org.ops4j.pax.web.service.spi.model with type arguments of type OsgiContextModel

Modifier and Type	Method and Description
void	ServerModel.prepareErrorPageSnapshot(Map<String,TreeMap<ErrorPageModel,List<OsgiContextModel>>> currentlyEnabledByPath, Set<ErrorPageModel> currentlyDisabled, ErrorPageModel newlyAdded, Set<ErrorPageModel> newlyDisabled) Preparation for ServerModel.reEnableErrorPageModels(Set, Map, ErrorPageModel, Batch) that does proper copy of current state of all ServletContextModel
void	ServerModel.prepareFiltersSnapshot(Map<String,TreeMap<FilterModel,List<OsgiContextModel>>> currentlyEnabledByPath, Set<FilterModel> currentlyDisabled, FilterModel newlyAdded, Set<FilterModel> newlyDisabled) Preparation for ServerModel.reEnableFilterModels(Set, Map, FilterModel, Batch) that does proper copy of current state of all ServletContextModel

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.model.elements

Fields in org.ops4j.pax.web.service.spi.model.elements with type parameters of type OsgiContextModel

Modifier and Type	Field and Description
protected List<OsgiContextModel>	ElementModel.contextModels List of osgi contexts with which given ElementModel is associated.

Methods in org.ops4j.pax.web.service.spi.model.elements that return types with arguments of type OsgiContextModel

Modifier and Type	Method and Description
List<OsgiContextModel>	ElementModel.getContextModels() Get unmodifiable list of osgi models with which given ElementModel should be associated during registration.

Methods in org.ops4j.pax.web.service.spi.model.elements with parameters of type OsgiContextModel

Modifier and Type	Method and Description
void	ElementModel.addContextModel(OsgiContextModel model) This method is used to add OsgiContextModel when an ElementModel is created for the first time (whether it's Whiteboard or HttpService scenario).
ServletModel.Builder	ServletModel.Builder.withOsgiContextModel(OsgiContextModel osgiContextModel)
FilterModel.Builder	FilterModel.Builder.withOsgiContextModel(OsgiContextModel osgiContextModel)

Method parameters in org.ops4j.pax.web.service.spi.model.elements with type arguments of type OsgiContextModel

Modifier and Type	Method and Description
void	ElementModel.changeContextModels(List<OsgiContextModel> models) This method replaces the models for existing when conditions change (when for example new OsgiContextModel is registered and element should be registered to it after it was already registered to other context matching the context selector).
ServletModel.Builder	ServletModel.Builder.withOsgiContextModels(Collection<OsgiContextModel> osgiContextModels)
FilterModel.Builder	FilterModel.Builder.withOsgiContextModels(Collection<OsgiContextModel> osgiContextModels)

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.model.events

Methods in org.ops4j.pax.web.service.spi.model.events with parameters of type OsgiContextModel

Modifier and Type	Method and Description
void	WebContextEventListener.wabContextRegistered(OsgiContextModel model) Notification about registration of WAB's OsgiContextModel
void	WebContextEventListener.wabContextUnregistered(OsgiContextModel model) Notification about unregistration of WAB's OsgiContextModel

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.model.info

Constructors in org.ops4j.pax.web.service.spi.model.info with parameters of type OsgiContextModel

Constructor and Description
WebApplicationInfo(OsgiContextModel ocm)
WebApplicationInfo(OsgiContextModel ocm, boolean replaced)
WebContextInfo(OsgiContextModel model)

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.model.views

Methods in org.ops4j.pax.web.service.spi.model.views that return OsgiContextModel

Modifier and Type	Method and Description
OsgiContextModel	WebAppWebContainerView.getOsgiContext(org.osgi.framework.Bundle wab, String contextPath) After WebAppWebContainerView.allocateContext(Bundle, String) has returned true, we can use this method to get the OsgiContextModel created by Pax Web Runtime for our WAB.

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.servlet

Methods in org.ops4j.pax.web.service.spi.servlet that return OsgiContextModel

Modifier and Type	Method and Description
OsgiContextModel	OsgiServletContext.getOsgiContextModel()
OsgiContextModel	OsgiScopedServletContext.getOsgiContextModel()
OsgiContextModel	OsgiDynamicServletContext.getOsgiContextModel()

Methods in org.ops4j.pax.web.service.spi.servlet with parameters of type OsgiContextModel

Modifier and Type	Method and Description
void	OsgiSessionAttributeListener.callSessionListeners(javax.servlet.http.HttpSession session, OsgiContextModel model, String name, Object value, Object old) Notification about attribute change in OsgiHttpSession
DynamicJEEWebContainerView	DynamicRegistrations.getContainer(OsgiContextModel osgiContextModel, Class<?> clazz) Gets a bundle-scoped instance of WebContainer for dynamic registration of servlets/filters/listeners in not-yet-started ServletContext

Constructors in org.ops4j.pax.web.service.spi.servlet with parameters of type OsgiContextModel

Constructor and Description
OsgiServletContext(javax.servlet.ServletContext containerServletContext, OsgiContextModel osgiContextModel, ServletContextModel servletContextModel, javax.servlet.SessionCookieConfig defaultSessionCookieConfig, ClassLoader loader) Constructor called when OsgiContextModel is passed to given ServerController.

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.servlet.dynamic

Constructors in org.ops4j.pax.web.service.spi.servlet.dynamic with parameters of type OsgiContextModel

Constructor and Description
DynamicEventListenerRegistration(EventListenerModel model, OsgiContextModel osgiContextModel)
DynamicFilterRegistration(FilterModel model, OsgiContextModel osgiContextModel, DynamicRegistrations regs)
DynamicServletRegistration(ServletModel model, OsgiContextModel osgiContextModel, ServletContextModel servletContextModel, DynamicRegistrations regs)

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.task

Methods in org.ops4j.pax.web.service.spi.task that return OsgiContextModel

Modifier and Type	Method and Description
OsgiContextModel	SecurityConfigChange.getOsgiContextModel()
OsgiContextModel	OsgiContextModelChange.getOsgiContextModel()
OsgiContextModel	MimeAndLocaleMappingChange.getOsgiContextModel()
OsgiContextModel	ContextStopChange.getOsgiContextModel()
OsgiContextModel	ContextStartChange.getOsgiContextModel()
OsgiContextModel	ContextParamsChange.getOsgiContextModel()
OsgiContextModel	ContextMetadataModelChange.getOsgiContextModel()

Methods in org.ops4j.pax.web.service.spi.task that return types with arguments of type OsgiContextModel

Modifier and Type	Method and Description
Map<String,TreeMap<ErrorPageModel,List<OsgiContextModel>>>	ErrorPageStateChange.getContextErrorPages()
Map<String,TreeMap<FilterModel,List<OsgiContextModel>>>	FilterStateChange.getContextFilters()
List<OsgiContextModel>	WelcomeFileModelChange.getContextModels()
List<OsgiContextModel>	WebSocketModelChange.getContextModels()
List<OsgiContextModel>	ServletModelChange.getContextModels()
List<OsgiContextModel>	FilterModelChange.getContextModels()
List<OsgiContextModel>	EventListenerModelChange.getContextModels()
List<OsgiContextModel>	ErrorPageModelChange.getContextModels()
List<OsgiContextModel>	ContainerInitializerModelChange.getContextModels()
List<OsgiContextModel>	ClearDynamicRegistrationsChange.getContextModels()
List<OsgiContextModel>	Change.getContextModels() Get a list of associated context models.
List<OsgiContextModel>	WelcomeFileModelChange.getNewModels()
List<OsgiContextModel>	WebSocketModelChange.getNewModels()
List<OsgiContextModel>	ServletModelChange.getNewModels()
List<OsgiContextModel>	FilterModelChange.getNewModels()
List<OsgiContextModel>	EventListenerModelChange.getNewModels()
List<OsgiContextModel>	ErrorPageModelChange.getNewModels()
List<OsgiContextModel>	ContainerInitializerModelChange.getNewModels()

Methods in org.ops4j.pax.web.service.spi.task with parameters of type OsgiContextModel

Modifier and Type	Method and Description
void	Batch.addContainerInitializerModel(ContainerInitializerModel model, OsgiContextModel... newModels) Add new ContainerInitializerModel
void	Batch.addErrorPageModel(ErrorPageModel model, OsgiContextModel... newModels) Add ErrorPageModel to ServerModel
void	Batch.addEventListenerModel(EventListenerModel model, OsgiContextModel... newModels) Add new EventListenerModel
void	Batch.addFilterModel(FilterModel model, OsgiContextModel... newModels) Add FilterModel to ServerModel
void	Batch.addOsgiContextModel(OsgiContextModel osgiContextModel, ServletContextModel servletContextModel) Add new OsgiContextModel
void	Batch.addServletModel(ServletModel model, OsgiContextModel... newModels) Add ServletModel to ServerModel
void	Batch.addWelcomeFileModel(WelcomeFileModel model, OsgiContextModel... newModels) Add new WelcomeFileModel
void	Batch.associateOsgiContextModel(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel osgiContextModel) Mark OsgiContextModel as associated with WebContainerContext
void	Batch.configureMetadata(ContextMetadataModel meta, OsgiContextModel ocm) Configure some meta information related to a context.
void	Batch.configureMimeAndEncodingMappings(Map<String,String> mimeMapping, Map<String,String> localeEncodingMapping, OsgiContextModel ocm) Configure extension - MIME mapping.
void	Batch.disassociateOsgiContextModel(org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel osgiContextModel) Mark OsgiContextModel as (temporarily) disassociated with WebContainerContext
void	Batch.removeOsgiContextModel(OsgiContextModel osgiContextModel) Remove existing OsgiContextModel

Method parameters in org.ops4j.pax.web.service.spi.task with type arguments of type OsgiContextModel

Modifier and Type	Method and Description
void	Batch.clearDynamicRegistrations(List<OsgiContextModel> contextModels) Operation that clears all dynamic registrations from the model and target context.
void	Batch.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	Batch.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.

Constructors in org.ops4j.pax.web.service.spi.task with parameters of type OsgiContextModel

Constructor and Description
ContainerInitializerModelChange(OpCode op, ContainerInitializerModel containerInitializerModel, OsgiContextModel... newModels)
ContextMetadataModelChange(OpCode kind, ContextMetadataModel meta, OsgiContextModel ocm)
ContextParamsChange(OpCode op, OsgiContextModel osgiContextModel, Map<String,String> params)
ContextStartChange(OpCode op, OsgiContextModel osgiContextModel)
ContextStopChange(OpCode op, OsgiContextModel osgiContextModel)
ErrorPageModelChange(OpCode op, ErrorPageModel filterModel, boolean disabled, OsgiContextModel... newModels)
ErrorPageModelChange(OpCode kind, ErrorPageModel model, OsgiContextModel... newModels)
EventListenerModelChange(OpCode op, EventListenerModel eventListenerModel, OsgiContextModel... newModels)
FilterModelChange(OpCode op, FilterModel filterModel, boolean disabled, OsgiContextModel... newModels)
FilterModelChange(OpCode op, FilterModel filterModel, OsgiContextModel... newModels)
MimeAndLocaleMappingChange(OpCode kind, Map<String,String> mimeMapping, Map<String,String> localeEncodingMapping, OsgiContextModel ocm)
OsgiContextModelChange(OpCode op, org.ops4j.pax.web.service.WebContainerContext context, OsgiContextModel osgiContextModel, ServletContextModel servletContextModel)
SecurityConfigChange(OpCode op, OsgiContextModel osgiContextModel, LoginConfigModel loginConfigModel, List<SecurityConstraintModel> securityConstraints, List<String> securityRoles)
ServletModelChange(OpCode op, ServletModel servletModel, boolean disabled, OsgiContextModel... newModels)
ServletModelChange(OpCode op, ServletModel servletModel, OsgiContextModel... newModels)
WebSocketModelChange(OpCode op, WebSocketModel wsModel, boolean disabled, OsgiContextModel... newModels)
WebSocketModelChange(OpCode op, WebSocketModel wsModel, OsgiContextModel... newModels)
WelcomeFileModelChange(OpCode op, WelcomeFileModel model, OsgiContextModel... newModels)

Constructor parameters in org.ops4j.pax.web.service.spi.task with type arguments of type OsgiContextModel

Constructor and Description
ClearDynamicRegistrationsChange(OpCode op, List<OsgiContextModel> osgiContextModels)
ErrorPageStateChange(Map<String,TreeMap<ErrorPageModel,List<OsgiContextModel>>> contextErrorPages)
FilterStateChange(Map<String,TreeMap<FilterModel,List<OsgiContextModel>>> contextFilters, boolean dynamic)

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.util

Methods in org.ops4j.pax.web.service.spi.util that return OsgiContextModel

Modifier and Type	Method and Description
static OsgiContextModel	Utils.getHighestRankedModel(Set<OsgiContextModel> rankedSet) Gets first OsgiContextModel from ranked set or null if not available.

Method parameters in org.ops4j.pax.web.service.spi.util with type arguments of type OsgiContextModel

Modifier and Type	Method and Description
static OsgiContextModel	Utils.getHighestRankedModel(Set<OsgiContextModel> rankedSet) Gets first OsgiContextModel from ranked set or null if not available.

Uses of OsgiContextModel in org.ops4j.pax.web.service.spi.whiteboard

Methods in org.ops4j.pax.web.service.spi.whiteboard that return types with arguments of type OsgiContextModel

Modifier and Type	Method and Description
List<OsgiContextModel>	WhiteboardWebContainerView.getOsgiContextModels(org.osgi.framework.Bundle bundle) Returns all the contexts (customized to unified OsgiContextModel internal representation) managed at Http Service level.

Methods in org.ops4j.pax.web.service.spi.whiteboard with parameters of type OsgiContextModel

Modifier and Type	Method and Description
void	WhiteboardWebContainerView.addWhiteboardOsgiContextModel(OsgiContextModel model) Passes Whiteboard-registered (customized) OsgiContextModel to be managed in WebContainer.
void	WhiteboardWebContainerView.clearFailedDTOInformation(OsgiContextModel webContext) Sned information that given OsgiContextModel is no longer Whiteboard-tracked, so possible failure DTOs have to be cleared
void	WhiteboardWebContainerView.failedDTOInformation(OsgiContextModel webContext) Send information about failure DTO related to given OsgiContextModel.
void	WhiteboardWebContainerView.removeWhiteboardOsgiContextModel(OsgiContextModel model) Removes Whiteboard-registered (customized) OsgiContextModel from WebContainer, which may then switch to using "default" HttpContext