Top Description Fields Constructors Methods
io.undertow.server.protocol.http

public Class HttpAttachments

extends Object
Class Inheritance
Imports
io.undertow.util.AttachmentKey, .HeaderMap, java.util.function.Supplier

Exchange attachments that have specific meaning when using the HTTP protocol
Author
Stuart Douglas

Field Summary

Modifier and TypeField and Description
public static final AttachmentKey<Boolean>
PRE_CHUNKED_RESPONSE

If the value true is attached to the exchange under this key then Undertow will assume that the underlying application has already taken care of chunking, and will not attempt to add its own chunk markers.

public static final AttachmentKey<HeaderMap>
REQUEST_TRAILERS

Attachment key for request trailers when using chunked encoding.

public static final AttachmentKey<Supplier<HeaderMap>>
RESPONSE_TRAILER_SUPPLIER

Attachment key for a supplier response trailers.

public static final AttachmentKey<HeaderMap>
RESPONSE_TRAILERS

Attachment key for response trailers.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

PRE_CHUNKED_RESPONSEback to summary
public static final AttachmentKey<Boolean> PRE_CHUNKED_RESPONSE

If the value true is attached to the exchange under this key then Undertow will assume that the underlying application has already taken care of chunking, and will not attempt to add its own chunk markers. This will only take effect if the application has explicitly set the Transfer-Encoding: chunked header.

REQUEST_TRAILERSback to summary
public static final AttachmentKey<HeaderMap> REQUEST_TRAILERS

Attachment key for request trailers when using chunked encoding. When the request is parsed the trailers will be attached under this key.

RESPONSE_TRAILER_SUPPLIERback to summary
public static final AttachmentKey<Supplier<HeaderMap>> RESPONSE_TRAILER_SUPPLIER

Attachment key for a supplier response trailers. If a header map is attached under this key then the contents will be written out at the end of the chunked request or HTTP/2 response. Note that the results of RESPONSE_TRAILERS and RESPONSE_TRAILER_SUPPLIER will be merged if both exit with the value supplied by the supplier taking precedence. Note that if pre chunked streams are being used then the trailers will not be appended to the response, however any trailers parsed out of the chunked stream will be attached here instead.

RESPONSE_TRAILERSback to summary
public static final AttachmentKey<HeaderMap> RESPONSE_TRAILERS

Attachment key for response trailers. If a header map is attached under this key then the contents will be written out at the end of the chunked request or HTTP/2 response. Note that the results of RESPONSE_TRAILERS and RESPONSE_TRAILER_SUPPLIER will be merged if both exit with the value supplied by the supplier taking precedence. Note that if pre chunked streams are being used then the trailers will not be appended to the response, however any trailers parsed out of the chunked stream will be attached here instead.

Constructor Detail

HttpAttachmentsback to summary
public HttpAttachments()