Module org.refcodes.web
Package org.refcodes.web

Interface HeaderFields<C extends Cookie,​B extends HeaderFields<C,​B>>

    • Method Detail

      • getAllowMethods

        default List<HttpMethod> getAllowMethods()
        Gets the Allow entity-Header-Field HeaderField.ALLOW: "... The Allow entity-Header-Field lists the set of methods supported by the resource ... The purpose of this field is strictly to inform the recipient of valid methods associated with the resource. An Allow header field MUST be present in a 405 (Method Not Allowed) response ..."
        Returns:
        The HTTP-Methods allowed for the resource.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putAllowMethods

        default List<HttpMethod> putAllowMethods​(HttpMethod... aHttpMethods)
        Sets the Allow entity-Header-Field HeaderField.ALLOW: "... The Allow entity-Header-Field lists the set of methods supported by the resource ... The purpose of this field is strictly to inform the recipient of valid methods associated with the resource. An Allow header field MUST be present in a 405 (Method Not Allowed) response ..."
        Parameters:
        aHttpMethods - The HTTP-Methods allowed for the resource.
        Returns:
        The replaced element (if any, else null).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putAllowMethods

        default List<HttpMethod> putAllowMethods​(List<HttpMethod> aHttpMethods)
        Sets the Allow entity-Header-Field HeaderField.ALLOW: "... The Allow entity-Header-Field lists the set of methods supported by the resource ... The purpose of this field is strictly to inform the recipient of valid methods associated with the resource. An Allow header field MUST be present in a 405 (Method Not Allowed) response ..."
        Parameters:
        aHttpMethods - The HTTP-Methods allowed for the resource.
        Returns:
        The replaced element (if any, else null).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAllowMethods

        default B withAllowMethods​(HttpMethod... aHttpMethods)
        Sets the Allow entity-Header-Field HeaderField.ALLOW: "... The Allow entity-Header-Field lists the set of methods supported by the resource ... The purpose of this field is strictly to inform the recipient of valid methods associated with the resource. An Allow header field MUST be present in a 405 (Method Not Allowed) response ..."
        Parameters:
        aHttpMethods - The HTTP-Methods allowed for the resource.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAllowMethods

        default B withAllowMethods​(List<HttpMethod> aHttpMethods)
        Sets the Allow entity-Header-Field HeaderField.ALLOW: "... The Allow entity-Header-Field lists the set of methods supported by the resource ... The purpose of this field is strictly to inform the recipient of valid methods associated with the resource. An Allow header field MUST be present in a 405 (Method Not Allowed) response ..."
        Parameters:
        aHttpMethods - The HTTP-Methods allowed for the resource.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeAllowMethods

        default List<HttpMethod> removeAllowMethods()
        Removes the Allow entity-Header-Field HeaderField.ALLOW: "... The Allow entity-Header-Field lists the set of methods supported by the resource ... The purpose of this field is strictly to inform the recipient of valid methods associated with the resource. An Allow header field MUST be present in a 405 (Method Not Allowed) response ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getContentLength

        default Integer getContentLength()
        Gets the Content-Length request-Header-Field HeaderField.CONTENT_LENGTH: "... The Content-Length request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Returns:
        The according user agent.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putContentLength

        default Integer putContentLength​(Integer aContentLength)
        Sets the Content-Length request-Header-Field HeaderField.CONTENT_LENGTH: "... The Content-Length request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Parameters:
        aContentLength - The according user agent.
        Returns:
        the string
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withContentLength

        default B withContentLength​(Integer aContentLength)
        Sets he Content-Length request-Header-Field HeaderField.CONTENT_LENGTH: "... The Content-Length request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Parameters:
        aContentLength - The according user agent.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeContentLength

        default Integer removeContentLength()
        Removes he Content-Length request-Header-Field HeaderField.CONTENT_LENGTH : "... The Content-Length request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getContentType

        default ContentType getContentType()
        Gets the Content-Type entity-Header-Field HeaderField.CONTENT_TYPE: "... The Content-Type entity-Header-Field indicates the media type of the entity-body sent to the recipient ..."
        Returns:
        The media type being used for the body.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putContentType

        default ContentType putContentType​(HttpMediaType aHttpMediaType)
        Sets the Content-Type entity-Header-Field HeaderField.CONTENT_TYPE. You may pass a MediaType or a ContentType instance as them both implement the HttpMediaTypeAccessor.HttpMediaTypeProvider interface: "... The Content-Type entity-Header-Field indicates the media type of the entity-body sent to the recipient ..."
        Parameters:
        aHttpMediaType - The media type used for the body.
        Returns:
        The replaced element (if any, else null).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putContentType

        default ContentType putContentType​(MediaType aMediaType,
                                   Map<String,​String> aParameters)
        Sets the Content-Type entity-Header-Field HeaderField.CONTENT_TYPE. : "... The Content-Type entity-Header-Field indicates the media type of the entity-body sent to the recipient ..."
        Parameters:
        aMediaType - The media type used for the body.
        aParameters - The Content-Type's parameters.
        Returns:
        The replaced element (if any, else null).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withContentType

        default B withContentType​(HttpMediaType aHttpMediaType)
        Sets the Content-Type entity-Header-Field HeaderField.CONTENT_TYPE. You may pass a MediaType or a ContentType instance as them both implement the HttpMediaTypeAccessor.HttpMediaTypeProvider interface: "... The Content-Type entity-Header-Field indicates the media type of the entity-body sent to the recipient ..."
        Parameters:
        aHttpMediaType - The media type used for the body.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withContentType

        default B withContentType​(MediaType aMediaType,
                          Map<String,​String> aParameters)
        Sets the Content-Type's MediaType and the parameters for the HTTP body.
        Parameters:
        aMediaType - The media type used for the body.
        aParameters - The Content-Type's parameters.
        Returns:
        This object as of the Builder-Pattern.

      • removeContentType

        default ContentType removeContentType()
        Removes the Content-Type entity-Header-Field HeaderField.CONTENT_TYPE. : "... The Content-Type entity-Header-Field indicates the media type of the entity-body sent to the recipient ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getAcceptTypes

        default List<ContentType> getAcceptTypes()
        Gets the Accept request-Header-Field HeaderField.ACCEPT: "... The Accept request-Header-Field can be used to specify certain media types which are acceptable for the response. Accept headers can be used to indicate that the request is specifically limited to a small set of desired ..."
        Returns:
        The expected (supported) kinds of MediaType and the according parameters (being actually instances of the ContentType type).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getUnknownAcceptTypes

        default List<String> getUnknownAcceptTypes()
        Gets the unresolvable (unknown) Accept request-Header-Field HeaderField.ACCEPT. E.g. the ones which cannot be mapped by the enumeration MediaType.
        Returns:
        the unknown accept types
        See Also:
        getAcceptTypes()

      • withAcceptTypes

        default B withAcceptTypes​(HttpMediaType... aHttpMediaType)
        Sets the Accept request-Header-Field HeaderField.ACCEPT. You may pass a MediaType or a ContentType instance as them both implement the HttpMediaTypeAccessor.HttpMediaTypeProvider interface: "... The Accept request-Header-Field can be used to specify certain media types which are acceptable for the response. Accept headers can be used to indicate that the request is specifically limited to a small set of desired types ..."
        Parameters:
        aHttpMediaType - The according HttpMediaTypeAccessor.HttpMediaTypeProvider.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAcceptTypes

        default B withAcceptTypes​(List<? extends HttpMediaType> aHttpMediaType)
        Sets the Accept request-Header-Field HeaderField.ACCEPT. You may pass a MediaType or a ContentType instance as them both implement the HttpMediaTypeAccessor.HttpMediaTypeProvider interface: "... The Accept request-Header-Field can be used to specify certain media types which are acceptable for the response. Accept headers can be used to indicate that the request is specifically limited to a small set of desired types ..."
        Parameters:
        aHttpMediaType - The according HttpMediaTypeAccessor.HttpMediaTypeProvider.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeAcceptTypes

        default List<ContentType> removeAcceptTypes()
        Removes the Accept request-Header-Field HeaderField.ACCEPT: "... The Accept request-Header-Field can be used to specify certain media types which are acceptable for the response. Accept headers can be used to indicate that the request is specifically limited to a small set of desired types ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getAcceptCharsets

        default List<String> getAcceptCharsets()
        Gets the Accept-Charset request-Header-Field HeaderField.ACCEPT_CHARSET. "... The Accept-Charset request-Header-Field can be used to indicate what character sets are acceptable for the response. This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal that capability to a server which is capable of representing documents in those character sets ..."
        Returns:
        The Accept-Charset expected by a client from a server.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putAcceptCharsets

        default List<String> putAcceptCharsets​(String... aAcceptCharsets)
        Sets the Accept-Charset request-Header-Field HeaderField.ACCEPT_CHARSET. "... The Accept-Charset request-Header-Field can be used to indicate what character sets are acceptable for the response. This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal that capability to a server which is capable of representing documents in those character sets ..."
        Parameters:
        aAcceptCharsets - The Accept-Charset expected by a client from a server.
        Returns:
        The replaced elements (if any, else null).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putAcceptCharsets

        default List<String> putAcceptCharsets​(List<String> aAcceptCharsets)
        Sets the Accept-Charset request-Header-Field HeaderField.ACCEPT_CHARSET. "... The Accept-Charset request-Header-Field can be used to indicate what character sets are acceptable for the response. This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal that capability to a server which is capable of representing documents in those character sets ..."
        Parameters:
        aAcceptCharsets - The Accept-Charset expected by a client from a server.
        Returns:
        The replaced elements (if any, else null).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAcceptCharsets

        default B withAcceptCharsets​(List<String> aAcceptCharsets)
        Sets the the Accept-Charset request-Header-Field HeaderField.ACCEPT_CHARSET. "... The Accept-Charset request-Header-Field can be used to indicate what character sets are acceptable for the response. This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal that capability to a server which is capable of representing documents in those character sets ..."
        Parameters:
        aAcceptCharsets - The Accept-Charset expected by a client from a server.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAcceptCharsets

        default B withAcceptCharsets​(String... aAcceptCharsets)
        Sets the Accept-Charset request-Header-Field HeaderField.ACCEPT_CHARSET. "... The Accept-Charset request-Header-Field can be used to indicate what character sets are acceptable for the response. This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal that capability to a server which is capable of representing documents in those character sets ..."
        Parameters:
        aAcceptCharsets - The Accept-Charset expected by a client from a server.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeAcceptCharsets

        default List<String> removeAcceptCharsets()
        Removes the Accept-Charset request-Header-Field HeaderField.ACCEPT_CHARSET. "... The Accept-Charset request-Header-Field can be used to indicate what character sets are acceptable for the response. This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal that capability to a server which is capable of representing documents in those character sets ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getAcceptEncodings

        default List<ContentEncoding> getAcceptEncodings()
        Gets the the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Returns:
        The expected (supported) kinds of encodings.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html", "https://developer.mozilla.org/de/docs/Web/HTTP/Headers/Content-Encoding"

      • putAcceptEncodings

        default List<ContentEncoding> putAcceptEncodings​(ContentEncoding... aEncodings)
        Sets the the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Parameters:
        aEncodings - The according encodings.
        Returns:
        the list
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html", "https://developer.mozilla.org/de/docs/Web/HTTP/Headers/Content-Encoding"

      • putAcceptEncodings

        default List<ContentEncoding> putAcceptEncodings​(List<ContentEncoding> aEncodings)
        Sets the the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Parameters:
        aEncodings - The according encodings.
        Returns:
        the list
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html", "https://developer.mozilla.org/de/docs/Web/HTTP/Headers/Content-Encoding"

      • withAcceptEncodings

        default B withAcceptEncodings​(ContentEncoding... aEncodings)
        Sets the the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Parameters:
        aEncodings - The according encodings.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html", "https://developer.mozilla.org/de/docs/Web/HTTP/Headers/Content-Encoding"

      • withAcceptEncodings

        default B withAcceptEncodings​(List<ContentEncoding> aEncodings)
        Sets the the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Parameters:
        aEncodings - The according encodings.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html", "https://developer.mozilla.org/de/docs/Web/HTTP/Headers/Content-Encoding"

      • removeAcceptEncodings

        default List<ContentEncoding> removeAcceptEncodings()
        Removes the the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getAcceptLanguages

        default List<Locale> getAcceptLanguages()
        Gets the the Content-Encoding entity-Header-Field HeaderField.ACCEPT_LANGUAGE:
        Returns:
        The expected (supported) kinds of languages.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putAcceptLanguages

        default List<Locale> putAcceptLanguages​(Locale... aLanguages)
        Sets the the Content-Encoding entity-Header-Field HeaderField.ACCEPT_LANGUAGE:
        Parameters:
        aLanguages - The according languages.
        Returns:
        the list
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putAcceptLanguages

        default List<Locale> putAcceptLanguages​(List<Locale> aLanguages)
        Sets the the Content-Encoding entity-Header-Field HeaderField.ACCEPT_LANGUAGE:
        Parameters:
        aLanguages - The according languages.
        Returns:
        the list
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAcceptLanguages

        default B withAcceptLanguages​(Locale... aLanguages)
        Sets the the Content-Encoding entity-Header-Field HeaderField.ACCEPT_LANGUAGE:
        Parameters:
        aLanguages - The according languages.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAcceptLanguages

        default B withAcceptLanguages​(List<Locale> aLanguages)
        Sets the the Content-Encoding entity-Header-Field HeaderField.ACCEPT_LANGUAGE: "... The Accept-Language request HTTP header advertises which languages the client is able to understand, and which locale variant is preferred ..."
        Parameters:
        aLanguages - The according languages.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language"

      • removeAcceptLanguages

        default List<Locale> removeAcceptLanguages()
        Removes the the Content-Encoding entity-Header-Field HeaderField.ACCEPT_LANGUAGE: "... The Accept-Language request HTTP header advertises which languages the client is able to understand, and which locale variant is preferred ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language"

      • getContentEncoding

        default ContentEncoding getContentEncoding()
        Gets the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Returns:
        The communication partner's HTTP body's encoding.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putContentEncoding

        default ContentEncoding putContentEncoding​(ContentEncoding aEncoding)
        Sets the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Parameters:
        aEncoding - The HTTP body's content encoding.
        Returns:
        the content encoding
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withContentEncoding

        default B withContentEncoding​(ContentEncoding aEncoding)
        Sets the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Parameters:
        aEncoding - The HTTP body's content encoding.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeContentEncoding

        default ContentEncoding removeContentEncoding()
        Removes the Content-Encoding entity-Header-Field HeaderField.CONTENT_ENCODING: "... The Content-Encoding entity-Header-Field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type Header-Field. Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getUserAgent

        default String getUserAgent()
        Gets the User-Agent request-Header-Field HeaderField.USER_AGENT: "... The User-Agent request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Returns:
        The according user agent.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putUserAgent

        default String putUserAgent​(String aUserAgent)
        Sets the User-Agent request-Header-Field HeaderField.USER_AGENT: "... The User-Agent request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Parameters:
        aUserAgent - The according user agent.
        Returns:
        the string
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withUserAgent

        default B withUserAgent​(String aUserAgent)
        Sets he User-Agent request-Header-Field HeaderField.USER_AGENT: "... The User-Agent request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Parameters:
        aUserAgent - The according user agent.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeUserAgent

        default String removeUserAgent()
        Removes he User-Agent request-Header-Field HeaderField.USER_AGENT : "... The User-Agent request-Header-Field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. User agents SHOULD include this field with requests ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getHost

        default String getHost()
        Gets the Host request-Header-Field HeaderField.HOST: "... The Host request-Header-Field specifies the Internet host and port number of the resource being requested, as obtained from the original URI given by the user or referring resource ..."
        Returns:
        The according host.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putHost

        default String putHost​(String aHost)
        Sets the Host request-Header-Field HeaderField.HOST: "... The Host request-Header-Field specifies the Internet host and port number of the resource being requested, as obtained from the original URI given by the user or referring resource ..."
        Parameters:
        aHost - The according host.
        Returns:
        the string
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withHost

        default B withHost​(String aHost)
        Sets the Host request-Header-Field HeaderField.HOST: "... The Host request-Header-Field specifies the Internet host and port number of the resource being requested, as obtained from the original URI given by the user or referring resource ..."
        Parameters:
        aHost - The according host.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeHost

        default String removeHost()
        Removes the Host request-Header-Field HeaderField.HOST: "... The Host request-Header-Field specifies the Internet host and port number of the resource being requested, as obtained from the original URI given by the user or referring resource ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getRequestId

        default String getRequestId()
        Gets the (interprocess) Request-Correlation TID field HeaderField.REQUEST_ID: A Request-Correlation TID is an TID to uniquely identify an entity (request) across multiple systems.
        Returns:
        The according Request-Correlation TID.

      • putRequestId

        default String putRequestId​(String aRequestId)
        Sets the (interprocess) Request-Correlation TID field HeaderField.REQUEST_ID: A Request-Correlation TID is an TID to uniquely identify an entity (request) across multiple systems.
        Parameters:
        aRequestId - The according Request-Correlation TID.
        Returns:
        The value being removed (or null if none was set).

      • withRequestId

        default B withRequestId​(String aRequestId)
        Sets the (interprocess) Request-Correlation TID field HeaderField.REQUEST_ID: A Request-Correlation TID is an TID to uniquely identify an entity (request) across multiple systems.
        Parameters:
        aRequestId - The according Request-Correlation TID.
        Returns:
        This object as of the Builder-Pattern.

      • removeRequestId

        default String removeRequestId()
        Removes the (interprocess) Request-Correlation TID field HeaderField.REQUEST_ID: A Request-Correlation TID is an TID to uniquely identify an entity (request) across multiple systems.
        Returns:
        The value being removed (or null if none was set).

      • getSessionId

        default String getSessionId()
        Gets the (interprocess) Session-Correlation TID field HeaderField.SESSION_ID: A Session-Correlation TID is an TID to uniquely identify an entity (session) across multiple systems.
        Returns:
        The according Session-Correlation TID.

      • putSessionId

        default String putSessionId​(String aSessionId)
        Sets the (interprocess) Session-Correlation TID field HeaderField.SESSION_ID: A Session-Correlation TID is an TID to uniquely identify an entity (session) across multiple systems.
        Parameters:
        aSessionId - The according Session-Correlation TID.
        Returns:
        The value being removed (or null if none was set).

      • withSessionId

        default B withSessionId​(String aSessionId)
        Sets the (interprocess) Session-Correlation TID field HeaderField.SESSION_ID: A Session-Correlation TID is an TID to uniquely identify an entity (session) across multiple systems.
        Parameters:
        aSessionId - The according Session-Correlation TID.
        Returns:
        This object as of the Builder-Pattern.

      • removeSessionId

        default String removeSessionId()
        Removes the (interprocess) Session-Correlation TID field HeaderField.SESSION_ID: A Session-Correlation TID is an TID to uniquely identify an entity (session) across multiple systems.
        Returns:
        The value being removed (or null if none was set).

      • getAuthenticate

        default String getAuthenticate()
        Gets the WWW-Authenticate Response-Header-Field HeaderField.WWW_AUTHENTICATE: "... The WWW-Authenticate Response-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Returns:
        The according WWW-Authenticate field.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • putAuthenticate

        default String putAuthenticate​(String aAuthenticate)
        Sets the WWW-Authenticate Response-Header-Field HeaderField.WWW_AUTHENTICATE: "... The WWW-Authenticate Response-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthenticate - The according WWW-Authenticate field.
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • withAuthenticate

        default B withAuthenticate​(String aAuthenticate)
        Sets the WWW-Authenticate Response-Header-Field HeaderField.WWW_AUTHENTICATE: "... The WWW-Authenticate Response-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthenticate - The according WWW-Authenticate field.
        Returns:
        This object as of the Builder-Pattern.
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • removeAuthenticate

        default String removeAuthenticate()
        Removes the WWW-Authenticate Response-Header-Field HeaderField.WWW_AUTHENTICATE: "... The WWW-Authenticate Response-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Returns:
        The value being removed (or null if none was set).
        See Also:
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

      • getBasicAuth

        default String getBasicAuth()
        Retrieves the WWW-Authenticate field for Basic-Authentication. If not set or another kind of authorization is set, then null is returned. Use getAuthenticate() to get the field's value no matter which kind of authenticate is used.
        Returns:
        The WWW-Authenticate field for Basic-Authentication or null if there is no value for the given field or it does not declare Basic-Authentication.

      • putBasicAuthRequired

        default String putBasicAuthRequired​(String aRealm)
        Sets the WWW-Authenticate field for Basic-Authentication with the given realm.
        Parameters:
        aRealm - The realm to be set for Basic-Authentication of the WWW-authenticate field.
        Returns:
        The value being removed (or null if none was set).

      • withBasicAuthRequired

        default B withBasicAuthRequired​(String aRealm)
        Sets the WWW-Authenticate field for Basic-Authentication with the given realm.
        Parameters:
        aRealm - The realm to be set for Basic-Authentication of the WWW-authenticate field.
        Returns:
        This object as of the Builder-Pattern.

      • removeBasicAuthenticate

        default String removeBasicAuthenticate()
        Removes the WWW-Authenticate field for Basic-Authentication. If not set or another kind of authorization is set, then null is returned and the field is not removed. Use removeAuthenticate() to remove the field's value no matter which kind of authenticate is used.
        Returns:
        The value being removed (or null if none or none for basic authentication was set).

      • getAuthorization

        default String getAuthorization()
        Gets the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Returns:
        The according Authorize field.

      • putAuthorization

        default String putAuthorization​(String aAuthType,
                                String aAuthorize)
        Sets the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthType - The AuthType to be used.
        aAuthorize - The according Authorize field.
        Returns:
        The value being removed (or null if none was set).

      • withAuthorization

        default B withAuthorization​(String aAuthType,
                            String aAuthorize)
        Sets the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthorize - The according Authorize field.
        aAuthType - The AuthType to be used.
        Returns:
        This object as of the Builder-Pattern.

      • putAuthorization

        default String putAuthorization​(AuthType aAuthType,
                                String aAuthorize)
        Sets the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthType - The AuthType to be used.
        aAuthorize - The according Authorize field.
        Returns:
        The value being removed (or null if none was set).

      • withAuthorization

        default B withAuthorization​(AuthType aAuthType,
                            String aAuthorize)
        Sets the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthorize - The according Authorize field.
        aAuthType - The AuthType to be used.
        Returns:
        This object as of the Builder-Pattern.

      • putAuthorization

        default String putAuthorization​(String aAuthorize)
        Sets the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthorize - The according Authorize field.
        Returns:
        The value being removed (or null if none was set).

      • withAuthorization

        default B withAuthorization​(String aAuthorize)
        Sets the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Parameters:
        aAuthorize - The according Authorize field.
        Returns:
        This object as of the Builder-Pattern.

      • removeAuthorization

        default String removeAuthorization()
        Removes the Authorize Request-Header-Field HeaderField.AUTHORIZATION: "... The Authorize Request-Header-Field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI ..."
        Returns:
        The value being removed (or null if none was set).

      • withBearerAuthCredentials

        default B withBearerAuthCredentials​(BearerAuthCredentials aBearerAuthCredentials)
        Sets the BearerAuthCredentials (token) for HTTP bearer authentication.
        Parameters:
        aBearerAuthCredentials - The credentials (token).
        Returns:
        This object as of the Builder-Pattern.

      • withBearerAuthCredentials

        default B withBearerAuthCredentials​(String aToken)
        Sets the token (secret) for HTTP bearer authentication.
        Parameters:
        aToken - The password part of the credentials.
        Returns:
        This object as of the Builder-Pattern.

      • removeBearerAuthCredentials

        default BearerAuthCredentials removeBearerAuthCredentials()
        Removes the BearerAuthCredentials (token) for HTTP bearer authentication.
        Returns:
        The value being removed (or null if none was set).

      • getBasicAuthCredentials

        default BasicAuthCredentials getBasicAuthCredentials()
        Retrieves the BasicAuthCredentials from the request (or null if there are none such credentials). Throw an UnauthorizedException in case you do not agree with the credentials you find there.
        Returns:
        The BasicAuthCredentials stored by the basic authentication credentials property (or null if there are none such credentials).

      • withBasicAuthCredentials

        default B withBasicAuthCredentials​(BasicAuthCredentials aBasicAuthCredentials)
        Sets the BasicAuthCredentials (user name and secret) for HTTP Basic-Authentication.
        Parameters:
        aBasicAuthCredentials - The credentials (user name and secret).
        Returns:
        This object as of the Builder-Pattern.

      • withBasicAuthCredentials

        default B withBasicAuthCredentials​(String aUserName,
                                   String aSecret)
        Sets the user name and secret (password) for HTTP Basic-Authentication.
        Parameters:
        aUserName - The user name part of the credentials.
        aSecret - The password part of the credentials.
        Returns:
        This object as of the Builder-Pattern.

      • removeBasicAuthCredentials

        default BasicAuthCredentials removeBasicAuthCredentials()
        Removes the BasicAuthCredentials (user name and secret) for HTTP Basic-Authentication.
        Returns:
        The value being removed (or null if none was set).

      • get

        default List<String> get​(HeaderField aHeaderField)
        Gets the values for the according Header-Field.
        Parameters:
        aHeaderField - The Header-Field
        Returns:
        The list of values.

      • getFirst

        default String getFirst​(HeaderField aHeaderField)
        Gets the first value of the according Header-Field.
        Parameters:
        aHeaderField - The a Header-Field
        Returns:
        The first value.

      • addTo

        default void addTo​(HeaderField aHeaderField,
                   String aValue)
        Adds the value to the given Header-Field.
        Parameters:
        aHeaderField - The Header-Field.
        aValue - The a value to be added.

      • addTo

        default void addTo​(HeaderField aHeaderField,
                   String... aValues)
        Adds the given values to the according Header-Field.
        Parameters:
        aHeaderField - The Header-Field.
        aValues - The a values to be added.

      • addTo

        default void addTo​(HeaderField aHeaderField,
                   List<String> aValues)
        Adds the given values to the according Header-Field.
        Parameters:
        aHeaderField - The Header-Field.
        aValues - The a values to be added.

      • put

        default List<String> put​(HeaderField aHeaderField,
                         String aValue)
        Puts (replaces) the currently set Header-Field values with the provided one.
        Parameters:
        aHeaderField - The a Header-Field.
        aValue - The value with which to replace the currently set Header-Field values.
        Returns:
        The List with the previously set Header-Field values.

      • put

        default List<String> put​(HeaderField aHeaderField,
                         String... aValues)
        Puts (replaces) the currently set Header-Field values with the provided ones.
        Parameters:
        aHeaderField - The a Header-Field.
        aValues - The values with which to replace the currently set Header-Field values.
        Returns:
        The List with the previously set Header-Field values.

      • put

        default List<String> put​(HeaderField aHeaderField,
                         List<String> aValues)
        Puts (replaces) the currently set Header-Field values with the provided ones.
        Parameters:
        aHeaderField - The a Header-Field.
        aValues - The values with which to replace the currently set Header-Field values.
        Returns:
        The List with the previously set Header-Field values.

      • remove

        default List<String> remove​(HeaderField aHeaderField)
        Removes the values from the given Header-Field.
        Parameters:
        aHeaderField - The a Header-Field for which to remove the values.
        Returns:
        The List with the previously set Header-Field values.

      • toHttpCookies

        default String[] toHttpCookies()
        Creates a HTTP Header-Field value from the herein stored Cookie instances.
        Returns:
        The text representing the HTTP Header-Field for the herein stored cookies.

      • toHeaderFields

        default void toHeaderFields​(Map<String,​List<String>> aToFields)
        Copies the Header-Fields into the provided Map. This is useful when some underlying system provides an own instance of Header-Fields to be filled.
        Parameters:
        aToFields - The Map where to copy the Header-Fields to.