Package net.officefloor.server.buffer

Class StreamBufferScanner

java.lang.Object

net.officefloor.server.buffer.StreamBufferScanner

Direct Known Subclasses:

HttpRequestParser

public class StreamBufferScanner
extends Object

Provides scanning of StreamBuffer instances.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamBufferScanner.ScanTarget	Scan target.

Constructor Summary

Constructors

Constructor	Description
StreamBufferScanner()

Method Summary

Modifier and Type	Method	Description
void	appendStreamBuffer(StreamBuffer<ByteBuffer> buffer)	Appends StreamBuffer for scanning.
<T extends Throwable> byte	buildByte(Supplier<T> illegalValueExceptionFactory)	Builds a byte from the StreamBuffer at current position.
<T extends Throwable> long	buildLong(Supplier<T> illegalValueExceptionFactory)	Builds a long (8 bytes) from the StreamBuffer at current position.
<T extends Throwable> short	buildShort(Supplier<T> illegalValueExceptionFactory)	Builds a short (2 bytes) from the StreamBuffer at current position.
static final byte	indexOf(long bytes, StreamBufferScanner.ScanTarget target)	Scans the ByteBuffer to find the next byte of particular value.
int	peekToTarget(StreamBufferScanner.ScanTarget target)	Peeks in the current StreamBuffer to attempt to find the StreamBufferScanner.ScanTarget.
StreamBufferByteSequence	scanBytes(long numberOfBytes)	Scans a specific number of bytes.
<T extends Throwable> StreamBufferByteSequence	scanToTarget(StreamBufferScanner.ScanTarget target, int maxBytesLength, Supplier<T> tooLongExceptionFactory)	Scans the StreamBuffer for the byte value from the current position.
void	skipBytes(int numberOfBytes)	Skips forward the particular number of bytes in the current StreamBuffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StreamBufferScanner

public StreamBufferScanner()

Method Details

appendStreamBuffer

public void appendStreamBuffer(StreamBuffer<ByteBuffer> buffer)

Appends StreamBuffer for scanning.

Parameters:

buffer - StreamBuffer.

buildLong

public <T extends Throwable> long buildLong(Supplier<T> illegalValueExceptionFactory)
                                     throws T

Builds a long (8 bytes) from the StreamBuffer at current position.

Type Parameters:

T - Illegal value Exception

Parameters:

illegalValueExceptionFactory - Supplier to create Throwable for illegal long value.

Returns:

Long value, otherwise -1 if not enough bytes in StreamBuffer to build a long.

Throws:

T - If invalid value.

buildShort

public <T extends Throwable> short buildShort(Supplier<T> illegalValueExceptionFactory)
                                       throws T

Builds a short (2 bytes) from the StreamBuffer at current position.

Type Parameters:

T - Illegal value Exception

Parameters:

illegalValueExceptionFactory - Supplier to create Throwable for illegal short value.

Returns:

Short value, otherwise -1 if not enough bytes in StreamBuffer to build a short.

Throws:

T - If invalid value.

buildByte

public <T extends Throwable> byte buildByte(Supplier<T> illegalValueExceptionFactory)
                                     throws T

Builds a byte from the StreamBuffer at current position.

Type Parameters:

T - Illegal value Exception

Parameters:

illegalValueExceptionFactory - Supplier to create Throwable for illegal short value.

Returns:

Byte value, otherwise -1 if not enough bytes in StreamBuffer to build a byte.

Throws:

T - If invalid value.

peekToTarget

public int peekToTarget(StreamBufferScanner.ScanTarget target)

Peeks in the current StreamBuffer to attempt to find the StreamBufferScanner.ScanTarget.

Parameters:

target - StreamBufferScanner.ScanTarget.

Returns:

Position of the StreamBufferScanner.ScanTarget within the current StreamBuffer (starting at current position). Otherwise, -1 to indicate did not find StreamBufferScanner.ScanTarget in current StreamBuffer.

scanBytes

public StreamBufferByteSequence scanBytes(long numberOfBytes)

Scans a specific number of bytes.

Parameters:

numberOfBytes - Number of bytes to scan.

Returns:

StreamBufferByteSequence to the scanned bytes.

scanToTarget

public <T extends Throwable>
StreamBufferByteSequence scanToTarget(StreamBufferScanner.ScanTarget target,
 int maxBytesLength,
 Supplier<T> tooLongExceptionFactory)
                               throws T

Scans the StreamBuffer for the byte value from the current position.

The returned StreamBufferByteSequence is inclusive of the current position but exclusive of the target byte. This is because target bytes for HTTP are typically delimiters (eg. space, CR, etc) that are not included in the bytes of interest.

Type Parameters:

T - Too long Exception type.

Parameters:

target - StreamBufferScanner.ScanTarget.

maxBytesLength - Max bytes.

tooLongExceptionFactory - Supplier to provide too long Exception.

Returns:

StreamBufferByteSequence if found the byte. Otherwise, null indicating further StreamBuffer instances may contain the byte.

Throws:

T - If too long Exception.

skipBytes

public void skipBytes(int numberOfBytes)

Skips forward the particular number of bytes in the current StreamBuffer.

Parameters:

numberOfBytes - Number of bytes to skip.

indexOf

public static final byte indexOf(long bytes,
 StreamBufferScanner.ScanTarget target)

Scans the ByteBuffer to find the next byte of particular value.

Note: the algorithm used does not handle negative byte values. However, the values (ASCII characters) searched for in HTTP parsing are all positive (lower 7 bits of the byte).

Parameters:

bytes - Long of 8 bytes to check for the value.

target - StreamBufferScanner.ScanTarget for the byte to find the index.

Returns:

Index within the long of the first byte value. Otherwise, -1 if does not find the byte.