001: /* ====================================================================
002: * The Apache Software License, Version 1.1
003: *
004: * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
005: * reserved.
006: *
007: * Redistribution and use in source and binary forms, with or without
008: * modification, are permitted provided that the following conditions
009: * are met:
010: *
011: * 1. Redistributions of source code must retain the above copyright
012: * notice, this list of conditions and the following disclaimer.
013: *
014: * 2. Redistributions in binary form must reproduce the above copyright
015: * notice, this list of conditions and the following disclaimer in
016: * the documentation and/or other materials provided with the
017: * distribution.
018: *
019: * 3. The end-user documentation included with the redistribution,
020: * if any, must include the following acknowledgment:
021: * "This product includes software developed by the
022: * Apache Software Foundation (http://www.apache.org/)."
023: * Alternately, this acknowledgment may appear in the software
024: * itself, if and wherever such third-party acknowledgments
025: * normally appear.
026: *
027: * 4. The names "Avalon", and "Apache Software Foundation"
028: * must not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation. For more
052: * information on the Apache Software Foundation, please see
053: * <http://www.apache.org/>.
054: */
055: package org.jicarilla.http;
056:
057: import java.nio.ByteBuffer;
058:
059: /**
060: * A component that understands HTTP. Fires off events to a
061: * handler similarly to the way SAX works.
062: *
063: * @author <a href="lsimons at jicarilla dot org">Leo Simons</a>
064: * @version $Id: HTTPParser.java,v 1.4 2004/03/31 19:42:52 lsimons Exp $
065: */
066: public interface HTTPParser {
067: // NOTE: important this starts with 1 as we add it
068: // to c at some point!
069: /**
070: * Return this from Handler.getBodyType() if there is no
071: * message body.
072: */
073: int BODY_TYPE_NONE = 1;
074: /**
075: * Return this from Handler.getBodyType() if the message
076: * body is chunked.
077: */
078: int BODY_TYPE_CHUNKING = 2;
079: /**
080: * Return this from Handler.getBodyType() if the
081: * message body is 'normal' (whatever that means).
082: */
083: int BODY_TYPE_NORMAL = 3;
084:
085: /**
086: * Re-initialize the parser, throwing away all current parser state.
087: */
088: void reset();
089:
090: /**
091: * <p>Parse a piece of an HTTP message. Equivalent to calling</p>
092: *
093: * <pre>
094: * parse( source, source.limit() );
095: * </pre>
096: *
097: * @param source the buffer to read from. Note that you should
098: * never modify this buffer after passing it to the parser!
099: * @throws HTTPException
100: */
101: void parse(ByteBuffer source) throws HTTPException;
102:
103: /**
104: * Parse a piece of an HTTP message. The buffer will be read
105: * from its current position up to its limit. On return, the
106: * buffers position will be at its end.
107: *
108: * @param source the buffer to read from. Note that you should
109: * never modify this buffer after passing it to the parser!
110: * @param amount the number of bytes to read from the source
111: * @throws HTTPException
112: */
113: void parse(ByteBuffer source, int amount) throws HTTPException;
114:
115: HTTPHandler getHandler();
116:
117: void setHandler(HTTPHandler handler);
118:
119: HTTPErrorHandler getErrorHandler();
120:
121: void setErrorHandler(HTTPErrorHandler errorHandler);
122: }
|