Interface PaxWebConstants
-
public interface PaxWebConstants
Different constants used across Pax Web but not related to configuration that may be specified using
org.ops4j.pax.web
PID or system/bundle context properties. For configuration related constants, seePaxWebConfig
.Constants names use the following prefixes:
SERVICE_PROPERTY_
- for names of OSGi service registration propertiesINIT_PARAM_
- for legacy init parameters passed toHttpService
registration methods that are handled in special way by Pax Web.CONTEXT_PARAM_
- forServletContext
attributes set by Pax Web.DEFAULT_
- for miscellaneous default values (default VHost, default name, default context, ...
- Since:
- 0.3.0, December 27, 2007
- Author:
- Alin Dreghiciu
-
-
Field Summary
Fields Modifier and Type Field Description static String
CONTEXT_PARAM_BUNDLE_CONTEXT
Servlet context attribute containing the bundle context of the bundle registering the http context according to 128.6.1 "Bundle Context Access" chapter of OSGi CMPN 128 "Web Applications Specification"static String
CONTEXT_PARAM_PAX_WEB_FACELETS_LIBRARIES
According to "11.1.3 Application Configuration Parameters" of JSF 2.3 specification,javax.faces.FACELETS_LIBRARIES
is a list of resource names relative to context root.static String
CONTEXT_PARAM_SPRING_BUNDLE_CONTEXT
For legacy Spring-DM support,BundleContext
should be available under this paramstatic String
DEFAULT_CONTEXT_NAME
Default name for context (e.g.,ServletContextHelper
)static String
DEFAULT_CONTEXT_PATH
Defaultcontext path
static String
DEFAULT_INIT_PREFIX_PROP
Deprecated.servlet.init./filter.init./context.init.
should be used instead - seeHttpWhiteboardConstants
.static String
DEFAULT_JSP_SCI_CLASS
The only supportedServletContainerInitializer
class that configures JSP enginestatic String
DEFAULT_JSP_SERVLET_CLASS
The only supported JSP servlet class namestatic String
DEFAULT_JSP_SERVLET_NAME
Default (not overrideable) JSP servlet namestatic String
DEFAULT_PAX_WEB_JSP_SYMBOLIC_NAME
Symbolic Name of pax-web-jsp bundlestatic Integer
DEFAULT_SESSION_TIMEOUT
Default session timeoutstatic String
DEFAULT_SHARED_CONTEXT_NAME
Name for default shared contexts - Pax Web specificstatic String
DEFAULT_VIRTUAL_HOST_NAME
Default name for virtual hoststatic String
DEFAULT_WEBSOCKET_JETTY_SCI_CLASS
The only supportedServletContainerInitializer
class that configures WebSocket container for Jettystatic String
DEFAULT_WEBSOCKET_SCI_CLASS
The only supportedServletContainerInitializer
for generic configuration of WebSocket containerstatic String
DEFAULT_WEBSOCKET_TOMCAT_SCI_CLASS
The only supportedServletContainerInitializer
class that configures WebSocket container for Tomcatstatic String
DEFAULT_WEBSOCKET_UNDERTOW_SCI_CLASS
The only supportedServletContainerInitializer
class that configures WebSocket container for Undertowstatic String
HEADER_CONNECTORS
Pax Web specific manifest header of the WAB to specify matching connector names/ids for given context/WABstatic String
HEADER_CONTEXT_PATH
Manifest header key for web application bundles according to 128.3.1 WAB Definition.static String
HEADER_VIRTUAL_HOSTS
Pax Web specific manifest header of the WAB to specify matching virtual hosts for given context/WAB.static String[]
HTTPSERVICE_REGISTRATION_NAMES
Actual OSGi Http Service will be registered under theseobjectClass
names.static String
INIT_PARAM_FILTER_MAPPING_DISPATCHER
Deprecated.static String
INIT_PARAM_FILTER_NAME
Deprecated.static String
INIT_PARAM_SERVLET_NAME
Deprecated.static String
PID
Service PID used for configuration.static String
SERVICE_PROPERTY_ASYNC_SUPPORTED
Deprecated.static String
SERVICE_PROPERTY_CONNECTORS
Improved name for the service registration property to configure connectors of the context (ServletContextHelper
,HttpContext
, etc.).static String
SERVICE_PROPERTY_CONNECTORS_LEGACY
Deprecated.static String
SERVICE_PROPERTY_HTTP_CONTEXT_ID
Deprecated.UseHttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME
static String
SERVICE_PROPERTY_HTTP_CONTEXT_PATH
Deprecated.UseHttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_PATH
static String
SERVICE_PROPERTY_HTTP_CONTEXT_SHARED
Deprecated.UserServletContextHelper
services which are "shared" by defaultstatic String
SERVICE_PROPERTY_INIT_PREFIX
Deprecated.static String
SERVICE_PROPERTY_INTERNAL
Service registration property to mark services as internal, so they're not processed by Pax Web Whiteboard extender as normal Whiteboard services.static String
SERVICE_PROPERTY_LOAD_ON_STARTUP
Deprecated.static String
SERVICE_PROPERTY_SERVLET_ALIAS
Deprecated.static String
SERVICE_PROPERTY_SERVLET_NAMES
Deprecated.static String
SERVICE_PROPERTY_URL_PATTERNS
Deprecated.static String
SERVICE_PROPERTY_VIRTUAL_HOSTS
Improved name for the service registration property to configure virtual hosts of the context (ServletContextHelper
,HttpContext
, etc.).static String
SERVICE_PROPERTY_VIRTUAL_HOSTS_LEGACY
Deprecated.static String
SERVICE_PROPERTY_WEB_SERVLETCONTEXT_NAME
Context name of the WAB bundle or bundle registering OSGi servlet context (Pax Web addition)static String
SERVICE_PROPERTY_WEB_SERVLETCONTEXT_PATH
Context path of the WAB bundle or bundle registering OSGi servlet contextstatic String
SERVICE_PROPERTY_WEB_SYMBOLIC_NAME
Symbolic name of the WAB bundle or bundle registering OSGi servlet contextstatic String
SERVICE_PROPERTY_WEB_VERSION
Version of the WAB bundle or bundle registering OSGi servlet contextstatic String
SERVICE_PROPERTY_WEBSOCKET
Service registration property indication WebSocket registration.static String
SERVICE_PROPERTY_WEBSOCKET_LEGACY
Deprecated.
-
-
-
Field Detail
-
PID
static final String PID
Service PID used for configuration.- See Also:
- Constant Field Values
-
HTTPSERVICE_REGISTRATION_NAMES
static final String[] HTTPSERVICE_REGISTRATION_NAMES
Actual OSGi Http Service will be registered under theseobjectClass
names.
-
DEFAULT_CONTEXT_NAME
static final String DEFAULT_CONTEXT_NAME
Default name for context (e.g.,ServletContextHelper
)- See Also:
- Constant Field Values
-
DEFAULT_SHARED_CONTEXT_NAME
static final String DEFAULT_SHARED_CONTEXT_NAME
Name for default shared contexts - Pax Web specific- See Also:
- Constant Field Values
-
DEFAULT_VIRTUAL_HOST_NAME
static final String DEFAULT_VIRTUAL_HOST_NAME
Default name for virtual host- See Also:
- Constant Field Values
-
DEFAULT_JSP_SERVLET_NAME
static final String DEFAULT_JSP_SERVLET_NAME
Default (not overrideable) JSP servlet name- See Also:
- Constant Field Values
-
DEFAULT_JSP_SERVLET_CLASS
static final String DEFAULT_JSP_SERVLET_CLASS
The only supported JSP servlet class name- See Also:
- Constant Field Values
-
DEFAULT_JSP_SCI_CLASS
static final String DEFAULT_JSP_SCI_CLASS
The only supportedServletContainerInitializer
class that configures JSP engine- See Also:
- Constant Field Values
-
DEFAULT_WEBSOCKET_JETTY_SCI_CLASS
static final String DEFAULT_WEBSOCKET_JETTY_SCI_CLASS
The only supportedServletContainerInitializer
class that configures WebSocket container for Jetty- See Also:
- Constant Field Values
-
DEFAULT_WEBSOCKET_TOMCAT_SCI_CLASS
static final String DEFAULT_WEBSOCKET_TOMCAT_SCI_CLASS
The only supportedServletContainerInitializer
class that configures WebSocket container for Tomcat- See Also:
- Constant Field Values
-
DEFAULT_WEBSOCKET_UNDERTOW_SCI_CLASS
static final String DEFAULT_WEBSOCKET_UNDERTOW_SCI_CLASS
The only supportedServletContainerInitializer
class that configures WebSocket container for Undertow- See Also:
- Constant Field Values
-
DEFAULT_WEBSOCKET_SCI_CLASS
static final String DEFAULT_WEBSOCKET_SCI_CLASS
The only supportedServletContainerInitializer
for generic configuration of WebSocket container- See Also:
- Constant Field Values
-
DEFAULT_CONTEXT_PATH
static final String DEFAULT_CONTEXT_PATH
Defaultcontext path
- See Also:
- Constant Field Values
-
DEFAULT_SESSION_TIMEOUT
static final Integer DEFAULT_SESSION_TIMEOUT
Default session timeout
-
DEFAULT_PAX_WEB_JSP_SYMBOLIC_NAME
static final String DEFAULT_PAX_WEB_JSP_SYMBOLIC_NAME
Symbolic Name of pax-web-jsp bundle- See Also:
- Constant Field Values
-
HEADER_CONTEXT_PATH
static final String HEADER_CONTEXT_PATH
Manifest header key for web application bundles according to 128.3.1 WAB Definition.- See Also:
- Constant Field Values
-
HEADER_VIRTUAL_HOSTS
static final String HEADER_VIRTUAL_HOSTS
Pax Web specific manifest header of the WAB to specify matching virtual hosts for given context/WAB. To handle Jetty-specifichosst@connector
syntax, a slash has to be used instead of at-sign.- See Also:
- Constant Field Values
-
HEADER_CONNECTORS
static final String HEADER_CONNECTORS
Pax Web specific manifest header of the WAB to specify matching connector names/ids for given context/WAB- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_INTERNAL
static final String SERVICE_PROPERTY_INTERNAL
Service registration property to mark services as internal, so they're not processed by Pax Web Whiteboard extender as normal Whiteboard services.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_WEBSOCKET
static final String SERVICE_PROPERTY_WEBSOCKET
Service registration property indication WebSocket registration. Named afterHttpWhiteboardConstants.HTTP_WHITEBOARD_LISTENER
- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_WEBSOCKET_LEGACY
@Deprecated static final String SERVICE_PROPERTY_WEBSOCKET_LEGACY
Deprecated.Legacy service registration property indication WebSocket registration.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_VIRTUAL_HOSTS_LEGACY
@Deprecated static final String SERVICE_PROPERTY_VIRTUAL_HOSTS_LEGACY
Deprecated.Pax Web specific service property used when registering:
ServletContextHelperMapping
HttpContextMapping
ServletContextHelper
HttpContext
ContextMapping.getVirtualHosts()
takes precedence).The value should be String, array of Strings or Collection of Strings. When missing, context is assumed to be associated with all virtual hosts.
- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_VIRTUAL_HOSTS
static final String SERVICE_PROPERTY_VIRTUAL_HOSTS
Improved name for the service registration property to configure virtual hosts of the context (
ServletContextHelper
,HttpContext
, etc.).See http://www.eclipse.org/jetty/documentation/jetty-9/index.html#configuring-virtual-hosts
- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_CONNECTORS_LEGACY
@Deprecated static final String SERVICE_PROPERTY_CONNECTORS_LEGACY
Deprecated.Pax Web specific service property used when registering:
ServletContextHelperMapping
HttpContextMapping
ServletContextHelper
HttpContext
ContextMapping.getConnectors()
takes precedence).The value should be String, array of Strings or Collection of Strings. When missing, context is assumed to be accessible through all connectors.
- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_CONNECTORS
static final String SERVICE_PROPERTY_CONNECTORS
Improved name for the service registration property to configure connectors of the context (
ServletContextHelper
,HttpContext
, etc.).See http://www.eclipse.org/jetty/documentation/jetty-9/index.html#configuring-virtual-hosts
- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_HTTP_CONTEXT_ID
@Deprecated static final String SERVICE_PROPERTY_HTTP_CONTEXT_ID
Deprecated.UseHttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME
Legacy service property for context ID.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_HTTP_CONTEXT_SHARED
@Deprecated static final String SERVICE_PROPERTY_HTTP_CONTEXT_SHARED
Deprecated.UserServletContextHelper
services which are "shared" by defaultLegacy property name for a legacy "shared" flag forHttpContext
services.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_HTTP_CONTEXT_PATH
@Deprecated static final String SERVICE_PROPERTY_HTTP_CONTEXT_PATH
Deprecated.UseHttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_PATH
Legacy context path.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_SERVLET_ALIAS
@Deprecated static final String SERVICE_PROPERTY_SERVLET_ALIAS
Deprecated.The legacy registration property for the alias to be used by a servlet/resource registration.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_URL_PATTERNS
@Deprecated static final String SERVICE_PROPERTY_URL_PATTERNS
Deprecated.The legacy registration property for the url patterns to be used by a filter registration.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_SERVLET_NAMES
@Deprecated static final String SERVICE_PROPERTY_SERVLET_NAMES
Deprecated.The legacy registration property for the servlet names to be used by a filter registration.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_ASYNC_SUPPORTED
@Deprecated static final String SERVICE_PROPERTY_ASYNC_SUPPORTED
Deprecated.Legacy registration property for<async-supported>
configuration- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_LOAD_ON_STARTUP
@Deprecated static final String SERVICE_PROPERTY_LOAD_ON_STARTUP
Deprecated.Legacy registration property for<load-on-startup>
configuration- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_INIT_PREFIX
@Deprecated static final String SERVICE_PROPERTY_INIT_PREFIX
Deprecated.The registration property for filtering init parameters. All init parameters starting with something different then the init-prefix will be ignored and not added to the init params of the servlet/filter/context.- See Also:
- Constant Field Values
-
DEFAULT_INIT_PREFIX_PROP
@Deprecated static final String DEFAULT_INIT_PREFIX_PROP
Deprecated.servlet.init./filter.init./context.init.
should be used instead - seeHttpWhiteboardConstants
.The default init-prefix.- See Also:
- Constant Field Values
-
INIT_PARAM_SERVLET_NAME
@Deprecated static final String INIT_PARAM_SERVLET_NAME
Deprecated.Init parameter that can be used to specify servlet name.
WebContainer
provides registration methods, where servlet name can be specified directly. Also according to Http Service and Whiteboard Service specifications, servlet name defaults to FQCN of the servlet.- See Also:
- Constant Field Values
-
INIT_PARAM_FILTER_NAME
@Deprecated static final String INIT_PARAM_FILTER_NAME
Deprecated.Init parameter that can be used to specify filter name.
WebContainer
provides registration methods, where filter name can be specified directly. Also according to Http Service and Whiteboard Service specifications, filter name defaults to FQCN of the servlet.- See Also:
- Constant Field Values
-
INIT_PARAM_FILTER_MAPPING_DISPATCHER
@Deprecated static final String INIT_PARAM_FILTER_MAPPING_DISPATCHER
Deprecated.Filter init param name for specifying a filter-mapping dispatch behaviour Must be a comma delimited string of:DispatcherType.REQUEST
DispatcherType.FORWARD
DispatcherType.INCLUDE
DispatcherType.ERROR
DispatcherType.ASYNC
values are not case sensitive.
- See Also:
- Constant Field Values
-
CONTEXT_PARAM_BUNDLE_CONTEXT
static final String CONTEXT_PARAM_BUNDLE_CONTEXT
Servlet context attribute containing the bundle context of the bundle registering the http context according to 128.6.1 "Bundle Context Access" chapter of OSGi CMPN 128 "Web Applications Specification"- See Also:
- Constant Field Values
-
CONTEXT_PARAM_SPRING_BUNDLE_CONTEXT
static final String CONTEXT_PARAM_SPRING_BUNDLE_CONTEXT
For legacy Spring-DM support,BundleContext
should be available under this param- See Also:
- Constant Field Values
-
CONTEXT_PARAM_PAX_WEB_FACELETS_LIBRARIES
static final String CONTEXT_PARAM_PAX_WEB_FACELETS_LIBRARIES
According to "11.1.3 Application Configuration Parameters" of JSF 2.3 specification,
javax.faces.FACELETS_LIBRARIES
is a list of resource names relative to context root. This is not supposed to find resources in embedded JARs, but there's no other easy way to let MyFaces find such taglib resources in Pax Web.Normally,
org.apache.myfaces.view.facelets.util.Classpath#_searchResource()
assumes that the URL isJarURLConnection
when doing recursive search and does a special GAE check. Nothing that could help us provide nice OSGi-aware discovery mechanism. That's why this context parameter will provide specialMap
that can be used when searching for FACELET resources.- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_WEB_SYMBOLIC_NAME
static final String SERVICE_PROPERTY_WEB_SYMBOLIC_NAME
Symbolic name of the WAB bundle or bundle registering OSGi servlet context- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_WEB_VERSION
static final String SERVICE_PROPERTY_WEB_VERSION
Version of the WAB bundle or bundle registering OSGi servlet context- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_WEB_SERVLETCONTEXT_PATH
static final String SERVICE_PROPERTY_WEB_SERVLETCONTEXT_PATH
Context path of the WAB bundle or bundle registering OSGi servlet context- See Also:
- Constant Field Values
-
SERVICE_PROPERTY_WEB_SERVLETCONTEXT_NAME
static final String SERVICE_PROPERTY_WEB_SERVLETCONTEXT_NAME
Context name of the WAB bundle or bundle registering OSGi servlet context (Pax Web addition)- See Also:
- Constant Field Values
-
-