Class PartHeaderConsumer

java.lang.Object

org.simpleframework.http.message.ArrayConsumer

org.simpleframework.http.message.SegmentConsumer

org.simpleframework.http.message.PartHeaderConsumer

All Implemented Interfaces:

ByteConsumer, Segment

class PartHeaderConsumer
extends SegmentConsumer

The PartHeaderConsumer object is used to consume the header for a multipart message. This performs a parse of the HTTP headers within the message up to the terminal carriage return and line feed token. Once this had been read the contents of the header are appended to a buffer so they can be read later.

Field Summary

Fields

Modifier and Type	Field	Description
private Allocator	allocator	This is used to allocate the internal buffer for the header.
private Buffer	buffer	This is the internal buffer used to store the header.

Fields inherited from class SegmentConsumer

cookies, disposition, encoding, expect, header, language, length, limit, name, pos, scan, type, value

Fields inherited from class ArrayConsumer

array, chunk, count, done

Constructor Summary

Constructors

Constructor	Description
PartHeaderConsumer(Allocator allocator)	Constructor for the PartHeaderConsumer object.

Method Summary

Modifier and Type	Method	Description
private void	append()	This is used to allocate the internal buffer and append the consumed bytes to the buffer.
protected void	process()	This is used to process the header consumer once all of the headers have been read.

Methods inherited from class SegmentConsumer

add, adjust, cookie, disposition, encoding, end, equal, expect, getContentLength, getContentType, getDisposition, getFileName, getLocales, getName, getTransferEncoding, getValue, getValue, getValues, headers, isExpectContinue, isFile, language, length, resize, scan, space, terminal, toString, type, white

Methods inherited from class ArrayConsumer

consume, isFinished

Methods inherited from class Object

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

Field Details

allocator

private Allocator allocator

This is used to allocate the internal buffer for the header.

buffer

private Buffer buffer

This is the internal buffer used to store the header.

Constructor Details

PartHeaderConsumer

public PartHeaderConsumer(Allocator allocator)

Constructor for the PartHeaderConsumer object. An allocator is required so that the header consumer can create a buffer to store the contents of the consumed message.

Parameters:

allocator - this is the allocator used to create a buffer

Method Details

process

protected void process()
                throws IOException

This is used to process the header consumer once all of the headers have been read. This will simply parse all of the headers and append the consumed bytes to the internal buffer. Appending the bytes ensures that the whole upload can be put back together as a single byte stream if required.

Overrides:

process in class SegmentConsumer

Throws:

IOException

append

private void append()
             throws IOException

This is used to allocate the internal buffer and append the consumed bytes to the buffer. Once the header is added to the internal buffer this is finished and the next part of the upload can be consumed.

Throws:

IOException