|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mortbay.servlet.UserAgentFilter
public class UserAgentFilter
User Agent Filter.
This filter allows efficient matching of user agent strings for downstream or extended filters to use for browser specific logic.
The filter is configured with the following init parameters:
Pattern
to extract the essential elements of the user agent.
The concatenation of matched pattern groups is used as the user agent name(?:Mozilla[^\(]*\(compatible;\s*+([^;]*);.*)|(?:.*?([^\s]+/[^\s]+).*)
. These two
pattern match the common compatibility user-agent strings and extract the real user agent, failing that, the first
element of the agent string is returned.
Constructor Summary | |
---|---|
UserAgentFilter()
|
Method Summary | |
---|---|
void |
destroy()
Called by the web container to indicate to a filter that it is being taken out of service. |
void |
doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
The doFilter method of the Filter is called by the container
each time a request/response pair is passed through the chain due
to a client request for a resource at the end of the chain. |
java.lang.String |
getUserAgent(ServletRequest request)
|
java.lang.String |
getUserAgent(java.lang.String ua)
Get UserAgent. |
void |
init(FilterConfig filterConfig)
Called by the web container to indicate to a filter that it is being placed into service. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserAgentFilter()
Method Detail |
---|
public void destroy()
Filter
destroy
in interface Filter
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException
Filter
doFilter
method of the Filter is called by the container
each time a request/response pair is passed through the chain due
to a client request for a resource at the end of the chain. The FilterChain passed in to this
method allows the Filter to pass on the request and response to the next entity in the
chain.
A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to
filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to
filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()
),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.
doFilter
in interface Filter
java.io.IOException
ServletException
public void init(FilterConfig filterConfig) throws ServletException
Filter
init
in interface Filter
ServletException
public java.lang.String getUserAgent(ServletRequest request)
public java.lang.String getUserAgent(java.lang.String ua)
ua
- A user agent string
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |