HttpRequestParser (OfficeFloor 3.33.0 API)

java.lang.Object
- net.officefloor.server.buffer.StreamBufferScanner
- - net.officefloor.server.http.parse.HttpRequestParser

public class HttpRequestParser
extends StreamBufferScanner

HttpRequest parser.

Author:: Daniel Sagenschneider

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HttpRequestParser.HttpRequestParserMetaData
Meta-data for the HttpRequestParser.
- Nested classes/interfaces inherited from class net.officefloor.server.buffer.StreamBufferScanner
  StreamBufferScanner.ScanTarget

Constructor Summary

Constructors
Constructor Description

HttpRequestParser(HttpRequestParser.HttpRequestParserMetaData metaData)
Initiate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ByteSequence`	`getEntity()`	Obtains the entity `ByteSequence`.
`NonMaterialisedHttpHeaders`	`getHeaders()`	Obtains the `NonMaterialisedHttpHeaders`.
`java.util.function.Supplier<HttpMethod>`	`getMethod()`	Obtains the `Supplier` of the `HttpMethod`.
`java.util.function.Supplier<java.lang.String>`	`getRequestURI()`	Obtains the `Supplier` of the request URI.
`HttpVersion`	`getVersion()`	Obtains the `HttpVersion`.
`boolean`	`parse()`	Parses the `HttpRequest`.

Methods inherited from class net.officefloor.server.buffer.StreamBufferScanner
appendStreamBuffer, buildByte, buildLong, buildShort, indexOf, peekToTarget, scanBytes, scanToTarget, skipBytes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpRequestParser
```
public HttpRequestParser(HttpRequestParser.HttpRequestParserMetaData metaData)
```
    Initiate.
    
    Parameters:
    
    metaData - HttpRequestParser.HttpRequestParserMetaData.
- Method Detail
  - parse
```
public boolean parse()
              throws HttpException
```
    Parses the HttpRequest.
    
    Returns:
    
    true should the HttpRequest be parsed. Otherwise, false if further data is required.
    
    Throws:
    
    HttpException - If invalid HttpRequest.
  - getMethod
```
public java.util.function.Supplier<HttpMethod> getMethod()
```
    Obtains the Supplier of the HttpMethod.
    
    Returns:
    
    Supplier of the HttpMethod.
  - getRequestURI
```
public java.util.function.Supplier<java.lang.String> getRequestURI()
```
    Obtains the Supplier of the request URI.
    
    Returns:
    
    Supplier of the request URI.
  - getVersion
```
public HttpVersion getVersion()
```
    Obtains the HttpVersion.
    
    Returns:
    
    HttpVersion.
  - getHeaders
```
public NonMaterialisedHttpHeaders getHeaders()
```
    Obtains the NonMaterialisedHttpHeaders.
    
    Returns:
    
    NonMaterialisedHttpHeaders.
  - getEntity
```
public ByteSequence getEntity()
```
    Obtains the entity ByteSequence.
    
    Returns:
    
    ByteSequence for the entity.