1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 28 package org.apache.hc.core5.http.nio; 29 30 import java.io.IOException; 31 32 import org.apache.hc.core5.http.HttpException; 33 import org.apache.hc.core5.http.MessageHeaders; 34 35 /** 36 * Message parser intended to build HTTP message head from a session input buffer.. 37 * 38 * @since 4.0 39 */ 40 public interface NHttpMessageParser<T extends MessageHeaders> { 41 42 /** 43 * Resets the parser. The parser will be ready to start parsing another 44 * HTTP message. 45 */ 46 void reset(); 47 48 /** 49 * Attempts to parse a complete message head from the content of the 50 * internal buffer. If the message in the input buffer is incomplete 51 * this method will return {@code null}. 52 * 53 * @param buffer session input buffer. 54 * @param endOfStream end of stream flag 55 * @return HTTP message head, if available, {@code null} otherwise. 56 * @throws IOException in case of an I/O error. 57 * @throws HttpException in case the HTTP message is malformed or 58 * violates the HTTP protocol. 59 */ 60 T parse(SessionInputBuffer buffer, boolean endOfStream) throws IOException, HttpException; 61 62 }