Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*
  * JBoss, Home of Professional Open Source.
  * Copyright 2012 Red Hat, Inc., and individual contributors
  * as indicated by the @author tags.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.servlet.http;
An event filter, similar to regular filters, performs filtering tasks on either the request to a resource (an event driven Servlet), or on the response from a resource, or both.

Author(s):
Remy Maucherat
public interface HttpEventFilter extends Filter {

    
    
The doFilterEvent method of the HttpEventFilter is called by the container each time a request/response pair is passed through the chain due to a client event for a resource at the end of the chain. The HttpEventFilterChain passed in to this method allows the Filter to pass on the event 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 contained in the event with a custom implementation to filter content or headers for input filtering and pass a HttpEvent instance containing the wrapped request to the next filter
3. Optionally wrap the response object contained in the event with a custom implementation to filter content or headers for output filtering and pass a HttpEvent instance containing the wrapped request to the next filter
4. a) Either invoke the next entity in the chain using the HttpEventFilterChain object (chain.doFilterEvent()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the event processing
5. Directly set fields on the response after invocation of the next entity in the filter chain.

Parameters:
event the event that is being processed. Another event may be passed along the chain.
chain
Throws:
java.io.IOException
javax.servlet.ServletException
    public void doFilterEvent(HttpEvent eventHttpEventFilterChain chain)
        throws IOExceptionServletException;
    
New to GrepCode? Check out our FAQ X