HttpParser (firefly 4.6.0-SNAPSHOT API)

java.lang.Object
- com.firefly.codec.http2.decode.HttpParser

```
public class HttpParser
extends Object
```
A Parser for 1.0 and 1.1 as defined by RFC7230
This parser parses HTTP client and server messages from buffers passed in the parseNext(ByteBuffer) method. The parsed elements of the HTTP message are passed as event calls to the HttpParser.HttpHandler instance the parser is constructed with. If the passed handler is a HttpParser.RequestHandler then server side parsing is performed and if it is a HttpParser.ResponseHandler, then client side parsing is done.

The contract of the HttpParser.HttpHandler API is that if a call returns true then the call to parseNext(ByteBuffer) will return as soon as possible also with a true response. Typically this indicates that the parsing has reached a stage where the caller should process the events accumulated by the handler. It is the preferred calling style that handling such as calling a servlet to process a request, should be done after a true return from parseNext(ByteBuffer) rather than from within the scope of a call like HttpParser.HttpHandler.messageComplete()

For performance, the parse is heavily dependent on the Trie.getBest(ByteBuffer, int, int) method to look ahead in a single pass for both the structure ( : and CRLF ) and semantic (which header and value) of a header. Specifically the static HttpHeader.CACHE is used to lookup common combinations of headers and values (eg. "Connection: close"), or just header names (eg. "Connection:" ). For headers who's value is not known statically (eg. Host, COOKIE) then a per parser dynamic Trie of HttpFields from previous parsed messages is used to help the parsing of subsequent messages.

The parser can work in varying compliance modes:

RFC7230

(default) Compliance with RFC7230

RFC2616

Wrapped headers and HTTP/0.9 supported

LEGACY

(aka STRICT) Adherence to Servlet Specification requirement for exact case of header names, bypassing the header caches, which are case insensitive, otherwise equivalent to RFC2616

另请参阅:

RFC 7230

嵌套类概要

嵌套类
限定符和类型	类和说明
`static interface`	`HttpParser.ComplianceHandler`
`static class`	`HttpParser.FieldState`
`static interface`	`HttpParser.HttpHandler`
`static interface`	`HttpParser.RequestHandler`
`static interface`	`HttpParser.ResponseHandler`
`static class`	`HttpParser.State`

字段概要

字段
限定符和类型	字段和说明
`static String`	`__STRICT` 已过时。
`static Trie<HttpField>`	`CACHE` Cache of common `HttpField`s including: Common static combinations such as: Connection: close Accept-Encoding: gzip Content-Length: 0 Combinations of Content-Type header for common mime types by common charsets Most common headers with null values so that a lookup will at least determine the header name even if the name:value combination is not cached
`static int`	`INITIAL_URI_LENGTH`
`static org.slf4j.Logger`	`LOG`

构造器概要

