Vert.x 4.5.13 · io.vertx.core.http.impl.HttpUtils · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv static final TagExtractor<HttpRequestHead>	CLIENT_HTTP_REQUEST_TAG_EXTRACTOR
pack-priv static final TagExtractor<HttpResponseHead>	CLIENT_RESPONSE_TAG_EXTRACTOR
pack-priv static final HttpClosedException	CONNECTION_CLOSED_EXCEPTION
private static final int	CR_STATE
pack-priv static final StreamPriority	DEFAULT_STREAM_PRIORITY
pack-priv static final String	H2_STREAM_BYTE_DISTRIBUTOR
private static final Consumer<CharSequence>	HEADER_VALUE_VALIDATOR
private static final int	HIGHEST_INVALID_VALUE_CHAR_MASK
private static final int	LF_STATE
private static final int	NO_CR_LF_STATE
pack-priv static final int	SC_BAD_GATEWAY
pack-priv static final int	SC_SWITCHING_PROTOCOLS
pack-priv static final TagExtractor<HttpServerRequest>	SERVER_REQUEST_TAG_EXTRACTOR
pack-priv static final TagExtractor<HttpServerResponse>	SERVER_RESPONSE_TAG_EXTRACTOR
private static final String[]	SMALL_POSITIVE_LONGS
pack-priv static final HttpClosedException	STREAM_CLOSED_EXCEPTION
private static final AsciiString	TIMEOUT_EQ
pack-priv static final String	UNIFORM_DISTRIBUTOR
private static final boolean[]	VALID_H_NAME_ASCII_CHARS

Access	Constructor and Description
private	HttpUtils()

Method Summary

Modifier and Type	Method and Description
pack-priv static String	absoluteURI(String serverOrigin, HttpServerRequest req)
public static boolean	canUpgradeToWebSocket(HttpServerRequest req)
pack-priv static Http2Settings	decodeSettings(String base64Settings)
private static void	decodeUnreserved(StringBuilder path, int start)
private static void	decodeUnreservedChars(StringBuilder path, int start)
public static String	encodeSettings(Http2Settings settings)
public static void	fromVertxInitialSettings(boolean server, Http2Settings vertxSettings, Http2Settings nettySettings)
public static Http2Settings	fromVertxSettings(Http2Settings settings)
public static ByteBuf	generateWSCloseFrameByteBuf(short statusCode, String reason)
pack-priv static String	getWebSocketLocation(HttpServerRequest req, boolean ssl)
private static int	indexOfSlash(CharSequence str, int start)
pack-priv static boolean	isConnectOrUpgrade(HttpMethod method, MultiMap headers)
pack-priv static boolean	isKeepAlive(HttpRequest request)
public static boolean	isValidHostAuthority(String host)
public static boolean	isValidMultipartContentType(String contentType)
public static boolean	isValidMultipartMethod(HttpMethod method)
private static boolean	matches(CharSequence path, int start, String what)
private static boolean	matches(CharSequence path, int start, String what, boolean exact)
public static String	Returns: normalized path normalizePath(String raw path pathname) Normalizes a path as per rfc3986.
private static String	normalizePathSlow(String pathname, int indexOfFirstPercent)
pack-priv static MultiMap	params(String uri, Charset charset, boolean semicolonIsNormalChar)
public static int	parseKeepAliveHeaderTimeout(CharSequence value)
pack-priv static String	parsePath(String uri) Extract the path out of the uri.
pack-priv static String	parseQuery(String uri) Extract the query out of a uri or returns the empty string if no query was found.
public static String	positiveLongToString(long value) This try hard to cache the first 256 positive longs as strings [0, 255] to avoid the cost of creating a new string for each of them.
public static String	Returns: normalized path removeDots(CharSequence raw path path) Removed dots as per rfc3986.
pack-priv static void	resolveFile(VertxInternal vertx, String filename, long offset, long length, Handler<AsyncResult<AsyncFile>> resultHandler)
public static URI	resolveURIReference(String base, String ref) Resolve an URI reference as per rfc3986
public static URI	resolveURIReference(URI base, String ref) Resolve an URI reference as per rfc3986
pack-priv static void	sendError(Channel ch, HttpResponseStatus status)
pack-priv static void	sendError(Channel ch, HttpResponseStatus status, CharSequence err)
public static HostAndPort	Returns: The converted instance or `null` if not applicable. socketAddressToHostAndPort(SocketAddress The socket address to convert socketAddress) Convert a `SocketAddress` to a `HostAndPort`.
private static CharSequence	toCharSequenceLowerCase(CharSequence sequence)
public static CharSequence	Returns: convert the `sequence` to a lower case instance toLowerCase(CharSequence sequence) This is optimized for Http headers, which are usually in the form: eg Content-Length, content-length
private static CharSequence	toLowerCase(char[] chars, int firstUpperCase, int length)
pack-priv static HttpVersion	toNettyHttpVersion(HttpVersion version)
pack-priv static HttpMethod	toVertxMethod(String method)
public static Http2Settings	toVertxSettings(Http2Settings settings)
pack-priv static boolean	useH2UniformStreamByteDistributor()
private static void	validateAsciiHeaderName(AsciiString value)
private static void	validateAsciiHeaderValue(AsciiString value)
private static void	validateAsciiRangeHeaderValue(AsciiString value, int off, int length, byte[] asciiChars) This method is the slow-path generic version of `validateAsciiHeaderValue(AsciiString)` which is optimized for `AsciiString` instances which are backed by a 0-offset full-blown byte array.
private static int	validateCrLfChar(CharSequence seq, int state, char ch)
public static void	validateHeader(CharSequence name, CharSequence value)
public static void	validateHeader(CharSequence name, Iterable<? extends CharSequence> values)
public static void	validateHeaderName(CharSequence value)
public static void	validateHeaderValue(CharSequence value)
private static void	validateNonPrintableCtrlChar(CharSequence seq, int ch)
private static void	validateSequenceHeaderName(CharSequence value)
private static void	validateSequenceHeaderValue(CharSequence value)
private static void	validateSequenceHeaderValue(CharSequence seq, int index) This method is taken as we need to validate the header value for the non-printable characters.
private static void	validateStringHeaderName(String value)
private static void	validateStringHeaderValue(String value)
private static int	validateValueChar(CharSequence seq, int state, char ch)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CLIENT_HTTP_REQUEST_TAG_EXTRACTOR	back to summary
pack-priv static final TagExtractor<HttpRequestHead> CLIENT_HTTP_REQUEST_TAG_EXTRACTOR

