Interface FilterMapping
-
- All Superinterfaces:
ContextRelated
public interface FilterMapping extends ContextRelated
Filter mapping contains all the information required to register a
Filter
.- Since:
- 0.4.0, April 05, 2008
- Author:
- Alin Dreghiciu, Grzegorz Grzybek
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Boolean
getAsyncSupported()
Get flag for supporting asynchronous filter invocation.javax.servlet.DispatcherType[]
getDispatcherTypes()
Get an array ofDispatcherType
for this filter.javax.servlet.Filter
getFilter()
Get an actualFilter
instance to register.Class<? extends javax.servlet.Filter>
getFilterClass()
Get a class ofFilter
to register.String
getFilterName()
Get a name of the filter being registered.Map<String,String>
getInitParameters()
Get init parameters for the filter being registered.String[]
getRegexPatterns()
Get Regex patterns for the filter mapping.String[]
getServletNames()
Get Servlet names for the filter mapping.String[]
getUrlPatterns()
Get URL patterns for the filter mapping.-
Methods inherited from interface org.ops4j.pax.web.service.whiteboard.ContextRelated
getContextId, getContextSelectFilter
-
-
-
-
Method Detail
-
getFilter
javax.servlet.Filter getFilter()
Get an actual
Filter
instance to register.- Returns:
- the filter to register
-
getFilterClass
Class<? extends javax.servlet.Filter> getFilterClass()
Get a class of
Filter
to register. Matches<filter>/<filter-class>
element fromweb.xml
. IfgetFilter()
is also specified, servlet class isn't used.There's no whiteboard specific method to specify this class.
- Returns:
- the filter's class to instantiate and register
-
getFilterName
String getFilterName()
Get a name of the filter being registered. Matches
<filter>/<filter-name>
element fromweb.xml
.In whiteboard method, this can be specified as:
HttpWhiteboardConstants.HTTP_WHITEBOARD_FILTER_NAME
propertyfilter-name
service registration property (legacy Pax Web Whiteboard approach)
If not specified, the name defaults to fully qualified class name of the filter.
- Returns:
- name of the Servlet being mapped.
-
getUrlPatterns
String[] getUrlPatterns()
Get URL patterns for the filter mapping.
- Returns:
- an array of url patterns filter maps to
-
getRegexPatterns
String[] getRegexPatterns()
Get Regex patterns for the filter mapping.
- Returns:
- an array of regex patterns filter maps to
-
getServletNames
String[] getServletNames()
Get Servlet names for the filter mapping.
- Returns:
- an array of servlet names the filter was registered for
-
getDispatcherTypes
javax.servlet.DispatcherType[] getDispatcherTypes()
Get an array of
DispatcherType
for this filter.- Returns:
-
getAsyncSupported
Boolean getAsyncSupported()
Get flag for supporting asynchronous filter invocation.
- Returns:
- Filter async-supported flag
-
-