Package 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.

See: Description

Interface Summary

Interface	Description
ContainerInitializerModelAware	Specialized interface to communicate with ServletContainerInitializer instances which should be aware of ContainerInitializerModel.

Class Summary

Class	Description
ContainerInitializerModel	Model for ServletContainerInitializer.
ElementModel<T,D extends WebElementEventData>	Base class for all models representing actual elements of a web application (or context), the most obvious model is representing Servlet.
ErrorPageModel
EventListenerKey
EventListenerModel
FilterModel	Set of parameters describing everything that's required to register a Filter.
FilterModel.Builder
FilterModel.DynamicMapping
FilterModel.Mapping
JspConfigurationModel	Set of parameters to configure JSP parameters, referenced from OsgiContextModel.
JspModel
LoginConfigModel	Set of parameters for login configuration parameters, referenced from OsgiContextModel.
SecurityConfigurationModel	Single configuration class for 3 top-level elements of web.xml: <login-config> (1 per context): org.eclipse.jetty.security.SecurityHandler#setRealmName() + few others org.apache.catalina.Context#setLoginConfig() io.undertow.servlet.api.DeploymentInfo#setLoginConfig() <security-constraint> (N per context): org.eclipse.jetty.security.ConstraintAware#addConstraintMapping() org.apache.catalina.Context#addConstraint() io.undertow.servlet.api.DeploymentInfo#addSecurityConstraint() <security-role> (N per context): org.eclipse.jetty.security.ConstraintSecurityHandler#setRoles() org.apache.catalina.Context#addSecurityRole() io.undertow.servlet.api.DeploymentInfo#addSecurityRole()
SecurityConstraintModel	Passive web element representing <security-constraint> element of web.xml.
SecurityConstraintModel.WebResourceCollection	A collection of constrained collection of URIs - <web-resource-collection> elements from web.xml
ServletModel	Set of parameters describing everything that's required to register a Servlet.
ServletModel.Builder
SessionConfigurationModel	Set of parameters configuring HTTP Sessions, referenced from OsgiContextModel.
WebSocketModel	Set of parameters describing everything that's required to register a WebSocket endpoint according to JSR-356.
WelcomeFileModel

Package org.ops4j.pax.web.service.spi.model.elements Description

Model subpackage representing actual web elements, while infrastructure elements (like contexts) are kept in the package above.

Web elements may be divided into two groups:

• active web elements (the ones that can handle requests): servlets, filters, resources, jsps and websockets (I guess).
• passive web elements (the ones that play support role): connectors/virtual hosts, constraint mappings, context params, error pages, event listeners, jsp configurations, login configs, servlet container initializers, session cookie configs, session timeouts and welcome files.

This division is simple - only registration of active elements will ensure that the physical context is actually started. This is important when user wants to register configurations and e.g., context listeners.

Welcome files may be confusing, but these (themselves) do NOT serve any content - these are used by resources (resource servlets) to adjust their behavior.

And finally, some passive web elements are used to configure OsgiContextModel and they don't extend ElementModel - which means they are not called to register themselves. Instead they just configure certain fields of the OSGi context model. These include session and login configuration.