CLIENT_RESPONSE_TAG_EXTRACTOR	back to summary
pack-priv static final TagExtractor<HttpResponseHead> CLIENT_RESPONSE_TAG_EXTRACTOR

CONNECTION_CLOSED_EXCEPTION	back to summary
pack-priv static final HttpClosedException CONNECTION_CLOSED_EXCEPTION

CR_STATE	back to summary
private static final int CR_STATE

DEFAULT_STREAM_PRIORITY	back to summary
pack-priv static final StreamPriority DEFAULT_STREAM_PRIORITY

H2_STREAM_BYTE_DISTRIBUTOR	back to summary
pack-priv static final String H2_STREAM_BYTE_DISTRIBUTOR

HEADER_VALUE_VALIDATOR	back to summary
private static final Consumer<CharSequence> HEADER_VALUE_VALIDATOR

HIGHEST_INVALID_VALUE_CHAR_MASK	back to summary
private static final int HIGHEST_INVALID_VALUE_CHAR_MASK

LF_STATE	back to summary
private static final int LF_STATE

NO_CR_LF_STATE	back to summary
private static final int NO_CR_LF_STATE

SC_BAD_GATEWAY	back to summary
pack-priv static final int SC_BAD_GATEWAY

SC_SWITCHING_PROTOCOLS	back to summary
pack-priv static final int SC_SWITCHING_PROTOCOLS

SERVER_REQUEST_TAG_EXTRACTOR	back to summary
pack-priv static final TagExtractor<HttpServerRequest> SERVER_REQUEST_TAG_EXTRACTOR

SERVER_RESPONSE_TAG_EXTRACTOR	back to summary
pack-priv static final TagExtractor<HttpServerResponse> SERVER_RESPONSE_TAG_EXTRACTOR

SMALL_POSITIVE_LONGS	back to summary
private static final String[] SMALL_POSITIVE_LONGS

