FileDocCategorySizeDatePackage
TcHandlerCtx.javaAPI DocGlassfish v2 API3272Fri May 04 22:33:14 BST 2007org.apache.tomcat.util.handler

TcHandlerCtx.java


/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * Portions Copyright Apache Software Foundation.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.apache.tomcat.util.handler;

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.Socket;
import java.util.Enumeration;


/**
 * Store all context informations for the invocation of a handler chain.
 *
 * @author Costin Manolache
 */
public class TcHandlerCtx {


    private int type = 0;

    /**
     * Get the type of the handler context.
     */
    public final int getType() {
        return type;
    }

    /**
     * Set the type of the handler context.
     */
    public final void setType( int type ) {
        this.type = type;
    }


    // XXX Make it configurable ( at startup, since runtime change will require sync )
    private Object notes[] = new Object[32];

    /**
     * Get a note associated with this hanlder context.
     */
    public final Object getNote( int id ) {
        return notes[id];
    }

    /**
     * Associate a note with this hanlder context.
     */
    public final void setNote( int id, Object o ) {
        notes[id]=o;
    }


    /**
     * Recycle the hanlder context.
     */
    public void recycle() {
        type = 0;
        for( int i=0; i<notes.length; i++ ) {
            notes[i]=null;
        }
    }

}