构造器
构造器和说明
`HttpParser(HttpParser.RequestHandler handler)`
`HttpParser(HttpParser.RequestHandler handler, HttpCompliance compliance)`
`HttpParser(HttpParser.RequestHandler handler, int maxHeaderBytes)`
`HttpParser(HttpParser.RequestHandler handler, int maxHeaderBytes, boolean strict)` 已过时。
`HttpParser(HttpParser.RequestHandler handler, int maxHeaderBytes, HttpCompliance compliance)`
`HttpParser(HttpParser.ResponseHandler handler)`
`HttpParser(HttpParser.ResponseHandler handler, int maxHeaderBytes)`
`HttpParser(HttpParser.ResponseHandler handler, int maxHeaderBytes, boolean strict)` 已过时。
`HttpParser(HttpParser.ResponseHandler handler, int maxHeaderBytes, HttpCompliance compliance)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`atEOF()` Signal that the associated data source is at EOF
`protected void`	`badMessage(BadMessageException x)`
`void`	`close()` Request that the associated data source be closed
`protected boolean`	`complianceViolation(HttpCompliance compliance, String reason)` Check RFC compliance violation
`long`	`getContentLength()`
`long`	`getContentRead()`
`Trie<HttpField>`	`getFieldCache()`
`HttpParser.HttpHandler`	`getHandler()`
`HttpParser.State`	`getState()`
`boolean`	`inContentState()`
`boolean`	`inHeaderState()`
`boolean`	`isAtEOF()`
`boolean`	`isChunking()`
`boolean`	`isClose()`
`boolean`	`isClosed()`
`boolean`	`isComplete()`
`boolean`	`isIdle()`
`boolean`	`isStart()`
`boolean`	`isState(HttpParser.State state)`
`protected String`	`legacyString(String orig, String cached)`
`protected boolean`	`parseContent(ByteBuffer buffer)`
`protected boolean`	`parseFields(ByteBuffer buffer)`
`boolean`	`parseNext(ByteBuffer buffer)` Parse until next Event.
`void`	`reset()`
`void`	`setHeadResponse(boolean head)` Set if a HEAD response is expected
`protected void`	`setResponseStatus(int status)`
`protected void`	`setState(HttpParser.FieldState state)`
`protected void`	`setState(HttpParser.State state)`
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料
- LOG
```
public static final org.slf4j.Logger LOG
```
- __STRICT
```
@Deprecated
public static final String __STRICT
```
  已过时。
  
  另请参阅:
  
  常量字段值
- INITIAL_URI_LENGTH
```
public static final int INITIAL_URI_LENGTH
```
  另请参阅:
  
  常量字段值
- CACHE
```
public static final Trie<HttpField> CACHE
```
  Cache of common HttpFields including:
  - Common static combinations such as:
    - Connection: close
    - Accept-Encoding: gzip
    - Content-Length: 0
  - Combinations of Content-Type header for common mime types by common charsets
  - Most common headers with null values so that a lookup will at least determine the header name even if the name:value combination is not cached

构造器详细资料

HttpParser

public HttpParser(HttpParser.RequestHandler handler)

HttpParser

public HttpParser(HttpParser.ResponseHandler handler)

HttpParser

public HttpParser(HttpParser.RequestHandler handler,
                  int maxHeaderBytes)

HttpParser

public HttpParser(HttpParser.ResponseHandler handler,
                  int maxHeaderBytes)

HttpParser

@Deprecated
public HttpParser(HttpParser.RequestHandler handler,
                              int maxHeaderBytes,
                              boolean strict)

已过时。

HttpParser

@Deprecated
public HttpParser(HttpParser.ResponseHandler handler,
                              int maxHeaderBytes,
                              boolean strict)

已过时。

HttpParser

public HttpParser(HttpParser.RequestHandler handler,
                  HttpCompliance compliance)

HttpParser

public HttpParser(HttpParser.RequestHandler handler,
                  int maxHeaderBytes,
                  HttpCompliance compliance)

HttpParser

public HttpParser(HttpParser.ResponseHandler handler,
                  int maxHeaderBytes,
                  HttpCompliance compliance)

方法详细资料

getHandler

public HttpParser.HttpHandler getHandler()

complianceViolation
```
protected boolean complianceViolation(HttpCompliance compliance,
                                      String reason)
```
Check RFC compliance violation

参数:

compliance - The compliance level violated

reason - The reason for the violation

返回:

True if the current compliance level is set so as to Not allow this violation

legacyString

protected String legacyString(String orig,
                              String cached)

getContentLength
```
public long getContentLength()
```

getContentRead
```
public long getContentRead()
```

setHeadResponse
```
public void setHeadResponse(boolean head)
```
Set if a HEAD response is expected

参数:

head - true if head response is expected

setResponseStatus

protected void setResponseStatus(int status)

getState
```
public HttpParser.State getState()
```

inContentState
```
public boolean inContentState()
```

inHeaderState
```
public boolean inHeaderState()
```

isChunking
```
public boolean isChunking()
```

isStart
```
public boolean isStart()
```

isClose
```
public boolean isClose()
```

isClosed
```
public boolean isClosed()
```

isIdle
```
public boolean isIdle()
```

isComplete
```
public boolean isComplete()
```

isState

public boolean isState(HttpParser.State state)

parseFields

protected boolean parseFields(ByteBuffer buffer)

parseNext
```
public boolean parseNext(ByteBuffer buffer)
```
Parse until next Event.

参数:

buffer - the buffer to parse

返回:

True if an HttpParser.RequestHandler method was called and it returned true;

badMessage

protected void badMessage(BadMessageException x)

parseContent

protected boolean parseContent(ByteBuffer buffer)

isAtEOF
```
public boolean isAtEOF()
```

atEOF
```
public void atEOF()
```
Signal that the associated data source is at EOF

close
```
public void close()
```
Request that the associated data source be closed

reset
```
public void reset()
```

setState

protected void setState(HttpParser.State state)

setState

protected void setState(HttpParser.FieldState state)

getFieldCache

public Trie<HttpField> getFieldCache()

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

类 HttpParser

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

LOG

__STRICT

INITIAL_URI_LENGTH

CACHE

构造器详细资料

HttpParser

HttpParser

HttpParser

HttpParser

HttpParser

HttpParser

HttpParser

HttpParser

HttpParser

方法详细资料

getHandler

complianceViolation

legacyString

getContentLength

getContentRead

setHeadResponse

setResponseStatus

getState

inContentState

inHeaderState

isChunking

isStart

isClose

isClosed

isIdle

isComplete

isState

parseFields

parseNext

badMessage

parseContent

isAtEOF

atEOF

close

reset

setState

setState

getFieldCache

toString