OpenJDK 27 · jdk.internal.net.http.common.Utils · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static record	Utils.ProxyHeaders
public static class	Utils.SafeExecutor<E extends Executor>
public static class	Utils.SafeExecutorService
public static enum	Utils.UseVTForSelector

Field Summary

Modifier and Type	Field and Description
public static final BiPredicate<String, String>	ACCEPT_ALL
private static final Predicate<String>	ALL_HEADERS
public static final BiPredicate<String, String>	ALLOWED_HEADERS
public static final BiPredicate<String, String>	ALLOWED_REDIRECT_HEADERS
public static final boolean	ASSERTIONSENABLED
public static final int	BUFSIZE The capacity of ephemeral `ByteBuffer`s allocated to pass data to and from the client.
private static final int	COPY_THRESHOLD Threshold beyond which data is no longer copied into the current buffer, if that buffer has enough unused space.
public static final boolean	DEBUG
public static final DebugLogger.LoggerConfig	DEBUG_CONFIG
public static final DebugLogger.LoggerConfig	DEBUG_HPACK_CONFIG
public static final boolean	DEBUG_WS
public static final DebugLogger.LoggerConfig	DEBUG_WS_CONFIG
private static final Set<String>	DISALLOWED_HEADERS_SET
private static final Set<String>	DISALLOWED_REDIRECT_HEADERS_SET
public static final ByteBuffer[]	EMPTY_BB_ARRAY
public static final List<ByteBuffer>	EMPTY_BB_LIST
public static final ByteBuffer	EMPTY_BYTEBUFFER
private static final boolean[]	fieldvchar
private static final String	HEADER_CONNECTION
private static final String	HEADER_UPGRADE
private static final Predicate<String>	IS_HOST
private static final Predicate<String>	IS_PROXY_HEADER
public static final boolean	isHostnameVerificationDisabled
private static final boolean[]	LOWER_CASE_CHARS
private static final Predicate<String>	NO_PROXY_HEADER
public static final BiPredicate<String, String>	NO_PROXY_HEADERS_FILTER
private static final ConcurrentHashMap<Integer, String>	opsMap
private static final Set<String>	PROXY_AUTH_DISABLED_SCHEMES
private static final Set<String>	PROXY_AUTH_TUNNEL_DISABLED_SCHEMES
public static final BiPredicate<String, String>	PROXY_FILTER
public static final BiPredicate<String, String>	PROXY_TUNNEL_FILTER
public static final int	SLICE_THRESHOLD
private static final boolean[]	tchar
public static final boolean	TESTING
public static final BiPredicate<String, String>	VALIDATE_USER_HEADER
private static final String	WSPACES

Access	Constructor and Description
private	Utils()

Method Summary

