io.netty.handler.codec.http

类 DefaultHttpHeaders

java.lang.Object

io.netty.handler.codec.http.HttpHeaders

io.netty.handler.codec.http.DefaultHttpHeaders

所有已实现的接口:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>

直接已知子类:

CombinedHttpHeaders

public class DefaultHttpHeaders
extends HttpHeaders

Default implementation of HttpHeaders.

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.http.HttpHeaders

HttpHeaders.Names, HttpHeaders.Values

字段概要

从类继承的字段 io.netty.handler.codec.http.HttpHeaders

EMPTY_HEADERS

构造器概要

构造器

限定符	构造器和说明
	DefaultHttpHeaders() Create a new, empty HTTP headers object.
	DefaultHttpHeaders(boolean validate) 已过时。 Prefer using the DefaultHttpHeaders() constructor instead, to always have validation enabled.
protected	DefaultHttpHeaders(boolean validateValues, DefaultHeaders.NameValidator<java.lang.CharSequence> nameValidator) Create an HTTP headers object with the given name validator.
protected	DefaultHttpHeaders(DefaultHeaders.NameValidator<java.lang.CharSequence> nameValidator, DefaultHeaders.ValueValidator<java.lang.CharSequence> valueValidator) Create an HTTP headers object with the given name and value validators.
protected	DefaultHttpHeaders(DefaultHeaders.NameValidator<java.lang.CharSequence> nameValidator, DefaultHeaders.ValueValidator<java.lang.CharSequence> valueValidator, int sizeHint) Create an HTTP headers object with the given name and value validators.
protected	DefaultHttpHeaders(DefaultHeaders<java.lang.CharSequence,java.lang.CharSequence,?> headers)

方法概要

限定符和类型	方法和说明
HttpHeaders	add(java.lang.CharSequence name, java.lang.Iterable<?> values) Adds a new header with the specified name and values.
HttpHeaders	add(java.lang.CharSequence name, java.lang.Object value) Adds a new header with the specified name and value.
HttpHeaders	add(HttpHeaders headers) Adds all header entries of the specified headers.
HttpHeaders	add(java.lang.String name, java.lang.Iterable<?> values)
HttpHeaders	add(java.lang.String name, java.lang.Object value)
HttpHeaders	addInt(java.lang.CharSequence name, int value) Add the name to value.
HttpHeaders	addShort(java.lang.CharSequence name, short value) Add the name to value.
HttpHeaders	clear() Removes all headers from this HttpMessage.
boolean	contains(java.lang.CharSequence name) Checks to see if there is a header with the specified name
boolean	contains(java.lang.CharSequence name, java.lang.CharSequence value, boolean ignoreCase) Returns true if a header with the name and value exists, false otherwise.
boolean	contains(java.lang.String name)
boolean	contains(java.lang.String name, java.lang.String value, boolean ignoreCase)
HttpHeaders	copy() Returns a deep copy of the passed in HttpHeaders.
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	entries() Returns a new List that contains all headers in this object.
boolean	equals(java.lang.Object o)
java.lang.String	get(java.lang.CharSequence name) Returns the value of a header with the specified name.
java.lang.String	get(java.lang.String name)
java.util.List<java.lang.String>	getAll(java.lang.CharSequence name) Returns the values of headers with the specified name
java.util.List<java.lang.String>	getAll(java.lang.String name)
java.lang.Integer	getInt(java.lang.CharSequence name) Returns the integer value of a header with the specified name.
int	getInt(java.lang.CharSequence name, int defaultValue) Returns the integer value of a header with the specified name.
java.lang.Short	getShort(java.lang.CharSequence name) Returns the short value of a header with the specified name.
short	getShort(java.lang.CharSequence name, short defaultValue) Returns the short value of a header with the specified name.
java.lang.Long	getTimeMillis(java.lang.CharSequence name) Returns the date value of a header with the specified name.
long	getTimeMillis(java.lang.CharSequence name, long defaultValue) Returns the date value of a header with the specified name.
int	hashCode()
boolean	isEmpty() Checks if no header exists.
java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>>	iterator() 已过时。
java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>>	iteratorCharSequence()
java.util.Set<java.lang.String>	names() Returns a new Set that contains the names of all headers in this object.
HttpHeaders	remove(java.lang.CharSequence name) Removes the header with the specified name.
HttpHeaders	remove(java.lang.String name)
HttpHeaders	set(java.lang.CharSequence name, java.lang.Iterable<?> values) Sets a header with the specified name and values.
HttpHeaders	set(java.lang.CharSequence name, java.lang.Object value) Sets a header with the specified name and value.
HttpHeaders	set(HttpHeaders headers) Cleans the current header entries and copies all header entries of the specified headers.
HttpHeaders	set(java.lang.String name, java.lang.Iterable<?> values)
HttpHeaders	set(java.lang.String name, java.lang.Object value)
HttpHeaders	setInt(java.lang.CharSequence name, int value) Set the name to value.
HttpHeaders	setShort(java.lang.CharSequence name, short value) Set the name to value.
int	size() Returns the number of headers in this object.
java.util.Iterator<java.lang.CharSequence>	valueCharSequenceIterator(java.lang.CharSequence name) Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.
java.util.Iterator<java.lang.String>	valueStringIterator(java.lang.CharSequence name) Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.

从类继承的方法 io.netty.handler.codec.http.HttpHeaders

addDateHeader, addDateHeader, addHeader, addHeader, addIntHeader, addIntHeader, clearHeaders, containsValue, encodeAscii, equalsIgnoreCase, get, getAllAsString, getAsString, getContentLength, getContentLength, getDate, getDate, getDateHeader, getDateHeader, getDateHeader, getDateHeader, getHeader, getHeader, getHeader, getHeader, getHost, getHost, getIntHeader, getIntHeader, getIntHeader, getIntHeader, is100ContinueExpected, isContentLengthSet, isKeepAlive, isTransferEncodingChunked, iteratorAsString, newEntity, removeHeader, removeHeader, removeTransferEncodingChunked, set100ContinueExpected, set100ContinueExpected, setAll, setContentLength, setDate, setDateHeader, setDateHeader, setDateHeader, setDateHeader, setHeader, setHeader, setHeader, setHeader, setHost, setHost, setIntHeader, setIntHeader, setIntHeader, setIntHeader, setKeepAlive, setTransferEncodingChunked, toString

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.lang.Iterable

forEach, spliterator

构造器详细资料

DefaultHttpHeaders

public DefaultHttpHeaders()

Create a new, empty HTTP headers object.

Header names and values are validated as they are added, to ensure they are compliant with the HTTP protocol.

DefaultHttpHeaders

@Deprecated
public DefaultHttpHeaders(boolean validate)

已过时。 Prefer using the DefaultHttpHeaders() constructor instead, to always have validation enabled.

Warning! Setting validate to false will mean that Netty won't validate & protect against user-supplied header values that are malicious. This can leave your server implementation vulnerable to CWE-113: Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting') . When disabling this validation, it is the responsibility of the caller to ensure that the values supplied do not contain a non-url-escaped carriage return (CR) and/or line feed (LF) characters.

参数:

validate - Should Netty validate header values to ensure they aren't malicious.

DefaultHttpHeaders

protected DefaultHttpHeaders(boolean validateValues,
                             DefaultHeaders.NameValidator<java.lang.CharSequence> nameValidator)

Create an HTTP headers object with the given name validator.

Warning! It is strongly recommended that the name validator implement validation that is at least as strict as HttpHeaderValidationUtil.validateToken(CharSequence). It is also strongly recommended that validateValues is enabled.

Without these validations in place, your code can be susceptible to CWE-113: Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting') . It is the responsibility of the caller to ensure that the values supplied do not contain a non-url-escaped carriage return (CR) and/or line feed (LF) characters.

参数:

validateValues - Should Netty validate header values to ensure they aren't malicious.

nameValidator - The DefaultHeaders.NameValidator to use, never {@code null.

DefaultHttpHeaders

protected DefaultHttpHeaders(DefaultHeaders.NameValidator<java.lang.CharSequence> nameValidator,
                             DefaultHeaders.ValueValidator<java.lang.CharSequence> valueValidator)

Create an HTTP headers object with the given name and value validators.

Warning! It is strongly recommended that the name validator implement validation that is at least as strict as HttpHeaderValidationUtil.validateToken(CharSequence). And that the value validator is at least as strict as HttpHeaderValidationUtil.validateValidHeaderValue(CharSequence).

Without these validations in place, your code can be susceptible to CWE-113: Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting') . It is the responsibility of the caller to ensure that the values supplied do not contain a non-url-escaped carriage return (CR) and/or line feed (LF) characters.

参数:

nameValidator - The DefaultHeaders.NameValidator to use, never null.

valueValidator - The DefaultHeaders.ValueValidator to use, never null.

DefaultHttpHeaders

protected DefaultHttpHeaders(DefaultHeaders.NameValidator<java.lang.CharSequence> nameValidator,
                             DefaultHeaders.ValueValidator<java.lang.CharSequence> valueValidator,
                             int sizeHint)

Create an HTTP headers object with the given name and value validators.

Warning! It is strongly recommended that the name validator implement validation that is at least as strict as HttpHeaderValidationUtil.validateToken(CharSequence). And that the value validator is at least as strict as HttpHeaderValidationUtil.validateValidHeaderValue(CharSequence).

Without these validations in place, your code can be susceptible to CWE-113: Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting') . It is the responsibility of the caller to ensure that the values supplied do not contain a non-url-escaped carriage return (CR) and/or line feed (LF) characters.

参数:

nameValidator - The DefaultHeaders.NameValidator to use, never null.

valueValidator - The DefaultHeaders.ValueValidator to use, never null.

sizeHint - A hint about the anticipated number of entries.

DefaultHttpHeaders

protected DefaultHttpHeaders(DefaultHeaders<java.lang.CharSequence,java.lang.CharSequence,?> headers)

方法详细资料

add

public HttpHeaders add(HttpHeaders headers)

从类复制的说明: HttpHeaders

Adds all header entries of the specified headers.

覆盖:

add 在类中 HttpHeaders

返回:

this

set

public HttpHeaders set(HttpHeaders headers)

从类复制的说明: HttpHeaders

Cleans the current header entries and copies all header entries of the specified headers.

覆盖:

set 在类中 HttpHeaders

返回:

this

add

public HttpHeaders add(java.lang.String name,
                       java.lang.Object value)

指定者:

add 在类中 HttpHeaders

另请参阅:

HttpHeaders.add(CharSequence, Object)

add

public HttpHeaders add(java.lang.CharSequence name,
                       java.lang.Object value)

从类复制的说明: HttpHeaders

Adds a new header with the specified name and value. If the specified value is not a String, it is converted into a String by Object.toString(), except in the cases of Date and Calendar, which are formatted to the date format defined in RFC2616.

覆盖:

add 在类中 HttpHeaders

参数:

name - The name of the header being added

value - The value of the header being added

返回:

this

add

public HttpHeaders add(java.lang.String name,
                       java.lang.Iterable<?> values)

指定者:

add 在类中 HttpHeaders

另请参阅:

HttpHeaders.add(CharSequence, Iterable)

add

public HttpHeaders add(java.lang.CharSequence name,
                       java.lang.Iterable<?> values)

从类复制的说明: HttpHeaders

Adds a new header with the specified name and values. This getMethod can be represented approximately as the following code:

 for (Object v: values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 

覆盖:

add 在类中 HttpHeaders

参数:

name - The name of the headers being set

values - The values of the headers being set

返回:

this

addInt

public HttpHeaders addInt(java.lang.CharSequence name,
                          int value)

从类复制的说明: HttpHeaders

Add the name to value.

指定者:

addInt 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

addShort

public HttpHeaders addShort(java.lang.CharSequence name,
                            short value)

从类复制的说明: HttpHeaders

Add the name to value.

指定者:

addShort 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

remove

public HttpHeaders remove(java.lang.String name)

指定者:

remove 在类中 HttpHeaders

另请参阅:

HttpHeaders.remove(CharSequence)

remove

public HttpHeaders remove(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Removes the header with the specified name.

覆盖:

remove 在类中 HttpHeaders

参数:

name - The name of the header to remove

返回:

this

set

public HttpHeaders set(java.lang.String name,
                       java.lang.Object value)

指定者:

set 在类中 HttpHeaders

另请参阅:

HttpHeaders.set(CharSequence, Object)

set

public HttpHeaders set(java.lang.CharSequence name,
                       java.lang.Object value)

从类复制的说明: HttpHeaders

Sets a header with the specified name and value. If there is an existing header with the same name, it is removed. If the specified value is not a String, it is converted into a String by Object.toString(), except for Date and Calendar, which are formatted to the date format defined in RFC2616.

覆盖:

set 在类中 HttpHeaders

参数:

name - The name of the header being set

value - The value of the header being set

返回:

this

set

public HttpHeaders set(java.lang.String name,
                       java.lang.Iterable<?> values)

指定者:

set 在类中 HttpHeaders

另请参阅:

HttpHeaders.set(CharSequence, Iterable)

set

public HttpHeaders set(java.lang.CharSequence name,
                       java.lang.Iterable<?> values)

从类复制的说明: HttpHeaders

Sets a header with the specified name and values. If there is an existing header with the same name, it is removed. This getMethod can be represented approximately as the following code:

 headers.remove(name);
 for (Object v: values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 

覆盖:

set 在类中 HttpHeaders

参数:

name - The name of the headers being set

values - The values of the headers being set

返回:

this

setInt

public HttpHeaders setInt(java.lang.CharSequence name,
                          int value)

从类复制的说明: HttpHeaders

Set the name to value. This will remove all previous values associated with name.

指定者:

setInt 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

setShort

public HttpHeaders setShort(java.lang.CharSequence name,
                            short value)

从类复制的说明: HttpHeaders

Set the name to value. This will remove all previous values associated with name.

指定者:

setShort 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

clear

public HttpHeaders clear()

从类复制的说明: HttpHeaders

Removes all headers from this HttpMessage.

指定者:

clear 在类中 HttpHeaders

返回:

this

get

public java.lang.String get(java.lang.String name)

指定者:

get 在类中 HttpHeaders

另请参阅:

HttpHeaders.get(CharSequence)

get

public java.lang.String get(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

覆盖:

get 在类中 HttpHeaders

参数:

name - The name of the header to search

返回:

The first header value or null if there is no such header

另请参阅:

HttpHeaders.getAsString(CharSequence)

getInt

public java.lang.Integer getInt(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getInt 在类中 HttpHeaders

参数:

name - the name of the header to search

返回:

the first header value if the header is found and its value is an integer. null if there's no such header or its value is not an integer.

getInt

public int getInt(java.lang.CharSequence name,
                  int defaultValue)

从类复制的说明: HttpHeaders

Returns the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getInt 在类中 HttpHeaders

参数:

name - the name of the header to search

defaultValue - the default value

返回:

the first header value if the header is found and its value is an integer. defaultValue if there's no such header or its value is not an integer.

getShort

public java.lang.Short getShort(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getShort 在类中 HttpHeaders

参数:

name - the name of the header to search

返回:

the first header value if the header is found and its value is a short. null if there's no such header or its value is not a short.

getShort

public short getShort(java.lang.CharSequence name,
                      short defaultValue)

从类复制的说明: HttpHeaders

Returns the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getShort 在类中 HttpHeaders

参数:

name - the name of the header to search

defaultValue - the default value

返回:

the first header value if the header is found and its value is a short. defaultValue if there's no such header or its value is not a short.

getTimeMillis

public java.lang.Long getTimeMillis(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the date value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getTimeMillis 在类中 HttpHeaders

参数:

name - the name of the header to search

返回:

the first header value if the header is found and its value is a date. null if there's no such header or its value is not a date.

getTimeMillis

public long getTimeMillis(java.lang.CharSequence name,
                          long defaultValue)

从类复制的说明: HttpHeaders

Returns the date value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getTimeMillis 在类中 HttpHeaders

参数:

name - the name of the header to search

defaultValue - the default value

返回:

the first header value if the header is found and its value is a date. defaultValue if there's no such header or its value is not a date.

getAll

public java.util.List<java.lang.String> getAll(java.lang.String name)

指定者:

getAll 在类中 HttpHeaders

另请参阅:

HttpHeaders.getAll(CharSequence)

getAll

public java.util.List<java.lang.String> getAll(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the values of headers with the specified name

覆盖:

getAll 在类中 HttpHeaders

参数:

name - The name of the headers to search

返回:

A List of header values which will be empty if no values are found

另请参阅:

HttpHeaders.getAllAsString(CharSequence)

entries

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> entries()

从类复制的说明: HttpHeaders

Returns a new List that contains all headers in this object. Note that modifying the returned List will not affect the state of this object. If you intend to enumerate over the header entries only, use HttpHeaders.iterator() instead, which has much less overhead.

指定者:

entries 在类中 HttpHeaders

另请参阅:

HttpHeaders.iteratorCharSequence()

iterator

@Deprecated
public java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> iterator()

已过时。

指定者:

iterator 在接口中 java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>

指定者:

iterator 在类中 HttpHeaders

iteratorCharSequence

public java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>> iteratorCharSequence()

指定者:

iteratorCharSequence 在类中 HttpHeaders

返回:

Iterator over the name/value header pairs.

valueStringIterator

public java.util.Iterator<java.lang.String> valueStringIterator(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.

覆盖:

valueStringIterator 在类中 HttpHeaders

参数:

name - the name of the header to retrieve

返回:

an Iterator of header values corresponding to name.

valueCharSequenceIterator

public java.util.Iterator<java.lang.CharSequence> valueCharSequenceIterator(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.

覆盖:

valueCharSequenceIterator 在类中 HttpHeaders

参数:

name - the name of the header to retrieve

返回:

an Iterator of header values corresponding to name.

contains

public boolean contains(java.lang.String name)

指定者:

contains 在类中 HttpHeaders

另请参阅:

HttpHeaders.contains(CharSequence)

contains

public boolean contains(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Checks to see if there is a header with the specified name

覆盖:

contains 在类中 HttpHeaders

参数:

name - The name of the header to search for

返回:

True if at least one header is found

isEmpty

public boolean isEmpty()

从类复制的说明: HttpHeaders

Checks if no header exists.

指定者:

isEmpty 在类中 HttpHeaders

size

public int size()

从类复制的说明: HttpHeaders

Returns the number of headers in this object.

指定者:

size 在类中 HttpHeaders

contains

public boolean contains(java.lang.String name,
                        java.lang.String value,
                        boolean ignoreCase)

覆盖:

contains 在类中 HttpHeaders

另请参阅:

HttpHeaders.contains(CharSequence, CharSequence, boolean)

contains

public boolean contains(java.lang.CharSequence name,
                        java.lang.CharSequence value,
                        boolean ignoreCase)

从类复制的说明: HttpHeaders

Returns true if a header with the name and value exists, false otherwise.

If ignoreCase is true then a case insensitive compare is done on the value.

覆盖:

contains 在类中 HttpHeaders

参数:

name - the name of the header to find

value - the value of the header to find

ignoreCase - true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.

names

public java.util.Set<java.lang.String> names()

从类复制的说明: HttpHeaders

Returns a new Set that contains the names of all headers in this object. Note that modifying the returned Set will not affect the state of this object. If you intend to enumerate over the header entries only, use HttpHeaders.iterator() instead, which has much less overhead.

指定者:

names 在类中 HttpHeaders

equals

public boolean equals(java.lang.Object o)

覆盖:

equals 在类中 java.lang.Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

copy

public HttpHeaders copy()

从类复制的说明: HttpHeaders

Returns a deep copy of the passed in HttpHeaders.

覆盖:

copy 在类中 HttpHeaders