public final class HttpWhiteboardConstants extends Object
Modifier and Type | Field and Description |
---|---|
static String |
DISPATCHER_ASYNC
Possible value for the
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied in the asynchronous
context. |
static String |
DISPATCHER_ERROR
Possible value for the
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied when an error page is
called. |
static String |
DISPATCHER_FORWARD
Possible value for the
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied to forward calls to the
dispatcher. |
static String |
DISPATCHER_INCLUDE
Possible value for the
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied to include calls to the
dispatcher. |
static String |
DISPATCHER_REQUEST
Possible value for the
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied to client requests. |
static String |
HTTP_SERVICE_CONTEXT_FILTER
If a servlet filter, error page or listener wants to be registered with
the Http Context(s) managed by the Http Service, they can select the
contexts having the
HTTP_SERVICE_CONTEXT_PROPERTY property using
this filter. |
static String |
HTTP_SERVICE_CONTEXT_PROPERTY
If a servlet filter, error page or listener wants to be registered with
the Http Context(s) managed by the Http Service, they can select the
contexts having this property.
|
static String |
HTTP_WHITEBOARD_CONTEXT_INIT_PARAM_PREFIX
Service property prefix referencing a
ServletContextHelper
service. |
static String |
HTTP_WHITEBOARD_CONTEXT_NAME
Service property specifying the name of an
ServletContextHelper
service. |
static String |
HTTP_WHITEBOARD_CONTEXT_PATH
Service property specifying the path of an
ServletContextHelper
service. |
static String |
HTTP_WHITEBOARD_CONTEXT_SELECT
Service property referencing a
ServletContextHelper service. |
static String |
HTTP_WHITEBOARD_DEFAULT_CONTEXT_NAME
The name of the default
ServletContextHelper . |
static String |
HTTP_WHITEBOARD_FILTER_ASYNC_SUPPORTED
Service property specifying whether a servlet
Filter service
supports asynchronous processing. |
static String |
HTTP_WHITEBOARD_FILTER_DISPATCHER
Service property specifying the dispatcher handling of a servlet
Filter . |
static String |
HTTP_WHITEBOARD_FILTER_INIT_PARAM_PREFIX
Service property prefix referencing a
Filter service. |
static String |
HTTP_WHITEBOARD_FILTER_NAME
Service property specifying the servlet filter name of a
Filter
service. |
static String |
HTTP_WHITEBOARD_FILTER_PATTERN
Service property specifying the request mappings for a
Filter
service. |
static String |
HTTP_WHITEBOARD_FILTER_REGEX
Service property specifying the request mappings for a servlet
Filter service. |
static String |
HTTP_WHITEBOARD_FILTER_SERVLET
Service property specifying the
servlet names for a servlet Filter service. |
static String |
HTTP_WHITEBOARD_IMPLEMENTATION
The name of the implementation capability for the Http Whiteboard
specification
|
static String |
HTTP_WHITEBOARD_LISTENER
Service property to mark a Listener service as a Whiteboard service.
|
static String |
HTTP_WHITEBOARD_PREPROCESSOR_INIT_PARAM_PREFIX
Service property prefix referencing a
Preprocessor service. |
static String |
HTTP_WHITEBOARD_RESOURCE_PATTERN
Service property specifying the request mappings for resources.
|
static String |
HTTP_WHITEBOARD_RESOURCE_PREFIX
Service property specifying the resource entry prefix for a resource
service.
|
static String |
HTTP_WHITEBOARD_SERVLET_ASYNC_SUPPORTED
Service property specifying whether a
Servlet service supports
asynchronous processing. |
static String |
HTTP_WHITEBOARD_SERVLET_ERROR_PAGE
Service property specifying whether a
Servlet service acts as an
error page. |
static String |
HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
Service property prefix referencing a
Servlet service. |
static String |
HTTP_WHITEBOARD_SERVLET_MULTIPART_ENABLED
Service property specifying whether a
Servlet service has enabled
multipart request processing. |
static String |
HTTP_WHITEBOARD_SERVLET_MULTIPART_FILESIZETHRESHOLD
Service property specifying the size threshold after which the file will
be written to disk.
|
static String |
HTTP_WHITEBOARD_SERVLET_MULTIPART_LOCATION
Service property specifying the location where the files can be stored on
disk.
|
static String |
HTTP_WHITEBOARD_SERVLET_MULTIPART_MAXFILESIZE
Service property specifying the maximum size of a file being uploaded.
|
static String |
HTTP_WHITEBOARD_SERVLET_MULTIPART_MAXREQUESTSIZE
Service property specifying the maximum request size.
|
static String |
HTTP_WHITEBOARD_SERVLET_NAME
Service property specifying the servlet name of a
Servlet
service. |
static String |
HTTP_WHITEBOARD_SERVLET_PATTERN
Service property specifying the request mappings for a
Servlet
service. |
static String |
HTTP_WHITEBOARD_SPECIFICATION_VERSION
The version of the implementation capability for the Http Whiteboard
specification
|
static String |
HTTP_WHITEBOARD_TARGET
Service property specifying the target filter to select the Http
Whiteboard implementation to process the service.
|
public static final String HTTP_WHITEBOARD_CONTEXT_NAME
ServletContextHelper
service.
For ServletContextHelper
services, this service property must be
specified. Context services without this service property are ignored.
Servlet, listener, servlet filter, and resource services might refer to a
specific ServletContextHelper
service referencing the name with
the HTTP_WHITEBOARD_CONTEXT_SELECT
property.
For ServletContextHelper
services, the value of this service
property must be of type String
. The value must follow the
"symbolic-name" specification from Section 1.3.2 of the OSGi Core
Specification.
public static final String HTTP_WHITEBOARD_DEFAULT_CONTEXT_NAME
ServletContextHelper
. If a service is
registered with this property, it is overriding the default context with
a custom provided context.public static final String HTTP_WHITEBOARD_CONTEXT_PATH
ServletContextHelper
service.
For ServletContextHelper
services this service property is
required. Context services without this service property are ignored.
This property defines a context path under which all whiteboard services associated with this context are registered. Having different contexts with different paths allows to separate the URL space.
For ServletContextHelper
services, the value of this service
property must be of type String
. The value is either a slash for
the root or it must start with a slash but not end with a slash. Valid
characters are defined in rfc3986#section-3.3. Contexts with an invalid
path are ignored.
public static final String HTTP_WHITEBOARD_CONTEXT_INIT_PARAM_PREFIX
ServletContextHelper
service.
For ServletContextHelper
services this prefix can be used for
service properties to mark them as initialization parameters which can be
retrieved from the associated servlet context. The prefix is removed from
the service property name to build the initialization parameter name.
For ServletContextHelper
services, the value of each
initialization parameter service property must be of type String
.
public static final String HTTP_WHITEBOARD_CONTEXT_SELECT
ServletContextHelper
service.
For servlet, listener, servlet filter, or resource services, this service
property refers to the associated ServletContextHelper
service.
The value of this property is a filter expression which is matched
against the service registration properties of the
ServletContextHelper
service. If this service property is not
specified, the default context is used. If there is no context service
matching, the servlet, listener, servlet filter, or resource service is
ignored.
For example, if a whiteboard service wants to select a servlet context helper with the name "Admin" the expression would be "(osgi.http.whiteboard.context.name=Admin)". Selecting all contexts could be done with "(osgi.http.whiteboard.context.name=*)".
For servlet, listener, servlet filter, or resource services, the value of
this service property must be of type String
.
public static final String HTTP_WHITEBOARD_SERVLET_NAME
Servlet
service.
The servlet is registered with this name and the name can be used as a reference to the servlet for filtering or request dispatching.
This name is in addition used as the value for the
ServletConfig.getServletName()
method. If this service property
is not specified, the fully qualified name of the service object's class
is used as the servlet name. Filter services may refer to servlets by
this name in their HTTP_WHITEBOARD_FILTER_SERVLET
service
property to apply the filter to the servlet.
Servlet names should be unique among all servlet services associated with
a single ServletContextHelper
.
The value of this service property must be of type String
.
public static final String HTTP_WHITEBOARD_SERVLET_PATTERN
Servlet
service.
The specified patterns are used to determine whether a request should be
mapped to the servlet. Servlet services without this service property,
HTTP_WHITEBOARD_SERVLET_ERROR_PAGE
or
HTTP_WHITEBOARD_SERVLET_NAME
are ignored.
The value of this service property must be of type String
,
String[]
, or Collection<String>
.
public static final String HTTP_WHITEBOARD_SERVLET_ERROR_PAGE
Servlet
service acts as an
error page.
The service property values may be the name of a fully qualified exception class, a three digit HTTP status code, the value "4xx" for all error codes in the 400 range, or the value "5xx" for all error codes in the 500 range. Any value that is not a three digit number, or one of the two special values is considered to be the name of a fully qualified exception class.
The value of this service property must be of type String
,
String[]
, or Collection<String>
.
public static final String HTTP_WHITEBOARD_SERVLET_ASYNC_SUPPORTED
Servlet
service supports
asynchronous processing.
By default servlet services do not support asynchronous processing.
The value of this service property must be of type Boolean
.
public static final String HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX
Servlet
service.
For Servlet
services this prefix can be used for service
properties to mark them as initialization parameters which can be
retrieved from the associated servlet config. The prefix is removed from
the service property name to build the initialization parameter name.
For Servlet
services, the value of each initialization parameter
service property must be of type String
.
public static final String HTTP_WHITEBOARD_SERVLET_MULTIPART_ENABLED
Servlet
service has enabled
multipart request processing.
By default servlet services do not have multipart request processing enabled.
The value of this service property must be of type Boolean
.
public static final String HTTP_WHITEBOARD_SERVLET_MULTIPART_FILESIZETHRESHOLD
When not set or when the value is not valid, the default threshold is
determined by the implementation. This property is only evaluated if
HTTP_WHITEBOARD_SERVLET_MULTIPART_ENABLED
is set to true
.
The value of this service property must be of type Integer
.
public static final String HTTP_WHITEBOARD_SERVLET_MULTIPART_LOCATION
When not set the default location is defined by the value of the system
property "java.io.tmpdir". This property is only evaluated if
HTTP_WHITEBOARD_SERVLET_MULTIPART_ENABLED
is set to true
.
The value of this service property must be of type String
.
public static final String HTTP_WHITEBOARD_SERVLET_MULTIPART_MAXFILESIZE
When not set or when the value is not valid, the default maximum size is
[@code -1} (no maximum size). This property is only evaluated if
HTTP_WHITEBOARD_SERVLET_MULTIPART_ENABLED
is set to true
.
The value of this service property must be of type Long
.
public static final String HTTP_WHITEBOARD_SERVLET_MULTIPART_MAXREQUESTSIZE
When not set or when the value is not valid, the default maximum request
size is -1
(no maximum size). This property is only evaluated if
HTTP_WHITEBOARD_SERVLET_MULTIPART_ENABLED
is set to true
.
The value of this service property must be of type Long
.
public static final String HTTP_WHITEBOARD_FILTER_NAME
Filter
service.
This name is used as the value for the
FilterConfig.getFilterName()
method. If this service property is
not specified, the fully qualified name of the service object's class is
used as the servlet filter name.
Servlet filter names should be unique among all servlet filter services
associated with a single ServletContextHelper
.
The value of this service property must be of type String
.
public static final String HTTP_WHITEBOARD_FILTER_PATTERN
Filter
service.
The specified patterns are used to determine whether a request should be
mapped to the servlet filter. Filter services without this service
property or the HTTP_WHITEBOARD_FILTER_SERVLET
or the
HTTP_WHITEBOARD_FILTER_REGEX
service property are ignored.
The value of this service property must be of type String
,
String[]
, or Collection<String>
.
public static final String HTTP_WHITEBOARD_FILTER_SERVLET
servlet names
for a servlet Filter
service.
The specified names are used to determine the servlets whose requests
should be mapped to the servlet filter. Servlet filter services without
this service property or the HTTP_WHITEBOARD_FILTER_PATTERN
or
the HTTP_WHITEBOARD_FILTER_REGEX
service property are ignored.
The value of this service property must be of type String
,
String[]
, or Collection<String>
.
public static final String HTTP_WHITEBOARD_FILTER_REGEX
Filter
service.
The specified regular expressions are used to determine whether a request
should be mapped to the servlet filter. The regular expressions must
follow the syntax defined in java.util.regex.Pattern
. Servlet
filter services without this service property or the
HTTP_WHITEBOARD_FILTER_SERVLET
or the
HTTP_WHITEBOARD_FILTER_PATTERN
service property are ignored.
The value of this service property must be of type String
,
String[]
, or Collection<String>
.
public static final String HTTP_WHITEBOARD_FILTER_ASYNC_SUPPORTED
Filter
service
supports asynchronous processing.
By default servlet filters services do not support asynchronous processing.
The value of this service property must be of type Boolean
.
public static final String HTTP_WHITEBOARD_FILTER_DISPATCHER
Filter
.
By default servlet filter services are associated with client requests
only (see value DISPATCHER_REQUEST
).
The value of this service property must be of type String
,
String[]
, or Collection<String>
. Allowed values are
DISPATCHER_ASYNC
, DISPATCHER_ERROR
,
DISPATCHER_FORWARD
, DISPATCHER_INCLUDE
,
DISPATCHER_REQUEST
.
public static final String HTTP_WHITEBOARD_FILTER_INIT_PARAM_PREFIX
Filter
service.
For Filter
services this prefix can be used for service
properties to mark them as initialization parameters which can be
retrieved from the associated filter config. The prefix is removed from
the service property name to build the initialization parameter name.
For Filter
services, the value of each initialization parameter
service property must be of type String
.
public static final String HTTP_WHITEBOARD_PREPROCESSOR_INIT_PARAM_PREFIX
Preprocessor
service.
For Preprocessor
services this prefix can be used for service
properties to mark them as initialization parameters which can be
retrieved from the associated filter configuration. The prefix is removed
from the service property name to build the initialization parameter
name.
For Preprocessor
services, the value of each initialization
parameter service property must be of type String
.
public static final String HTTP_WHITEBOARD_LISTENER
The value of this service property must be of type String
. Valid
values are "true" and "false" ignoring case.
public static final String DISPATCHER_REQUEST
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied to client requests.public static final String DISPATCHER_INCLUDE
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied to include calls to the
dispatcher.public static final String DISPATCHER_FORWARD
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied to forward calls to the
dispatcher.public static final String DISPATCHER_ASYNC
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied in the asynchronous
context.public static final String DISPATCHER_ERROR
HTTP_WHITEBOARD_FILTER_DISPATCHER
property indicating the servlet filter is applied when an error page is
called.public static final String HTTP_WHITEBOARD_RESOURCE_PATTERN
The specified patterns are used to determine whether a request should be mapped to resources. Resource services without this service property are ignored.
The value of this service property must be of type String
,
String[]
, or Collection<String>
.
HTTP_WHITEBOARD_RESOURCE_PREFIX
,
Constant Field Valuespublic static final String HTTP_WHITEBOARD_RESOURCE_PREFIX
If a resource service is registered with this property, requests are served with bundle resources.
This prefix is used to map a requested resource to the bundle's entries. The value must not end with slash ("/") with the exception that a name of the form "/" is used to denote the root of the bundle. See the specification text for details on how HTTP requests are mapped.
The value of this service property must be of type String
.
public static final String HTTP_WHITEBOARD_TARGET
An Http Whiteboard implementation can define any number of service
properties which can be referenced by the target filter. The service
properties should always include the
osgi.http.endpoint
service property if the endpoint information is
known.
If this service property is not specified, then all Http Whiteboard implementations can process the service.
The value of this service property must be of type String
and be
a valid filter string
.
public static final String HTTP_SERVICE_CONTEXT_PROPERTY
Servlets or resources registered using this property are treated as an invalid registration.
HTTP_SERVICE_CONTEXT_FILTER
,
Constant Field Valuespublic static final String HTTP_SERVICE_CONTEXT_FILTER
HTTP_SERVICE_CONTEXT_PROPERTY
property using
this filter.HTTP_SERVICE_CONTEXT_PROPERTY
,
Constant Field Valuespublic static final String HTTP_WHITEBOARD_IMPLEMENTATION
public static final String HTTP_WHITEBOARD_SPECIFICATION_VERSION
Copyright © Contributors to the Eclipse Foundation Licensed under the Eclipse Foundation Specification License – v1.0