STREAM_CLOSED_EXCEPTION	back to summary
pack-priv static final HttpClosedException STREAM_CLOSED_EXCEPTION

TIMEOUT_EQ	back to summary
private static final AsciiString TIMEOUT_EQ

UNIFORM_DISTRIBUTOR	back to summary
pack-priv static final String UNIFORM_DISTRIBUTOR

VALID_H_NAME_ASCII_CHARS	back to summary
private static final boolean[] VALID_H_NAME_ASCII_CHARS

Constructor Detail

HttpUtils	back to summary
private HttpUtils()

Method Detail

absoluteURI	back to summary
pack-priv static String absoluteURI(String serverOrigin, HttpServerRequest req)

canUpgradeToWebSocket	back to summary
public static boolean canUpgradeToWebSocket(HttpServerRequest req)

decodeSettings	back to summary
pack-priv static Http2Settings decodeSettings(String base64Settings)

decodeUnreserved	back to summary
private static void decodeUnreserved(StringBuilder path, int start)

decodeUnreservedChars	back to summary
private static void decodeUnreservedChars(StringBuilder path, int start)

encodeSettings	back to summary
public static String encodeSettings(Http2Settings settings)

fromVertxInitialSettings	back to summary
public static void fromVertxInitialSettings(boolean server, Http2Settings vertxSettings, Http2Settings nettySettings)

fromVertxSettings	back to summary
public static Http2Settings fromVertxSettings(Http2Settings settings)

generateWSCloseFrameByteBuf	back to summary
public static ByteBuf generateWSCloseFrameByteBuf(short statusCode, String reason)

getWebSocketLocation	back to summary
pack-priv static String getWebSocketLocation(HttpServerRequest req, boolean ssl) throws Exception

indexOfSlash	back to summary
private static int indexOfSlash(CharSequence str, int start)

isConnectOrUpgrade	back to summary
pack-priv static boolean isConnectOrUpgrade(HttpMethod method, MultiMap headers)

isKeepAlive	back to summary
pack-priv static boolean isKeepAlive(HttpRequest request)

isValidHostAuthority	back to summary
public static boolean isValidHostAuthority(String host)

isValidMultipartContentType	back to summary
public static boolean isValidMultipartContentType(String contentType)

isValidMultipartMethod	back to summary
public static boolean isValidMultipartMethod(HttpMethod method)

matches	back to summary
private static boolean matches(CharSequence path, int start, String what)

matches	back to summary
private static boolean matches(CharSequence path, int start, String what, boolean exact)

normalizePath	back to summary
public static String normalizePath(String pathname) Normalizes a path as per rfc3986. There are 2 extra transformations that are not part of the spec but kept for backwards compatibility: double slash // will be converted to single slash and the path will always start with slash. Null paths are not normalized as nothing can be said about them. Parameters pathname:String raw path Returns:String normalized path

normalizePath

back to summary

public static String normalizePath(String pathname)

Normalizes a path as per rfc3986. There are 2 extra transformations that are not part of the spec but kept for backwards compatibility: double slash // will be converted to single slash and the path will always start with slash. Null paths are not normalized as nothing can be said about them.

Parameters

pathname:String: raw path

Returns:String

normalized path

normalizePathSlow	back to summary
private static String normalizePathSlow(String pathname, int indexOfFirstPercent)

params	back to summary
pack-priv static MultiMap params(String uri, Charset charset, boolean semicolonIsNormalChar)

parseKeepAliveHeaderTimeout	back to summary
public static int parseKeepAliveHeaderTimeout(CharSequence value)

parsePath	back to summary
pack-priv static String parsePath(String uri) Extract the path out of the uri.

parseQuery	back to summary
pack-priv static String parseQuery(String uri) Extract the query out of a uri or returns the empty string if no query was found.

positiveLongToString	back to summary
public static String positiveLongToString(long value) This try hard to cache the first 256 positive longs as strings [0, 255] to avoid the cost of creating a new string for each of them. The size/capacity of the cache is subject to change but this method is expected to be used for hot and frequent code paths.

