Package io.servicetalk.http.api

Class HeaderUtils

java.lang.Object

io.servicetalk.http.api.HeaderUtils

public final class HeaderUtils
extends java.lang.Object

Utilities to use for HttpHeaders implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderUtils.CookiesByNameIterator	An Iterator of HttpCookiePair designed to iterate across multiple values of HttpHeaderNames.COOKIE for a specific cookie-name.
static class	HeaderUtils.CookiesIterator	An Iterator of HttpCookiePair designed to iterate across multiple values of HttpHeaderNames.COOKIE.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.function.BiFunction<? super java.lang.CharSequence,? super java.lang.CharSequence,java.lang.CharSequence>	DEFAULT_HEADER_FILTER

Method Summary

Modifier and Type	Method	Description
static boolean	domainMatches(java.lang.CharSequence requestDomain, java.lang.CharSequence cookieDomain)	Domain Matching.
static boolean	hasContentType(HttpHeaders headers, java.lang.CharSequence expectedContentType, java.nio.charset.Charset expectedCharset)	Checks if the provider headers contain a Content-Type header that matches the specified content type, and optionally the provided charset.
static boolean	isSetCookieNameMatches(java.lang.CharSequence setCookieString, java.lang.CharSequence setCookieName)	Determine if a set-cookie-string's cookie-name matches setCookieName.
static boolean	isTransferEncodingChunked(HttpHeaders headers)	Returns true if headers indicates transfer-encoding chunked.
static HttpCookiePair	parseCookiePair(java.lang.CharSequence cookieString, java.lang.CharSequence cookiePairName)	Parse a single cookie-pair from a cookie-string.
static HttpSetCookie	parseSetCookie(java.lang.CharSequence setCookieString, java.lang.CharSequence setCookieName, boolean validate)	Parse a HttpSetCookie from a set-cookie-string.
static boolean	pathMatches(java.lang.CharSequence requestPath, java.lang.CharSequence cookiePath)	Path Matching.
static java.lang.CharSequence	removeCookiePairs(java.lang.CharSequence cookieString, java.lang.CharSequence cookiePairName)	Remove a single cookie-pair for a cookie-string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_HEADER_FILTER

public static final java.util.function.BiFunction<? super java.lang.CharSequence,? super java.lang.CharSequence,java.lang.CharSequence> DEFAULT_HEADER_FILTER

Method Detail

isTransferEncodingChunked

public static boolean isTransferEncodingChunked(HttpHeaders headers)

Returns true if headers indicates transfer-encoding chunked.

The values of all HttpHeaderNames.TRANSFER_ENCODING headers are interpreted as comma-separated values, with spaces between values trimmed. If any of these values is HttpHeaderValues.CHUNKED, this method return true, otherwise it returns false.

Parameters:

headers - The HttpHeaders to check.

Returns:

true if headers indicates transfer-encoding chunked, false otherwise.

domainMatches

public static boolean domainMatches(java.lang.CharSequence requestDomain,
                                    @Nullable
                                    java.lang.CharSequence cookieDomain)

Domain Matching.

Parameters:

requestDomain - The domain from the request.

cookieDomain - The domain from the cookie.

Returns:

true if there is a match.

pathMatches

public static boolean pathMatches(java.lang.CharSequence requestPath,
                                  @Nullable
                                  java.lang.CharSequence cookiePath)

Path Matching.

Parameters:

requestPath - The path from the request.

cookiePath - The path from the cookie.

Returns:

true if there is a match.

isSetCookieNameMatches

public static boolean isSetCookieNameMatches(java.lang.CharSequence setCookieString,
                                             java.lang.CharSequence setCookieName)

Determine if a set-cookie-string's cookie-name matches setCookieName.

Parameters:

setCookieString - The set-cookie-string.

setCookieName - The cookie-name.

Returns:

true if a set-cookie-string's cookie-name matches setCookieName.

parseSetCookie

@Nullable
public static HttpSetCookie parseSetCookie(java.lang.CharSequence setCookieString,
                                           java.lang.CharSequence setCookieName,
                                           boolean validate)

Parse a HttpSetCookie from a set-cookie-string.

Parameters:

setCookieString - The set-cookie-string.

setCookieName - The cookie-name.

validate - true to attempt extra validation.

Returns:

a HttpSetCookie from a set-cookie-string.

parseCookiePair

@Nullable
public static HttpCookiePair parseCookiePair(java.lang.CharSequence cookieString,
                                             java.lang.CharSequence cookiePairName)

Parse a single cookie-pair from a cookie-string.

Parameters:

cookieString - The cookie-string that may contain multiple cookie-pairs.

cookiePairName - The cookie-name identifying the cookie-pairs to parse.

Returns:

• The first cookie-pair from a cookie-string whose cookie-name matched cookiePairName
• null if no matches were found

removeCookiePairs

@Nullable
public static java.lang.CharSequence removeCookiePairs(java.lang.CharSequence cookieString,
                                                       java.lang.CharSequence cookiePairName)

Remove a single cookie-pair for a cookie-string.

Parameters:

cookieString - The cookie-string that may contain multiple cookie-pairs.

cookiePairName - The cookie-name identifying the cookie-pairs to remove.

Returns:

• The cookie-string value with all cookie-pairs removed whose cookie-name matches cookiePairName
• Empty if all the cookie-pairs matched cookiePairName
• null if none of the cookie-pairs matched cookiePairName

hasContentType

public static boolean hasContentType(HttpHeaders headers,
                                     java.lang.CharSequence expectedContentType,
                                     @Nullable
                                     java.nio.charset.Charset expectedCharset)

Checks if the provider headers contain a Content-Type header that matches the specified content type, and optionally the provided charset.

Parameters:

headers - the HttpHeaders instance

expectedContentType - the content type to look for, provided as a type/subtype

expectedCharset - an optional charset constraint.

Returns:

true if a Content-Type header that matches the specified content type, and optionally the provided charset has been found, false otherwise.

See Also:

Syntax of the Content-Type Header Field