cvs commit: jakarta-tomcat-connectors/jk/java/org/apache/ajp AjpHandler.java

[co...@apache.org]

costin      01/06/27 08:47:48

  Added:       jk/java/org/apache/ajp AjpHandler.java
  Log:
  First step in modularizing ajp14. All messages will be handled by modules
  extending this class, Ajp14 will handle the communication channel and
  Ajp14Packet will handle marshaling.
  ( in future we might merge Ajp14, Jni and other "channels" under a common
  interface that sends/receives blocks of data, and reuse the Ajp14Packet
  and handlers for processing. This would be interesting in the nio case,
  where we have are at 1/2 between tcp and jni, by using mmap-ed buffers )
  
  Revision  Changes    Path
  1.1                  jakarta-tomcat-connectors/jk/java/org/apache/ajp/AjpHandler.java
  
  Index: AjpHandler.java
  ===================================================================
  /*
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   * [Additional notices, if required by prior licensing conditions]
   *
   */
  
  package org.apache.ajp;
  
  import java.io.IOException;
  import java.io.UnsupportedEncodingException;
  import java.io.InputStream;
  import java.io.OutputStream;
  import java.net.Socket;
  import java.util.Enumeration;
  import java.security.*;
  
  import org.apache.tomcat.util.http.*;
  import org.apache.tomcat.util.buf.*;
  
  
  /**
   * Base class for handlers of Ajp messages. Jk provide a simple bidirectional 
   * communication mechanism between the web server and a servlet container. It is
   * based on messages that are passed between the 2 server, using a single
   * thread on each side.
   *
   * Both sides must be prepared to deal with unknown packages ( by responding with
   * an "message unknown" message ). The container and server may register new
   * message types, implementing special features or specialized implementations
   * for the "base" messages.
   *
   * The container side must be able to deal with at least the "REQUEST FORWARD", and
   * the server side must be able to deal with at least "HEADERS", "BODY", "END" messages.
   * 
   * @author Costin Manolache
   */
  public class AjpHandler
  {
      public static final int UNKNOWN=-1;
      
      /** Execute the callback 
       */
      public int handleAjpMessage( int type, Ajp14 channel,
  				 Ajp14Packet ajp, BaseRequest req )
  	throws IOException
      {
  	return UNKNOWN;
      }
  }