Modifier and Type	Method and Description
public static long	Returns: the number of bytes added accumulateBuffers(List<ByteBuffer> currentList, List<ByteBuffer> buffersToAdd) Adds the data from buffersToAdd to currentList.
public static String	Returns: a message describing the conflict, if any, or `null` if no conflict was detected. addressConflict(SocketAddress local address local, SocketAddress peer address peer) Try to figure out whether local and remote addresses are compatible.
public static <T extends Throwable> T	addSuppressed(T x, Throwable suppressed)
public static String	Returns: the content of the buffer as an hexadecimal string asHexString(ByteBuffer a byte buffer buffer) Returns the content of the buffer as an hexadecimal string.
public static String	Returns: a string built from the bytes contained in the buffer decoded using the given charset asString(ByteBuffer a buffer containing bytes encoded using a charset buffer, Charset the charset to use to decode the bytes into a string charset) Converts a ByteBuffer containing bytes encoded using the given charset into a string.
public static String	Returns: a string built from the decoded UTF-8 bytes contained in the buffer asString(ByteBuffer a buffer containing UTF-8 bytes buffer) Converts a ByteBuffer containing UTF-8 bytes into a string.
public static Charset	charsetFrom(HttpHeaders headers) Get the Charset from the Content-encoding header.
public static void	close(Closeable... closeables)
public static <T extends NetworkChannel> T	configureChannelBuffers(Consumer<String> logSink, T chan, int receiveBufSize, int sendBufSize)
public static int	copy(ByteBuffer src, ByteBuffer dst) Copies as much of src to dst as possible.
public static ByteBuffer	copy(ByteBuffer src)
public static ByteBuffer	copyAligned(ByteBuffer src)
public static Proxy	copyProxy(Proxy proxy) Creates a new `Proxy` instance for the given proxy iff it is neither null, `Proxy.NO_PROXY`, nor already a `Proxy` instance.
public static SSLParameters	copySSLParameters(SSLParameters p)
public static HttpHeaders	Returns: pseudo headers for that request createPseudoHeaders(HttpRequest the request request) Creates HTTP/2 HTTP/3 pseudo headers for the given request.
public static String	Returns: a string comparing the given deadline with now, typically something like "due since Nms" or "due in Nms" debugDeadline(Deadline now now, Deadline the deadline deadline) Returns a string comparing the given deadline with now, typically something like "due since Nms" or "due in Nms".
public static String	describeOps(int interestOps)
public static String	dump(Object... objects)
public static String	encode(String s)
public static Throwable	Returns: the exception the given `cf` was completed with, or a `CancellationException` if the given `cf` was cancelled exceptionNow(CompletableFuture<?> a `CompletableFuture` exceptionally completed cf) Returns the exception the given `cf` was completed with, or a `CancellationException` if the given `cf` was cancelled.
public static void	flipToMark(ByteBuffer buffer, int mark) Set limit to position, and position to mark.
public static boolean	getBooleanProperty(String name, boolean def)
public static ByteBuffer	Returns: a new `ByteBuffer` instance of `BUFSIZE` capacity getBuffer() Returns a new `ByteBuffer` instance of `BUFSIZE` capacity.
public static ByteBuffer	Returns: a new `ByteBuffer` instance whose capacity is set to the smaller of the specified `maxCapacity` and the default (`BUFSIZE`) getBufferWithAtMost(long a buffer capacity, in bytes maxCapacity) Returns a new `ByteBuffer` instance whose capacity is set to the smaller of the specified `maxCapacity` and the default (`BUFSIZE`).
public static Throwable	getCancelCause(Throwable x)
public static Throwable	getCompletionCause(Throwable x)
public static Logger	Returns: A logger for HTTP internal debug traces getDebugLogger(Supplier<String> A lambda that returns a string that identifies the caller (e.g: "SocketTube(3)", or "Http2Connection(SocketTube(3))") dbgTag) Get a logger for debug HTTP traces.
public static Logger	Returns: A logger for HTTP internal debug traces getDebugLogger(Supplier<String> A lambda that returns a string that identifies the caller (e.g: "SocketTube(3)", or "Http2Connection(SocketTube(3))") dbgTag, boolean Whether the logger is enabled. on) Get a logger for debug HTTP traces.The logger should only be used with levels whose severity is `<= DEBUG`.
private static Set<String>	getDisallowedHeaders()
private static Set<String>	getDisallowedRedirectHeaders()
public static Logger	Returns: A logger for HPACK internal debug traces getHpackLogger(Supplier<String> A lambda that returns a string that identifies the caller (e.g: "Http2Connection(SocketTube(3))/hpack.Decoder(3)") dbgTag, System.Logger.Level The level above which messages will be also printed on stderr (in addition to be forwarded to the internal logger). errLevel) Get a logger for debug HPACK traces.The logger should only be used with levels whose severity is `<= DEBUG`.
public static Logger	Returns: A logger for HPACK internal debug traces getHpackLogger(Supplier<String> A lambda that returns a string that identifies the caller (e.g: "Http2Connection(SocketTube(3))/hpack.Decoder(3)") dbgTag) Get a logger for debug HPACK traces.The logger should only be used with levels whose severity is `<= DEBUG`.
public static int	getIntegerNetProperty(String name, int defaultValue)
public static int	getIntegerNetProperty(String property, int min, int max, int defaultValue, boolean log)
public static int	getIntegerProperty(String name, int defaultValue)
public static IOException	getIOException(Throwable t)
private static DebugLogger.LoggerConfig	getLoggerConfig(String loggerName, DebugLogger.LoggerConfig def)
public static long	getLongProperty(String name, long defaultValue)
public static String	getNetProperty(String name)
public static String	getProperty(String name)
public static int	getSoReceiveBufferSize(Consumer<String> logSink, NetworkChannel chan)
public static int	getSoSendBufferSize(Consumer<String> logSink, NetworkChannel chan)
public static Logger	Returns: A logger for WebSocket internal debug traces getWebSocketLogger(Supplier<String> A lambda that returns a string that identifies the caller (e.g: "WebSocket(3)") dbgTag) Get a logger for debug WebSocket traces.The logger should only be used with levels whose severity is `<= DEBUG`.
public static boolean	hasRemaining(List<ByteBuffer> bufs)
public static boolean	hasRemaining(ByteBuffer[] bufs)
private static boolean	hostnameVerificationDisabledValue()
public static SSLSession	immutableSession(SSLSession session) SSLSessions returned to user are wrapped in an immutable object
public static String	interestOps(SelectionKey key)
private static final boolean	isAllowedForProxy(String name, String value, Set<String> disabledSchemes, Predicate<String> allowedKeys)
public static boolean	isHostnameVerificationDisabled() Enabled by default.
public static boolean	isValidLowerCaseName(String token)
public static boolean	isValidName(String token)
public static boolean	isValidValue(String token)
public static String	millis(Instant now, Instant deadline)
public static String	millis(Deadline now, Deadline deadline)
public static long	Returns: the relative consolidated position in bytes at which the two input mismatch, or -1L if there is no mismatch. mismatch(List<ByteBuffer> a first list of byte buffers these, List<ByteBuffer> a second list of byte buffers those) Compute the relative consolidated position in bytes at which the two input mismatch, or -1 if there is no mismatch.
public static IllegalArgumentException	newIAE(String message, Object... args)
public static ByteBuffer	Returns: the next buffer that has remaining bytes, or null next(Iterator<ByteBuffer> an iterator iterator) Returns the next buffer that has remaining bytes, or null.
public static int	Returns: the size of the array pow2Size(int capacity n) Returns the smallest (closest to zero) positive number `m` (which is also a power of 2) such that `n <= m`.
public static final BiPredicate<String, String>	PROXY_TUNNEL_RESTRICTED()
public static boolean	proxyHasDisabledSchemes(boolean tunnel)
public static int	Returns: the amount of bytes read and written to the byte array read(List<ByteBuffer> A list of byte buffer bufs, byte[] A byte array to write into data, int Where to start writing in the byte array offset) Reads as much bytes as possible from the buffer list, and write them in the provided `data` byte array.
public static long	readContentLength(HttpHeaders headers, String errorPrefix, long defaultIfMissing)
public static int	readStatusCode(HttpHeaders headers, String errorPrefix)
public static String	readyOps(SelectionKey key)
public static long	remaining(ByteBuffer[] bufs)
public static long	remaining(List<ByteBuffer> bufs)
public static long	remaining(List<ByteBuffer> bufs, long max)
public static int	remaining(List<ByteBuffer> bufs, int max)
public static long	remaining(ByteBuffer[] refs, long max)
public static int	remaining(ByteBuffer[] refs, int max)
public static InetSocketAddress	resolveAddress(InetSocketAddress address)
public static ExecutorService	safeExecutor(ExecutorService delegate, BiConsumer<Runnable, Throwable> errorHandler)
public static void	setUserAuthFlags(HttpRequestImpl request, HttpHeaders userHeaders) Check the user headers to see if the Authorization or ProxyAuthorization were set.
public static final void	setWebSocketUpgradeHeaders(HttpRequestImpl request)
public static ByteBuffer	Returns: a new ByteBuffer for the given slice sliceOrCopy(ByteBuffer the original buffer src, int where to start copying/slicing from src start, int how many byte to slice/copy len) Creates a slice of a buffer, possibly copying the data instead of slicing.
public static ByteBuffer	Returns: a new ByteBuffer for the given slice sliceOrCopy(ByteBuffer the original buffer src, int where to start copying/slicing from src start, int how many byte to slice/copy len, int a threshold to decide whether to slice or copy threshold) Creates a slice of a buffer, possibly copying the data instead of slicing.
public static ByteBuffer	sliceWithLimitedCapacity(ByteBuffer buffer, int amount) Returns a slice of size `amount` from the given buffer.
public static String	stackTrace(Throwable t)
public static String	stringOf(Collection<?> source)
public static long	synchronizedRemaining(List<ByteBuffer> bufs)
public static Throwable	toConnectException(Throwable e)
public static IOException	toIOException(Throwable cause)
public static boolean	trySetReceiveBufferSize(Consumer<String> logSink, NetworkChannel chan, int bufsize)
public static boolean	trySetSendBufferSize(Consumer<String> logSink, NetworkChannel chan, int bufsize)
public static UncheckedIOException	unchecked(IOException e)
public static Utils.UseVTForSelector	useVTForSelector(String property, String defval)
public static <T> CompletableFuture<T>	wrapForDebug(Logger logger, String name, CompletableFuture<T> cf)
public static Throwable	Returns: a possibly new exception that has as its detail message, the message from the messageSupplier, and the given throwable as its cause. Otherwise returns the given throwable wrapWithExtraDetail(Throwable t, Supplier<String> messageSupplier) Adds a more specific exception detail message, based on the given exception type and the message supplier.

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

public final Class Utils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary