DefaultHttpHeadersFactory (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.handler.codec.http.DefaultHttpHeadersFactory

所有已实现的接口:

HttpHeadersFactory
```
public final class DefaultHttpHeadersFactory
extends java.lang.Object
implements HttpHeadersFactory
```
A builder of HttpHeadersFactory instances, that itself implements HttpHeadersFactory. The builder is immutable, and every with- method produce a new, modified instance.
The default builder you most likely want to start with is headersFactory().

方法概要

All Methods Static Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`DefaultHeaders.NameValidator<java.lang.CharSequence>`	`getNameValidator()` Get the currently configured `DefaultHeaders.NameValidator`.
`DefaultHeaders.ValueValidator<java.lang.CharSequence>`	`getValueValidator()` Get the currently configured `DefaultHeaders.ValueValidator`.
`static DefaultHttpHeadersFactory`	`headersFactory()` Get the default implementation of `HttpHeadersFactory` for creating headers.
`boolean`	`isCombiningHeaders()` Check whether header combining is enabled or not.
`boolean`	`isValidatingHeaderNames()` Check whether header name validation is enabled.
`boolean`	`isValidatingHeaderValues()` Check whether header value validation is enabled.
`HttpHeaders`	`newEmptyHeaders()` Create a new `HttpHeaders` instance, but sized to be as small an object as possible.
`HttpHeaders`	`newHeaders()` Create a new `HttpHeaders` instance.
`static DefaultHttpHeadersFactory`	`trailersFactory()` Get the default implementation of `HttpHeadersFactory` for creating trailers.
`DefaultHttpHeadersFactory`	`withCombiningHeaders(boolean combiningHeaders)` Create a new builder that will build `HttpHeaders` objects that either combine multi-valued headers, or not.
`DefaultHttpHeadersFactory`	`withNameValidation(boolean validation)` Create a new builder that has HTTP header name validation enabled or disabled.
`DefaultHttpHeadersFactory`	`withNameValidator(DefaultHeaders.NameValidator<java.lang.CharSequence> validator)` Create a new builder that with the given `DefaultHeaders.NameValidator`.
`DefaultHttpHeadersFactory`	`withValidation(boolean validation)` Create a new builder that has HTTP header validation enabled or disabled.
`DefaultHttpHeadersFactory`	`withValueValidation(boolean validation)` Create a new builder that has HTTP header value validation enabled or disabled.
`DefaultHttpHeadersFactory`	`withValueValidator(DefaultHeaders.ValueValidator<java.lang.CharSequence> validator)` Create a new builder that with the given `DefaultHeaders.ValueValidator`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - headersFactory
```
public static DefaultHttpHeadersFactory headersFactory()
```
    Get the default implementation of HttpHeadersFactory for creating headers.
    This DefaultHttpHeadersFactory creates HttpHeaders instances that has the recommended header validation enabled.
  - trailersFactory
```
public static DefaultHttpHeadersFactory trailersFactory()
```
    Get the default implementation of HttpHeadersFactory for creating trailers.
    This DefaultHttpHeadersFactory creates HttpHeaders instances that has the validation enabled that is recommended for trailers.
  - newHeaders
```
public HttpHeaders newHeaders()
```
    从接口复制的说明: HttpHeadersFactory
    
    Create a new HttpHeaders instance.
    
    指定者:
    
    newHeaders 在接口中 HttpHeadersFactory
  - newEmptyHeaders
```
public HttpHeaders newEmptyHeaders()
```
    从接口复制的说明: HttpHeadersFactory
    
    Create a new HttpHeaders instance, but sized to be as small an object as possible.
    
    指定者:
    
    newEmptyHeaders 在接口中 HttpHeadersFactory
  - withNameValidation
```
public DefaultHttpHeadersFactory withNameValidation(boolean validation)
```
    Create a new builder that has HTTP header name validation enabled or disabled.
    Warning! Setting validation to false will mean that Netty won't validate & protect against user-supplied headers 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.
    
    参数:
    
    validation - If validation should be enabled or disabled.
    
    返回:
    
    The new builder.
  - withNameValidator
```
public DefaultHttpHeadersFactory withNameValidator(DefaultHeaders.NameValidator<java.lang.CharSequence> validator)
```
    Create a new builder that with the given DefaultHeaders.NameValidator.
    Warning! If the given validator does not check that the header names are standards compliant, Netty won't validate & protect against user-supplied headers 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.
    
    参数:
    
    validator - The HTTP header name validator to use.
    
    返回:
    
    The new builder.
  - withValueValidation
```
public DefaultHttpHeadersFactory withValueValidation(boolean validation)
```
    Create a new builder that has HTTP header value validation enabled or disabled.
    Warning! Setting validation to false will mean that Netty won't validate & protect against user-supplied headers 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.
    
    参数:
    
    validation - If validation should be enabled or disabled.
    
    返回:
    
    The new builder.
  - withValueValidator
```
public DefaultHttpHeadersFactory withValueValidator(DefaultHeaders.ValueValidator<java.lang.CharSequence> validator)
```
    Create a new builder that with the given DefaultHeaders.ValueValidator.
    Warning! If the given validator does not check that the header values are standards compliant, Netty won't validate & protect against user-supplied headers 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.
    
    参数:
    
    validator - The HTTP header name validator to use.
    
    返回:
    
    The new builder.
  - withValidation
```
public DefaultHttpHeadersFactory withValidation(boolean validation)
```
    Create a new builder that has HTTP header validation enabled or disabled.
    Warning! Setting validation to false will mean that Netty won't validate & protect against user-supplied headers 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.
    
    参数:
    
    validation - If validation should be enabled or disabled.
    
    返回:
    
    The new builder.
  - withCombiningHeaders
```
public DefaultHttpHeadersFactory withCombiningHeaders(boolean combiningHeaders)
```
    Create a new builder that will build HttpHeaders objects that either combine multi-valued headers, or not.
    
    参数:
    
    combiningHeaders - true if multi-valued headers should be combined, otherwise false.
    
    返回:
    
    The new builder.
  - getNameValidator
```
public DefaultHeaders.NameValidator<java.lang.CharSequence> getNameValidator()
```
    Get the currently configured DefaultHeaders.NameValidator.
    This method will be used by the newHeaders() method.
    
    返回:
    
    The configured name validator.
  - getValueValidator
```
public DefaultHeaders.ValueValidator<java.lang.CharSequence> getValueValidator()
```
    Get the currently configured DefaultHeaders.ValueValidator.
    This method will be used by the newHeaders() method.
    
    返回:
    
    The configured value validator.
  - isCombiningHeaders
```
public boolean isCombiningHeaders()
```
    Check whether header combining is enabled or not.
    
    返回:
    
    true if header value combining is enabled, otherwise false.
  - isValidatingHeaderNames
```
public boolean isValidatingHeaderNames()
```
    Check whether header name validation is enabled.
    
    返回:
    
    true if header name validation is enabled, otherwise false.
  - isValidatingHeaderValues
```
public boolean isValidatingHeaderValues()
```
    Check whether header value validation is enabled.
    
    返回:
    
    true if header value validation is enabled, otherwise false.

类 DefaultHttpHeadersFactory

方法概要

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

方法详细资料

headersFactory

trailersFactory

newHeaders

newEmptyHeaders

withNameValidation

withNameValidator

withValueValidation

withValueValidator

withValidation

withCombiningHeaders

getNameValidator

getValueValidator

isCombiningHeaders

isValidatingHeaderNames

isValidatingHeaderValues