Uses of Interface
org.apache.hc.core5.http.Header
Packages that use Header
Package
Description
Core HTTP transport component APIs.
Default implementation of HTTP/1.1 transport based on the classic
(blocking) I/O model.
Default implementation of HTTP/1.1 transport based on
the asynchronous (non-blocking) I/O model.
HTTP message entity APIs based on the classic (blocking) I/O model.
Support classes for the classic (blocking) I/O model.
Core HTTP message components, message element parser
and writer APIs and their default implementations.
Core HTTP transport APIs based on the asynchronous, event driven I/O model.
HTTP message entity APIs based on the asynchronous (non-blocking) I/O model.
Support classes for the asynchronous I/O model.
Support classes for the asynchronous I/O model that emulate
behavior of the classic (blocking) I/O model.
Core HTTP/2 transport component APIs.
HTTP/2 HPACK APIs.
Default implementations of core HTTP/2 APIs.
Default implementation of HTTP/2 transport based on
the asynchronous (non-blocking) I/O model.
-
Uses of Header in org.apache.hc.core5.http
Subinterfaces of Header in org.apache.hc.core5.httpModifier and TypeInterfaceDescriptioninterface
An HTTP header which is already formatted.Methods in org.apache.hc.core5.http that return HeaderModifier and TypeMethodDescriptionMessageHeaders.getFirstHeader
(String name) Returns the first header with a specified name of this message.Gets single first header with the given name.Header[]
MessageHeaders.getHeaders()
Returns all the headers of this message.Header[]
MessageHeaders.getHeaders
(String name) Returns all the headers with a specified name of this message.MessageHeaders.getLastHeader
(String name) Returns the last header with a specified name of this message.Methods in org.apache.hc.core5.http that return types with arguments of type HeaderModifier and TypeMethodDescriptionHttpEntity.getTrailers()
Returns supplier of message trailers - headers sent after message body.MessageHeaders.headerIterator()
Returns an iterator of all the headers.MessageHeaders.headerIterator
(String name) Returns an iterator of the headers with a given name.Methods in org.apache.hc.core5.http with parameters of type HeaderModifier and TypeMethodDescriptionvoid
Adds a header to this message.boolean
HttpMessage.removeHeader
(Header header) Removes a header from this message.void
Overwrites the first header with the same name.void
HttpMessage.setHeaders
(Header... headers) Overwrites all the headers in the message. -
Uses of Header in org.apache.hc.core5.http.impl.io
Fields in org.apache.hc.core5.http.impl.io declared as HeaderModifier and TypeFieldDescriptionprivate final Header
IncomingHttpEntity.contentEncoding
private final Header
IncomingHttpEntity.contentType
private static final Header[]
ChunkedInputStream.EMPTY_FOOTERS
private Header[]
ChunkedInputStream.footers
Fields in org.apache.hc.core5.http.impl.io with type parameters of type HeaderMethods in org.apache.hc.core5.http.impl.io that return HeaderModifier and TypeMethodDescriptionHeader[]
ChunkedInputStream.getFooters()
static Header[]
AbstractMessageParser.parseHeaders
(SessionInputBuffer inBuffer, InputStream inputStream, int maxHeaderCount, int maxLineLen, LineParser lineParser) Parses HTTP headers from the data receiver stream according to the generic format as specified by the HTTP/1.1 protocol specification.static Header[]
AbstractMessageParser.parseHeaders
(SessionInputBuffer inBuffer, InputStream inputStream, int maxHeaderCount, int maxLineLen, LineParser parser, List<CharArrayBuffer> headerLines) Parses HTTP headers from the data receiver stream according to the generic format as specified by the HTTP/1.1 protocol specification.Methods in org.apache.hc.core5.http.impl.io that return types with arguments of type HeaderMethod parameters in org.apache.hc.core5.http.impl.io with type arguments of type HeaderModifier and TypeMethodDescriptionprotected OutputStream
BHttpConnectionBase.createContentOutputStream
(long len, SessionOutputBuffer buffer, OutputStream outputStream, Supplier<List<? extends Header>> trailers) Constructors in org.apache.hc.core5.http.impl.io with parameters of type HeaderModifierConstructorDescription(package private)
IncomingHttpEntity
(InputStream content, long len, boolean chunked, Header contentType, Header contentEncoding) Constructor parameters in org.apache.hc.core5.http.impl.io with type arguments of type HeaderModifierConstructorDescriptionChunkedOutputStream
(SessionOutputBuffer buffer, OutputStream outputStream, byte[] chunkCache, Supplier<List<? extends Header>> trailerSupplier) Default constructor.ChunkedOutputStream
(SessionOutputBuffer buffer, OutputStream outputStream, int chunkSizeHint, Supplier<List<? extends Header>> trailerSupplier) Constructor taking an integer chunk size hint. -
Uses of Header in org.apache.hc.core5.http.impl.nio
Fields in org.apache.hc.core5.http.impl.nio with type parameters of type HeaderMethods in org.apache.hc.core5.http.impl.nio that return types with arguments of type HeaderModifier and TypeMethodDescriptionAbstractContentDecoder.getTrailers()
ChunkDecoder.getTrailers()
Method parameters in org.apache.hc.core5.http.impl.nio with type arguments of type HeaderModifier and TypeMethodDescriptionvoid
void
void
(package private) abstract void
(package private) void
(package private) void
(package private) void
(package private) void
(package private) AbstractHttp1StreamDuplexer.MessageDelineation
AbstractHttp1StreamDuplexer.endOutputStream
(List<? extends Header> trailers) private void
ChunkEncoder.writeTrailers
(List<? extends Header> trailers) -
Uses of Header in org.apache.hc.core5.http.io.entity
Methods in org.apache.hc.core5.http.io.entity that return types with arguments of type HeaderModifier and TypeMethodDescriptionAbstractHttpEntity.getTrailers()
HttpEntityWrapper.getTrailers()
NullEntity.getTrailers()
Methods in org.apache.hc.core5.http.io.entity with parameters of type HeaderModifier and TypeMethodDescriptionstatic HttpEntity
HttpEntities.create
(byte[] content, ContentType contentType, Header... trailers) static HttpEntity
HttpEntities.create
(File content, ContentType contentType, Header... trailers) static HttpEntity
HttpEntities.create
(Serializable serializable, ContentType contentType, Header... trailers) static HttpEntity
static HttpEntity
HttpEntities.create
(String content, ContentType contentType, Header... trailers) static HttpEntity
static HttpEntity
HttpEntities.create
(Path content, ContentType contentType, Header... trailers) static HttpEntity
HttpEntities.create
(IOCallback<OutputStream> callback, ContentType contentType, Header... trailers) static HttpEntity
HttpEntities.withTrailers
(HttpEntity entity, Header... trailers) -
Uses of Header in org.apache.hc.core5.http.io.support
Methods in org.apache.hc.core5.http.io.support with parameters of type HeaderModifier and TypeMethodDescriptionClassicRequestBuilder.removeHeader
(Header header) ClassicResponseBuilder.removeHeader
(Header header) ClassicRequestBuilder.setHeaders
(Header... headers) ClassicResponseBuilder.setHeaders
(Header... headers) -
Uses of Header in org.apache.hc.core5.http.message
Classes in org.apache.hc.core5.http.message that implement HeaderModifier and TypeClassDescriptionclass
ImmutableHeader
.class
This class represents a raw HTTP header whose content is parsed 'on demand' only when the header value needs to be consumed.Fields in org.apache.hc.core5.http.message declared as HeaderModifier and TypeFieldDescriptionprivate final Header[]
BasicHeaderIterator.allHeaders
An array of headers to iterate over.private static final Header[]
HeaderGroup.EMPTY
Fields in org.apache.hc.core5.http.message with type parameters of type HeaderModifier and TypeFieldDescriptionBasicListHeaderIterator.allHeaders
A list of headers to iterate over.AbstractHeaderElementIterator.headerIt
HeaderGroup.headers
The list of headers for this group, in the order in which they were addedMethods in org.apache.hc.core5.http.message that return HeaderModifier and TypeMethodDescriptionstatic Header
static Header
HeaderGroup.getCondensedHeader
(String name) Gets a header representing all of the header values with the given name.AbstractMessageWrapper.getFirstHeader
(String name) HeaderGroup.getFirstHeader
(String name) Gets the first header with the given name.Gets single first header with the given name.Header[]
AbstractMessageWrapper.getHeaders()
Header[]
AbstractMessageWrapper.getHeaders
(String name) Header[]
HeaderGroup.getHeaders()
Gets all of the headers contained within this group.Header[]
HeaderGroup.getHeaders
(String name) Gets all of the headers with the given name.AbstractMessageWrapper.getLastHeader
(String name) HeaderGroup.getLastHeader
(String name) Gets the last header with the given name.BasicHeaderIterator.next()
Obtains the next header from this iteration.BasicListHeaderIterator.next()
Obtains the next header from this iteration.BasicLineParser.parseHeader
(CharArrayBuffer buffer) LazyLaxLineParser.parseHeader
(CharArrayBuffer buffer) LazyLineParser.parseHeader
(CharArrayBuffer buffer) LineParser.parseHeader
(CharArrayBuffer buffer) Parses a header from the given buffer containing one line of text.Methods in org.apache.hc.core5.http.message that return types with arguments of type HeaderModifier and TypeMethodDescriptionAbstractMessageWrapper.headerIterator()
AbstractMessageWrapper.headerIterator
(String name) HeaderGroup.headerIterator()
Returns an iterator over this group of headers.HeaderGroup.headerIterator
(String name) Returns an iterator over the headers with a given name in this group.Methods in org.apache.hc.core5.http.message with parameters of type HeaderModifier and TypeMethodDescriptionvoid
void
Adds the given header to the group.void
BasicLineFormatter.formatHeader
(CharArrayBuffer buffer, Header header) void
LineFormatter.formatHeader
(CharArrayBuffer buffer, Header header) Formats a header.private boolean
HeaderGroup.headerEquals
(Header header1, Header header2) static HeaderElement[]
MessageSupport.parseTokens
(Header header) boolean
AbstractMessageWrapper.removeHeader
(Header header) boolean
HeaderGroup.removeHeader
(Header header) Removes the first given header.boolean
HeaderGroup.removeHeaders
(Header header) Removes all headers that match the given header.void
void
Replaces the first occurrence of the header with the same name.void
AbstractMessageWrapper.setHeaders
(Header... headers) void
HeaderGroup.setHeaders
(Header... headers) Sets all of the headers contained within this group overriding any existing headers.Constructors in org.apache.hc.core5.http.message with parameters of type HeaderModifierConstructorDescriptionBasicHeaderIterator
(Header[] headers, String name) Creates a new header iterator.Constructor parameters in org.apache.hc.core5.http.message with type arguments of type HeaderModifierConstructorDescription(package private)
AbstractHeaderElementIterator
(Iterator<Header> headerIterator) Creates a new instance of BasicHeaderElementIteratorBasicHeaderElementIterator
(Iterator<Header> headerIterator) BasicHeaderElementIterator
(Iterator<Header> headerIterator, HeaderValueParser parser) Creates a new instance of BasicHeaderElementIteratorBasicListHeaderIterator
(List<Header> headers, String name) Creates a new header iterator.BasicTokenIterator
(Iterator<Header> headerIterator) Creates a new instance ofBasicTokenIterator
. -
Uses of Header in org.apache.hc.core5.http.nio
Methods in org.apache.hc.core5.http.nio that return types with arguments of type HeaderModifier and TypeMethodDescriptionContentDecoder.getTrailers()
Returns content trailers if availableMethod parameters in org.apache.hc.core5.http.nio with type arguments of type HeaderModifier and TypeMethodDescriptionvoid
Terminates the content stream.void
Terminates the underlying data stream and optionally writes a closing sequence with the given trailers.void
Triggered to signal termination of the data stream. -
Uses of Header in org.apache.hc.core5.http.nio.entity
Fields in org.apache.hc.core5.http.nio.entity with type parameters of type HeaderMethods in org.apache.hc.core5.http.nio.entity that return types with arguments of type HeaderModifier and TypeMethodDescriptionDigestingEntityConsumer.getTrailers()
List of trailers sent with the data stream.Methods in org.apache.hc.core5.http.nio.entity with parameters of type HeaderModifier and TypeMethodDescriptionstatic AsyncEntityProducer
AsyncEntityProducers.create
(byte[] content, ContentType contentType, Header... trailers) static AsyncEntityProducer
AsyncEntityProducers.create
(File content, ContentType contentType, Header... trailers) static AsyncEntityProducer
static AsyncEntityProducer
AsyncEntityProducers.create
(String content, ContentType contentType, Header... trailers) static AsyncEntityProducer
static AsyncEntityProducer
AsyncEntityProducers.create
(Path content, ContentType contentType, Header... trailers) static AsyncEntityProducer
AsyncEntityProducers.createBinary
(Callback<StreamChannel<ByteBuffer>> callback, ContentType contentType, Header... trailers) static AsyncEntityProducer
AsyncEntityProducers.createText
(Callback<StreamChannel<CharBuffer>> callback, ContentType contentType, Header... trailers) static AsyncEntityProducer
AsyncEntityProducers.withTrailers
(AsyncEntityProducer entity, Header... trailers) Method parameters in org.apache.hc.core5.http.nio.entity with type arguments of type HeaderModifier and TypeMethodDescriptionfinal void
final void
void
void
void
Deprecated. -
Uses of Header in org.apache.hc.core5.http.nio.support
Methods in org.apache.hc.core5.http.nio.support with parameters of type HeaderModifier and TypeMethodDescriptionAsyncPushBuilder.removeHeader
(Header header) AsyncRequestBuilder.removeHeader
(Header header) AsyncResponseBuilder.removeHeader
(Header header) AsyncPushBuilder.setHeaders
(Header... headers) AsyncRequestBuilder.setHeaders
(Header... headers) AsyncResponseBuilder.setHeaders
(Header... headers) Method parameters in org.apache.hc.core5.http.nio.support with type arguments of type HeaderModifier and TypeMethodDescriptionfinal void
final void
final void
final void
final void
void
void
void
void
-
Uses of Header in org.apache.hc.core5.http.nio.support.classic
Method parameters in org.apache.hc.core5.http.nio.support.classic with type arguments of type Header -
Uses of Header in org.apache.hc.core5.http.support
Methods in org.apache.hc.core5.http.support that return HeaderModifier and TypeMethodDescriptionAbstractMessageBuilder.getFirstHeader
(String name) Header[]
AbstractMessageBuilder.getFirstHeaders()
Header[]
AbstractMessageBuilder.getHeaders()
Header[]
AbstractMessageBuilder.getHeaders
(String name) AbstractMessageBuilder.getLastHeader
(String name) Methods in org.apache.hc.core5.http.support with parameters of type HeaderModifier and TypeMethodDescriptionAbstractMessageBuilder.removeHeader
(Header header) AbstractRequestBuilder.removeHeader
(Header header) AbstractResponseBuilder.removeHeader
(Header header) BasicRequestBuilder.removeHeader
(Header header) BasicResponseBuilder.removeHeader
(Header header) AbstractMessageBuilder.setHeaders
(Header... headers) AbstractRequestBuilder.setHeaders
(Header... headers) AbstractResponseBuilder.setHeaders
(Header... headers) BasicRequestBuilder.setHeaders
(Header... headers) BasicResponseBuilder.setHeaders
(Header... headers) Method parameters in org.apache.hc.core5.http.support with type arguments of type Header -
Uses of Header in org.apache.hc.core5.http2
Methods in org.apache.hc.core5.http2 that return types with arguments of type HeaderMethod parameters in org.apache.hc.core5.http2 with type arguments of type Header -
Uses of Header in org.apache.hc.core5.http2.hpack
Classes in org.apache.hc.core5.http2.hpack that implement HeaderModifier and TypeClassDescription(package private) final class
Internal HPack header representation that also contains binary length of header name and header value.Methods in org.apache.hc.core5.http2.hpack that return HeaderModifier and TypeMethodDescriptionHPackDecoder.decodeHeader
(ByteBuffer src) FifoLinkedList.get
(int index) (package private) Header
InboundDynamicTable.getDynamicEntry
(int index) (package private) Header
OutboundDynamicTable.getDynamicEntry
(int index) FifoLinkedList.getFirst()
OutboundDynamicTable.getHeader
(int index) FifoLinkedList.getLast()
Methods in org.apache.hc.core5.http2.hpack that return types with arguments of type HeaderMethods in org.apache.hc.core5.http2.hpack with parameters of type HeaderModifier and TypeMethodDescriptionvoid
HPackEncoder.encodeHeader
(ByteArrayBuffer dst, Header header) (package private) void
HPackEncoder.encodeHeader
(ByteArrayBuffer dst, Header header, boolean noIndexing, boolean useHuffman) (package private) void
HPackEncoder.encodeLiteralHeader
(ByteArrayBuffer dst, HPackEntry existing, Header header, HPackRepresentation representation, boolean useHuffman) Method parameters in org.apache.hc.core5.http2.hpack with type arguments of type HeaderModifier and TypeMethodDescriptionvoid
HPackEncoder.encodeHeaders
(ByteArrayBuffer dst, List<? extends Header> headers, boolean useHuffman) (package private) void
HPackEncoder.encodeHeaders
(ByteArrayBuffer dst, List<? extends Header> headers, boolean noIndexing, boolean useHuffman) Constructors in org.apache.hc.core5.http2.hpack with parameters of type Header -
Uses of Header in org.apache.hc.core5.http2.impl
Methods in org.apache.hc.core5.http2.impl that return types with arguments of type HeaderModifier and TypeMethodDescriptionDefaultH2RequestConverter.convert
(HttpRequest message) DefaultH2ResponseConverter.convert
(HttpResponse message) Method parameters in org.apache.hc.core5.http2.impl with type arguments of type HeaderModifier and TypeMethodDescription -
Uses of Header in org.apache.hc.core5.http2.impl.nio
Methods in org.apache.hc.core5.http2.impl.nio that return types with arguments of type HeaderModifier and TypeMethodDescriptionAbstractH2StreamMultiplexer.decodeHeaders
(ByteBuffer payload) ServerH2StreamMultiplexer.decodeHeaders
(ByteBuffer payload) Method parameters in org.apache.hc.core5.http2.impl.nio with type arguments of type HeaderModifier and TypeMethodDescriptionprivate void
AbstractH2StreamMultiplexer.commitHeaders
(int streamId, List<? extends Header> headers, boolean endStream) private void
AbstractH2StreamMultiplexer.commitPushPromise
(int streamId, int promisedStreamId, List<Header> headers) (package private) void
AbstractH2StreamMultiplexer.H2Stream.consumeHeader
(List<Header> headers) void
ClientH2StreamHandler.consumeHeader
(List<Header> headers, boolean endStream) void
ClientPushH2StreamHandler.consumeHeader
(List<Header> headers, boolean endStream) void
H2StreamHandler.consumeHeader
(List<Header> headers, boolean endStream) void
NoopH2StreamHandler.consumeHeader
(List<Header> headers, boolean endStream) void
ServerH2StreamHandler.consumeHeader
(List<Header> headers, boolean endStream) void
ServerPushH2StreamHandler.consumeHeader
(List<Header> requestHeaders, boolean requestEndStream) (package private) void
AbstractH2StreamMultiplexer.H2Stream.consumePromise
(List<Header> headers) void
ClientH2StreamHandler.consumePromise
(List<Header> headers) void
ClientPushH2StreamHandler.consumePromise
(List<Header> headers) void
H2StreamHandler.consumePromise
(List<Header> headers) void
NoopH2StreamHandler.consumePromise
(List<Header> headers) void
ServerH2StreamHandler.consumePromise
(List<Header> headers) void
ServerPushH2StreamHandler.consumePromise
(List<Header> headers) void
void
H2StreamListener.onHeaderInput
(HttpConnection connection, int streamId, List<? extends Header> headers) void
H2StreamListener.onHeaderOutput
(HttpConnection connection, int streamId, List<? extends Header> headers) void
AbstractH2StreamMultiplexer.H2StreamChannelImpl.push
(List<Header> headers, AsyncPushProducer pushProducer) void
H2StreamChannel.push
(List<Header> headers, AsyncPushProducer pushProducer) void
void
void
-
Uses of Header in org.apache.hc.core5.reactive
Fields in org.apache.hc.core5.reactive with type parameters of type HeaderMethods in org.apache.hc.core5.reactive that return types with arguments of type HeaderModifier and TypeMethodDescriptionReactiveResponseConsumer.getTrailers()
Returns the trailers received at the end of the response.Method parameters in org.apache.hc.core5.reactive with type arguments of type Header -
Uses of Header in org.apache.hc.core5.testing.nio
Method parameters in org.apache.hc.core5.testing.nio with type arguments of type HeaderModifier and TypeMethodDescriptionvoid
LoggingH2StreamListener.onHeaderInput
(HttpConnection connection, int streamId, List<? extends Header> headers) void
LoggingH2StreamListener.onHeaderOutput
(HttpConnection connection, int streamId, List<? extends Header> headers)