removeDots	back to summary
public static String removeDots(CharSequence path) Removed dots as per rfc3986. There is 1 extra transformation that are not part of the spec but kept for backwards compatibility: double slash // will be converted to single slash. Parameters path:CharSequence raw path Returns:String normalized path

removeDots

back to summary

public static String removeDots(CharSequence path)

Removed dots as per rfc3986. There is 1 extra transformation that are not part of the spec but kept for backwards compatibility: double slash // will be converted to single slash.

Parameters

path:CharSequence: raw path

Returns:String

normalized path

resolveFile	back to summary
pack-priv static void resolveFile(VertxInternal vertx, String filename, long offset, long length, Handler<AsyncResult<AsyncFile>> resultHandler)

resolveURIReference	back to summary
public static URI resolveURIReference(String base, String ref) throws URISyntaxException Resolve an URI reference as per rfc3986

resolveURIReference	back to summary
public static URI resolveURIReference(URI base, String ref) throws URISyntaxException Resolve an URI reference as per rfc3986

sendError	back to summary
pack-priv static void sendError(Channel ch, HttpResponseStatus status)

sendError	back to summary
pack-priv static void sendError(Channel ch, HttpResponseStatus status, CharSequence err)

socketAddressToHostAndPort back to summary

public static HostAndPort socketAddressToHostAndPort(SocketAddress socketAddress)

Convert a SocketAddress to a HostAndPort. If the socket address is an InetSocketAddress, the hostString and port are used. Otherwise null is returned.

Parameters

socketAddress:SocketAddress: The socket address to convert

Returns:HostAndPort

The converted instance or null if not applicable.

toCharSequenceLowerCase	back to summary
private static CharSequence toCharSequenceLowerCase(CharSequence sequence)

toLowerCase back to summary

public static CharSequence toLowerCase(CharSequence sequence)

This is optimized for Http headers, which are usually in the form:
eg Content-Length, content-length

Returns:CharSequence: convert the sequence to a lower case instance

toLowerCase	back to summary
private static CharSequence toLowerCase(char[] chars, int firstUpperCase, int length)

toNettyHttpVersion	back to summary
pack-priv static HttpVersion toNettyHttpVersion(HttpVersion version)

toVertxMethod	back to summary
pack-priv static HttpMethod toVertxMethod(String method)

toVertxSettings	back to summary
public static Http2Settings toVertxSettings(Http2Settings settings)

useH2UniformStreamByteDistributor	back to summary
pack-priv static boolean useH2UniformStreamByteDistributor()

validateAsciiHeaderName	back to summary
private static void validateAsciiHeaderName(AsciiString value)

validateAsciiHeaderValue	back to summary
private static void validateAsciiHeaderValue(AsciiString value)

validateAsciiRangeHeaderValue	back to summary
private static void validateAsciiRangeHeaderValue(AsciiString value, int off, int length, byte[] asciiChars) This method is the slow-path generic version of `validateAsciiHeaderValue(AsciiString)` which is optimized for `AsciiString` instances which are backed by a 0-offset full-blown byte array.

validateCrLfChar	back to summary
private static int validateCrLfChar(CharSequence seq, int state, char ch)

validateHeader	back to summary
public static void validateHeader(CharSequence name, CharSequence value)

validateHeader	back to summary
public static void validateHeader(CharSequence name, Iterable<? extends CharSequence> values)

validateHeaderName	back to summary
public static void validateHeaderName(CharSequence value)

validateHeaderValue	back to summary
public static void validateHeaderValue(CharSequence value)

validateNonPrintableCtrlChar	back to summary
private static void validateNonPrintableCtrlChar(CharSequence seq, int ch)

validateSequenceHeaderName	back to summary
private static void validateSequenceHeaderName(CharSequence value)

validateSequenceHeaderValue	back to summary
private static void validateSequenceHeaderValue(CharSequence value)

validateSequenceHeaderValue	back to summary
private static void validateSequenceHeaderValue(CharSequence seq, int index) This method is taken as we need to validate the header value for the non-printable characters.

validateStringHeaderName	back to summary
private static void validateStringHeaderName(String value)

validateStringHeaderValue	back to summary
private static void validateStringHeaderValue(String value)

validateValueChar	back to summary
private static int validateValueChar(CharSequence seq, int state, char ch)

public final Class HttpUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail