alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Tomcat example source code file (CometFilter.java)

This example Tomcat source code file (CometFilter.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Tomcat tags/keywords

cometfilter, cometfilterchain, cometfilterchain, filter, filter, io, ioexception, ioexception, servlet, servletexception, servletexception

The Tomcat CometFilter.java source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.catalina;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.ServletException;

/**
 * A Comet filter, similar to regular filters, performs filtering tasks on either 
 * the request to a resource (a Comet servlet), or on the response from a resource, or both.
 * <br>
* Filters perform filtering in the <code>doFilterEvent method. Every Filter has access to * a FilterConfig object from which it can obtain its initialization parameters, a * reference to the ServletContext which it can use, for example, to load resources * needed for filtering tasks. * <p> * Filters are configured in the deployment descriptor of a web application * <p> * Examples that have been identified for this design are<br> * 1) Authentication Filters <br> * 2) Logging and Auditing Filters <br> * 3) Image conversion Filters <br> * 4) Data compression Filters <br> * 5) Encryption Filters <br> * 6) Tokenizing Filters <br> * 7) Filters that trigger resource access events <br> * 8) XSL/T filters <br> * 9) Mime-type chain Filter <br> * <br> * * @author Remy Maucherat * @author Filip Hanik */ public interface CometFilter extends Filter { /** * The <code>doFilterEvent method of the CometFilter 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 CometFilterChain passed in to this * method allows the Filter to pass on the event to the next entity in the * chain.<p> * A typical implementation of this method would follow the following pattern:- <br> * 1. Examine the request<br> * 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 CometEvent instance containing * the wrapped request to the next filter<br> * 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 CometEvent instance containing * the wrapped request to the next filter<br> * 4. a) <strong>Either invoke the next entity in the chain using the CometFilterChain object (chain.doFilterEvent()),
* 4. b) <strong>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. * * @param event the event that is being processed. Another event may be passed along the chain. * @param chain * @throws IOException * @throws ServletException */ public void doFilterEvent(CometEvent event, CometFilterChain chain) throws IOException, ServletException; }

Other Tomcat examples (source code examples)

Here is a short list of links related to this Tomcat CometFilter.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.