From 780e487ddc99edef1f9cf7720db8eae2ba671da7 Mon Sep 17 00:00:00 2001 From: Violeta Georgieva Date: Mon, 13 Nov 2023 07:53:22 +0200 Subject: [PATCH] [chores] Javadoc style: first sentence should end with a period --- .../reactor/netty/AbstractJarFileTest.java | 4 +- .../main/java/reactor/netty/ByteBufFlux.java | 18 ++-- .../main/java/reactor/netty/ByteBufMono.java | 14 ++-- .../reactor/netty/ChannelBindException.java | 10 +-- .../netty/ChannelPipelineConfigurer.java | 6 +- .../main/java/reactor/netty/Connection.java | 8 +- .../reactor/netty/ConnectionObserver.java | 10 +-- .../java/reactor/netty/DisposableChannel.java | 8 +- .../java/reactor/netty/DisposableServer.java | 4 +- .../src/main/java/reactor/netty/Metrics.java | 82 +++++++++---------- .../main/java/reactor/netty/NettyInbound.java | 8 +- .../main/java/reactor/netty/ReactorNetty.java | 22 ++--- .../netty/channel/AbortedException.java | 4 +- .../netty/channel/ChannelMetricsRecorder.java | 20 ++--- .../netty/channel/ChannelOperations.java | 40 ++++----- .../channel/ChannelOperationsHandler.java | 2 +- .../ContextAwareChannelMetricsRecorder.java | 14 ++-- .../main/java/reactor/netty/package-info.java | 2 +- .../netty/resources/ConnectionProvider.java | 20 ++--- .../netty/resources/LoopResources.java | 18 ++-- .../reactor/netty/resources/package-info.java | 2 +- .../java/reactor/netty/tcp/SniProvider.java | 2 +- .../java/reactor/netty/tcp/SslProvider.java | 24 +++--- .../java/reactor/netty/tcp/TcpClient.java | 12 +-- .../reactor/netty/tcp/TcpClientBootstrap.java | 4 +- .../reactor/netty/tcp/TcpClientConfig.java | 6 +- .../java/reactor/netty/tcp/TcpResources.java | 10 +-- .../java/reactor/netty/tcp/TcpServer.java | 8 +- .../reactor/netty/tcp/TcpServerConfig.java | 6 +- .../netty/transport/ClientTransport.java | 8 +- .../transport/ClientTransportConfig.java | 16 ++-- .../netty/transport/NameResolverProvider.java | 6 +- .../netty/transport/ProxyProvider.java | 16 ++-- .../netty/transport/ServerTransport.java | 4 +- .../transport/ServerTransportConfig.java | 18 ++-- .../netty/transport/TransportConfig.java | 40 ++++----- .../netty/transport/TransportConnector.java | 4 +- .../java/reactor/netty/udp/UdpClient.java | 6 +- .../reactor/netty/udp/UdpClientConfig.java | 4 +- .../java/reactor/netty/udp/UdpResources.java | 12 +-- .../java/reactor/netty/udp/UdpServer.java | 6 +- .../reactor/netty/udp/UdpServerConfig.java | 10 +-- .../netty/BlockHoundIntegrationTest.java | 4 +- .../java/reactor/netty/ReactorNettyTest.java | 14 ++-- .../netty/transport/ClientTransportTest.java | 6 +- .../TransportEventLoopMetricsTest.java | 4 +- .../http/server/sse/Application.java | 8 +- .../brave/TracingHttpClientDecorator.java | 2 +- .../http/ContextAwareHttpMetricsRecorder.java | 8 +- .../reactor/netty/http/Http2SettingsSpec.java | 2 +- .../reactor/netty/http/HttpDecoderSpec.java | 2 +- .../java/reactor/netty/http/HttpInfos.java | 18 ++-- .../netty/http/HttpMetricsRecorder.java | 8 +- .../reactor/netty/http/HttpOperations.java | 14 ++-- .../java/reactor/netty/http/HttpProtocol.java | 6 +- .../reactor/netty/http/HttpResources.java | 8 +- ...ContextAwareHttpClientMetricsRecorder.java | 10 +-- .../http/client/Http2AllocationStrategy.java | 4 +- .../reactor/netty/http/client/HttpClient.java | 16 ++-- .../netty/http/client/HttpClientConfig.java | 12 +-- .../netty/http/client/HttpClientForm.java | 30 +++---- .../netty/http/client/HttpClientInfos.java | 6 +- .../client/HttpClientMetricsRecorder.java | 10 +-- .../netty/http/client/HttpClientRequest.java | 6 +- .../netty/http/client/HttpClientState.java | 16 ++-- .../http/client/HttpClientTcpConfig.java | 4 +- .../http/client/HttpResponseDecoderSpec.java | 2 +- .../http/client/PrematureCloseException.java | 4 +- .../http/client/RedirectClientException.java | 2 +- .../http/client/WebsocketClientSpec.java | 10 +-- .../netty/http/client/package-info.java | 2 +- .../netty/http/logging/package-info.java | 2 +- .../netty/http/server/ConnectionInfo.java | 2 +- ...ContextAwareHttpServerMetricsRecorder.java | 10 +-- .../http/server/DefaultHttpServerRoutes.java | 7 +- .../netty/http/server/HttpPredicate.java | 2 +- .../http/server/HttpRouteHandlerMetadata.java | 6 +- .../reactor/netty/http/server/HttpServer.java | 16 ++-- .../netty/http/server/HttpServerConfig.java | 12 +-- .../server/HttpServerMetricsRecorder.java | 18 ++-- .../http/server/HttpServerOperations.java | 4 +- .../netty/http/server/HttpServerRequest.java | 4 +- .../netty/http/server/HttpServerResponse.java | 24 +++--- .../netty/http/server/HttpServerRoutes.java | 4 +- .../netty/http/server/HttpServerState.java | 8 +- .../http/server/HttpServerTcpConfig.java | 4 +- .../http/server/ProxyProtocolSupportType.java | 4 +- .../server/WebsocketServerOperations.java | 2 +- .../http/server/WebsocketServerSpec.java | 8 +- .../server/logging/AccessLogArgProvider.java | 2 +- .../logging/AccessLogHandlerFactory.java | 6 +- .../http/server/logging/package-info.java | 2 +- .../netty/http/server/package-info.java | 2 +- .../http/websocket/WebsocketInbound.java | 6 +- .../http/websocket/WebsocketOutbound.java | 12 +-- .../netty/http/websocket/WebsocketSpec.java | 4 +- .../http/websocket/WebsocketSpecImpl.java | 4 +- .../java/reactor/netty/ByteBufFluxTest.java | 4 +- .../java/reactor/netty/http/Http2Tests.java | 4 +- .../netty/http/HttpMetricsHandlerTests.java | 2 +- .../netty/http/HttpProtocolsTests.java | 2 +- .../http/client/ConnectionPoolTests.java | 4 +- .../netty/http/client/HttpRedirectTest.java | 2 +- .../http/server/ConnectionInfoTests.java | 2 +- .../server/DefaultHttpServerRoutesTest.java | 4 +- .../http/server/Http2ConnectionInfoTests.java | 2 +- .../netty/http/server/HttpServerTests.java | 4 +- .../netty/incubator/quic/QuicClient.java | 4 +- .../incubator/quic/QuicClientConfig.java | 12 +-- .../netty/incubator/quic/QuicResources.java | 12 +-- .../netty/incubator/quic/QuicServer.java | 4 +- .../incubator/quic/QuicServerConfig.java | 6 +- .../netty/incubator/quic/QuicTransport.java | 8 +- .../incubator/quic/QuicTransportConfig.java | 4 +- .../netty/incubator/quic/BaseQuicTests.java | 8 +- .../netty/incubator/quic/QuicClientTests.java | 10 +-- .../netty/incubator/quic/QuicServerTests.java | 10 +-- 117 files changed, 530 insertions(+), 529 deletions(-) diff --git a/reactor-netty-core/src/jarFileTest/java/reactor/netty/AbstractJarFileTest.java b/reactor-netty-core/src/jarFileTest/java/reactor/netty/AbstractJarFileTest.java index 91761ba73a..a3c6d06d14 100644 --- a/reactor-netty-core/src/jarFileTest/java/reactor/netty/AbstractJarFileTest.java +++ b/reactor-netty-core/src/jarFileTest/java/reactor/netty/AbstractJarFileTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,7 +24,7 @@ import static java.util.Collections.emptyMap; /** - * A helper class to access the content of a shaded JAR + * A helper class to access the content of a shaded JAR. */ class AbstractJarFileTest { diff --git a/reactor-netty-core/src/main/java/reactor/netty/ByteBufFlux.java b/reactor-netty-core/src/main/java/reactor/netty/ByteBufFlux.java index 62549f47d8..6024e2b4a6 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/ByteBufFlux.java +++ b/reactor-netty-core/src/main/java/reactor/netty/ByteBufFlux.java @@ -48,7 +48,7 @@ public class ByteBufFlux extends FluxOperator { /** - * Decorate as {@link ByteBufFlux} + * Decorate as {@link ByteBufFlux}. * * @param source publisher to decorate * @@ -59,7 +59,7 @@ public static ByteBufFlux fromInbound(Publisher source) { } /** - * Decorate as {@link ByteBufFlux} + * Decorate as {@link ByteBufFlux}. * * @param source publisher to decorate * @param allocator the channel {@link ByteBufAllocator} @@ -73,7 +73,7 @@ public static ByteBufFlux fromInbound(Publisher source, ByteBufAllocator allo /** - * Decorate as {@link ByteBufFlux} + * Decorate as {@link ByteBufFlux}. * * @param source publisher to decorate * @return a {@link ByteBufFlux} @@ -83,7 +83,7 @@ public static ByteBufFlux fromString(Publisher source) { } /** - * Decorate as {@link ByteBufFlux} + * Decorate as {@link ByteBufFlux}. * * @param source publisher to decorate * @param charset the encoding charset @@ -105,7 +105,7 @@ public static ByteBufFlux fromString(Publisher source, Charset /** * Open a {@link java.nio.channels.FileChannel} from a path and stream * {@link ByteBuf} chunks with a default maximum size of 500K into - * the returned {@link ByteBufFlux} + * the returned {@link ByteBufFlux}. * * @param path the path to the resource to stream * @@ -117,7 +117,7 @@ public static ByteBufFlux fromPath(Path path) { /** * Open a {@link java.nio.channels.FileChannel} from a path and stream - * {@link ByteBuf} chunks with a given maximum size into the returned {@link ByteBufFlux} + * {@link ByteBuf} chunks with a given maximum size into the returned {@link ByteBufFlux}. * * @param path the path to the resource to stream * @param maxChunkSize the maximum per-item ByteBuf size @@ -185,7 +185,7 @@ public static ByteBufFlux fromPath(Path path, } /** - * Convert to a {@link ByteBuffer} inbound {@link Flux} + * Convert to a {@link ByteBuffer} inbound {@link Flux}. * * @return a {@link ByteBuffer} inbound {@link Flux} */ @@ -201,7 +201,7 @@ public final Flux asByteBuffer() { } /** - * Convert to a {@literal byte[]} inbound {@link Flux} + * Convert to a {@literal byte[]} inbound {@link Flux}. * * @return a {@literal byte[]} inbound {@link Flux} */ @@ -348,7 +348,7 @@ static ByteBufFlux maybeFuse(Flux source, ByteBufAllocator allocator) { } /** - * A channel object to {@link ByteBuf} transformer + * A channel object to {@link ByteBuf} transformer. */ static final Function bytebufExtractor = o -> { if (o instanceof ByteBuf) { diff --git a/reactor-netty-core/src/main/java/reactor/netty/ByteBufMono.java b/reactor-netty-core/src/main/java/reactor/netty/ByteBufMono.java index 5b99c595f7..a1a4ad1fba 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/ByteBufMono.java +++ b/reactor-netty-core/src/main/java/reactor/netty/ByteBufMono.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -42,7 +42,7 @@ public class ByteBufMono extends MonoOperator { /** - * a {@link ByteBuffer} inbound {@link Mono} + * a {@link ByteBuffer} inbound {@link Mono}. * * @return a {@link ByteBuffer} inbound {@link Mono} */ @@ -58,7 +58,7 @@ public final Mono asByteBuffer() { } /** - * a {@literal byte[]} inbound {@link Mono} + * a {@literal byte[]} inbound {@link Mono}. * * @return a {@literal byte[]} inbound {@link Mono} */ @@ -76,7 +76,7 @@ public final Mono asByteArray() { } /** - * a {@link String} inbound {@link Mono} + * a {@link String} inbound {@link Mono}. * * @return a {@link String} inbound {@link Mono} */ @@ -85,7 +85,7 @@ public final Mono asString() { } /** - * a {@link String} inbound {@link Mono} + * a {@link String} inbound {@link Mono}. * * @param charset the decoding charset * @@ -124,7 +124,7 @@ public final Mono asInputStream() { } /** - * Decorate as {@link ByteBufMono} + * Decorate as {@link ByteBufMono}. * * @param source publisher to decorate * @return a {@link ByteBufMono} @@ -134,7 +134,7 @@ public static ByteBufMono fromString(Publisher source) { } /** - * Decorate as {@link ByteBufMono} + * Decorate as {@link ByteBufMono}. * * @param source publisher to decorate * @param charset the encoding charset diff --git a/reactor-netty-core/src/main/java/reactor/netty/ChannelBindException.java b/reactor-netty-core/src/main/java/reactor/netty/ChannelBindException.java index 19cb4d5d79..18226118af 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/ChannelBindException.java +++ b/reactor-netty-core/src/main/java/reactor/netty/ChannelBindException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,14 +23,14 @@ import reactor.util.annotation.Nullable; /** - * Represents a failing attempt to bind a local socket address + * Represents a failing attempt to bind a local socket address. * * @author Stephane Maldini */ public class ChannelBindException extends RuntimeException { /** - * Build a {@link ChannelBindException} + * Build a {@link ChannelBindException}. * * @param bindAddress the local address * @param cause the root cause @@ -76,7 +76,7 @@ public synchronized Throwable fillInStackTrace() { } /** - * Return the configured binding host + * Return the configured binding host. * * @return the configured binding host */ @@ -85,7 +85,7 @@ public String localHost() { } /** - * Return the configured binding port + * Return the configured binding port. * * @return the configured local binding port */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/ChannelPipelineConfigurer.java b/reactor-netty-core/src/main/java/reactor/netty/ChannelPipelineConfigurer.java index 78f64103bb..8d76f9a493 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/ChannelPipelineConfigurer.java +++ b/reactor-netty-core/src/main/java/reactor/netty/ChannelPipelineConfigurer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,7 +32,7 @@ public interface ChannelPipelineConfigurer { /** - * Return a noop configurer + * Return a noop configurer. * * @return a noop configurer */ @@ -50,7 +50,7 @@ static ChannelPipelineConfigurer emptyConfigurer() { void onChannelInit(ConnectionObserver connectionObserver, Channel channel, @Nullable SocketAddress remoteAddress); /** - * Chain together another {@link ChannelPipelineConfigurer} + * Chain together another {@link ChannelPipelineConfigurer}. * * @param other the next {@link ChannelPipelineConfigurer} * diff --git a/reactor-netty-core/src/main/java/reactor/netty/Connection.java b/reactor-netty-core/src/main/java/reactor/netty/Connection.java index 059c13fb2c..9c9811f0a3 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/Connection.java +++ b/reactor-netty-core/src/main/java/reactor/netty/Connection.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,7 +25,7 @@ import static java.util.Objects.requireNonNull; /** - * Hold contextual information for the underlying {@link Channel} + * Hold contextual information for the underlying {@link Channel}. * * @author Stephane Maldini * @since 0.8 @@ -34,7 +34,7 @@ public interface Connection extends DisposableChannel { /** - * Return an existing {@link Connection} wrapper or create a simple new one + * Return an existing {@link Connection} wrapper or create a simple new one. * * @param channel channel to retrieve the connection reference from * @@ -345,7 +345,7 @@ default boolean rebind(@Nullable Connection connection) { } /** - * Remove a named handler if present and return this context + * Remove a named handler if present and return this context. * * @param name handler name * diff --git a/reactor-netty-core/src/main/java/reactor/netty/ConnectionObserver.java b/reactor-netty-core/src/main/java/reactor/netty/ConnectionObserver.java index d8ce999b32..3f4212e4c0 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/ConnectionObserver.java +++ b/reactor-netty-core/src/main/java/reactor/netty/ConnectionObserver.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,7 +33,7 @@ public interface ConnectionObserver { /** - * Return a noop connection listener + * Return a noop connection listener. * * @return a noop connection listener */ @@ -42,7 +42,7 @@ static ConnectionObserver emptyListener() { } /** - * Connection listener {@link Context} + * Connection listener {@link Context}. * * @return current {@link Context} or {@link Context#empty()} */ @@ -63,7 +63,7 @@ default void onUncaughtException(Connection connection, Throwable error) { } /** - * React on connection state change (e.g. http request or response) + * React on connection state change (e.g. http request or response). * * @param connection the connection reference * @param newState the new State @@ -71,7 +71,7 @@ default void onUncaughtException(Connection connection, Throwable error) { void onStateChange(Connection connection, State newState); /** - * Chain together another {@link ConnectionObserver} + * Chain together another {@link ConnectionObserver}. * * @param other the next {@link ConnectionObserver} * diff --git a/reactor-netty-core/src/main/java/reactor/netty/DisposableChannel.java b/reactor-netty-core/src/main/java/reactor/netty/DisposableChannel.java index 432f4171bc..2850113ac8 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/DisposableChannel.java +++ b/reactor-netty-core/src/main/java/reactor/netty/DisposableChannel.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -29,7 +29,7 @@ /** * Holds contextual information for the underlying channel and provides - * non-blocking resource disposing API + * non-blocking resource disposing API. * * @author Stephane Maldini * @since 0.7 @@ -63,7 +63,7 @@ default SocketAddress address() { Channel channel(); /** - * Releases or closes the underlying {@link Channel} + * Releases or closes the underlying {@link Channel}. */ @Override @SuppressWarnings({"FutureReturnValueIgnored", "FunctionalInterfaceMethodChanged"}) @@ -107,7 +107,7 @@ default void disposeNow(Duration timeout) { } /** - * Returns a {@link CoreSubscriber} that will dispose on complete or error + * Returns a {@link CoreSubscriber} that will dispose on complete or error. */ default CoreSubscriber disposeSubscriber() { return new ReactorNetty.ChannelDisposer(this); diff --git a/reactor-netty-core/src/main/java/reactor/netty/DisposableServer.java b/reactor-netty-core/src/main/java/reactor/netty/DisposableServer.java index cf13acb3f9..4d70b31de8 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/DisposableServer.java +++ b/reactor-netty-core/src/main/java/reactor/netty/DisposableServer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,7 +19,7 @@ import java.net.SocketAddress; /** - * Holds contextual information for the underlying server + * Holds contextual information for the underlying server. * * @author Stephane Maldini * @author Violeta Georgieva diff --git a/reactor-netty-core/src/main/java/reactor/netty/Metrics.java b/reactor-netty-core/src/main/java/reactor/netty/Metrics.java index 0813b6db00..0900d9ae78 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/Metrics.java +++ b/reactor-netty-core/src/main/java/reactor/netty/Metrics.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -34,220 +34,220 @@ public class Metrics { // Names /** * Name prefix that will be used for the HTTP server's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String HTTP_SERVER_PREFIX = "reactor.netty.http.server"; /** * Name prefix that will be used for the HTTP client's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String HTTP_CLIENT_PREFIX = "reactor.netty.http.client"; /** * Name prefix that will be used for the TCP server's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String TCP_SERVER_PREFIX = "reactor.netty.tcp.server"; /** * Name prefix that will be used for the TCP client's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String TCP_CLIENT_PREFIX = "reactor.netty.tcp.client"; /** * Name prefix that will be used for the UDP server's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String UDP_SERVER_PREFIX = "reactor.netty.udp.server"; /** * Name prefix that will be used for the UDP client's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String UDP_CLIENT_PREFIX = "reactor.netty.udp.client"; /** * Name prefix that will be used for Event Loop Group metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String EVENT_LOOP_PREFIX = "reactor.netty.eventloop"; /** * Name prefix that will be used for the PooledConnectionProvider's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String CONNECTION_PROVIDER_PREFIX = "reactor.netty.connection.provider"; /** * Name prefix that will be used for the ByteBufAllocator's metrics - * registered in Micrometer's global registry + * registered in Micrometer's global registry. */ public static final String BYTE_BUF_ALLOCATOR_PREFIX = "reactor.netty.bytebuf.allocator"; // Metrics /** - * Amount of the data received, in bytes + * Amount of the data received, in bytes. */ public static final String DATA_RECEIVED = ".data.received"; /** - * Amount of the data sent, in bytes + * Amount of the data sent, in bytes. */ public static final String DATA_SENT = ".data.sent"; /** - * Number of errors that occurred + * Number of errors that occurred. */ public static final String ERRORS = ".errors"; /** - * Time spent for TLS handshake + * Time spent for TLS handshake. */ public static final String TLS_HANDSHAKE_TIME = ".tls.handshake.time"; /** - * Time spent for connecting to the remote address + * Time spent for connecting to the remote address. */ public static final String CONNECT_TIME = ".connect.time"; /** - * Time spent in consuming incoming data + * Time spent in consuming incoming data. */ public static final String DATA_RECEIVED_TIME = ".data.received.time"; /** - * Time spent in sending outgoing data + * Time spent in sending outgoing data. */ public static final String DATA_SENT_TIME = ".data.sent.time"; /** - * Total time for the request/response + * Total time for the request/response. */ public static final String RESPONSE_TIME = ".response.time"; /** - * The number of all connections, whether they are active or idle + * The number of all connections, whether they are active or idle. */ public static final String CONNECTIONS_TOTAL = ".connections.total"; /** - * The number of connections that are currently in use + * The number of connections that are currently in use. */ public static final String CONNECTIONS_ACTIVE = ".connections.active"; // AddressResolverGroup Metrics /** - * Time spent for resolving the address + * Time spent for resolving the address. */ public static final String ADDRESS_RESOLVER = ".address.resolver"; // PooledConnectionProvider Metrics /** - * The number of all connections, active or idle + * The number of all connections, active or idle. */ public static final String TOTAL_CONNECTIONS = ".total.connections"; /** - * The number of the connections that have been successfully acquired and are in active use + * The number of the connections that have been successfully acquired and are in active use. */ public static final String ACTIVE_CONNECTIONS = ".active.connections"; /** - * The maximum number of active connections that are allowed + * The maximum number of active connections that are allowed. */ public static final String MAX_CONNECTIONS = ".max.connections"; /** - * The number of the idle connections + * The number of the idle connections. */ public static final String IDLE_CONNECTIONS = ".idle.connections"; /** - * The number of requests that are waiting for a connection + * The number of requests that are waiting for a connection. */ public static final String PENDING_CONNECTIONS = ".pending.connections"; /** - * The maximum number of requests that will be queued while waiting for a ready connection + * The maximum number of requests that will be queued while waiting for a ready connection. */ public static final String MAX_PENDING_CONNECTIONS = ".max.pending.connections"; /** - * The number of the active HTTP/2 streams + * The number of the active HTTP/2 streams. */ public static final String ACTIVE_STREAMS = ".active.streams"; /** - * The number of requests that are waiting for opening HTTP/2 stream + * The number of requests that are waiting for opening HTTP/2 stream. */ public static final String PENDING_STREAMS = ".pending.streams"; // ByteBufAllocator Metrics /** - * The number of bytes reserved by heap buffer allocator + * The number of bytes reserved by heap buffer allocator. */ public static final String USED_HEAP_MEMORY = ".used.heap.memory"; /** - * The number of bytes reserved by direct buffer allocator + * The number of bytes reserved by direct buffer allocator. */ public static final String USED_DIRECT_MEMORY = ".used.direct.memory"; /** - * The actual bytes consumed by in-use buffers allocated from heap buffer pools + * The actual bytes consumed by in-use buffers allocated from heap buffer pools. */ public static final String ACTIVE_HEAP_MEMORY = ".active.heap.memory"; /** - * The actual bytes consumed by in-use buffers allocated from direct buffer pools + * The actual bytes consumed by in-use buffers allocated from direct buffer pools. */ public static final String ACTIVE_DIRECT_MEMORY = ".active.direct.memory"; /** - * The number of heap arenas + * The number of heap arenas. */ public static final String HEAP_ARENAS = ".heap.arenas"; /** - * The number of direct arenas + * The number of direct arenas. */ public static final String DIRECT_ARENAS = ".direct.arenas"; /** - * The number of thread local caches + * The number of thread local caches. */ public static final String THREAD_LOCAL_CACHES = ".threadlocal.caches"; /** - * The size of the small cache + * The size of the small cache. */ public static final String SMALL_CACHE_SIZE = ".small.cache.size"; /** - * The size of the normal cache + * The size of the normal cache. */ public static final String NORMAL_CACHE_SIZE = ".normal.cache.size"; /** - * The chunk size for an arena + * The chunk size for an arena. */ public static final String CHUNK_SIZE = ".chunk.size"; // EventLoop Metrics /** - * The number of tasks that are pending for processing on an event loop + * The number of tasks that are pending for processing on an event loop. */ public static final String PENDING_TASKS = ".pending.tasks"; // HttpServer Metrics /** - * The number of active HTTP/2 streams + * The number of active HTTP/2 streams. */ public static final String STREAMS_ACTIVE = ".streams.active"; diff --git a/reactor-netty-core/src/main/java/reactor/netty/NettyInbound.java b/reactor-netty-core/src/main/java/reactor/netty/NettyInbound.java index e7d52a6594..00ff441c02 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/NettyInbound.java +++ b/reactor-netty-core/src/main/java/reactor/netty/NettyInbound.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,7 +21,7 @@ import reactor.core.publisher.Flux; /** - * An inbound-traffic API delegating to an underlying {@link Channel} + * An inbound-traffic API delegating to an underlying {@link Channel}. * * @author Stephane Maldini * @since 0.6 @@ -30,7 +30,7 @@ public interface NettyInbound { /** - * A {@link Flux} extension that allows for extra decoding operators + * A {@link Flux} extension that allows for extra decoding operators. * * @return a new {@link ByteBufFlux} */ @@ -38,7 +38,7 @@ public interface NettyInbound { /** - * a {@literal Object} inbound {@link Flux} + * a {@literal Object} inbound {@link Flux}. * * @return a {@literal Object} inbound {@link Flux} */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/ReactorNetty.java b/reactor-netty-core/src/main/java/reactor/netty/ReactorNetty.java index e62e9fa3ba..d5ab513670 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/ReactorNetty.java +++ b/reactor-netty-core/src/main/java/reactor/netty/ReactorNetty.java @@ -67,7 +67,7 @@ import static java.util.Objects.requireNonNull; /** - * Internal helpers for reactor-netty contracts + * Internal helpers for reactor-netty contracts. * * @author Stephane Maldini */ @@ -85,7 +85,7 @@ public final class ReactorNetty { /** * Default worker thread count, fallback to available processor - * (but with a minimum value of 4) + * (but with a minimum value of 4). */ public static final String IO_WORKER_COUNT = "reactor.netty.ioWorkerCount"; /** @@ -99,7 +99,7 @@ public final class ReactorNetty { public static final String IO_SELECT_COUNT = "reactor.netty.ioSelectCount"; /** * Default worker thread count for UDP, fallback to available processor - * (but with a minimum value of 4) + * (but with a minimum value of 4). */ public static final String UDP_IO_THREAD_COUNT = "reactor.netty.udp.ioThreadCount"; /** @@ -115,7 +115,7 @@ public final class ReactorNetty { /** * Default value whether the native transport (epoll, kqueue) will be preferred, - * fallback it will be preferred when available + * fallback it will be preferred when available. */ public static final String NATIVE = "reactor.netty.native"; @@ -172,17 +172,17 @@ public final class ReactorNetty { /** - * Default SSL handshake timeout (milliseconds), fallback to 10 seconds + * Default SSL handshake timeout (milliseconds), fallback to 10 seconds. */ public static final String SSL_HANDSHAKE_TIMEOUT = "reactor.netty.tcp.sslHandshakeTimeout"; /** * Default value whether the SSL debugging on the client side will be enabled/disabled, - * fallback to SSL debugging disabled + * fallback to SSL debugging disabled. */ public static final String SSL_CLIENT_DEBUG = "reactor.netty.tcp.ssl.client.debug"; /** * Default value whether the SSL debugging on the server side will be enabled/disabled, - * fallback to SSL debugging disabled + * fallback to SSL debugging disabled. */ public static final String SSL_SERVER_DEBUG = "reactor.netty.tcp.ssl.server.debug"; @@ -194,7 +194,7 @@ public final class ReactorNetty { public static final String ACCESS_LOG_ENABLED = "reactor.netty.http.server.accessLogEnabled"; /** - * Specifies the zone id used by the access log + * Specifies the zone id used by the access log. */ public static final ZoneId ZONE_ID_SYSTEM = ZoneId.systemDefault(); @@ -213,7 +213,7 @@ public static void safeRelease(Object msg) { } /** - * Append channel ID to a log message for correlated traces + * Append channel ID to a log message for correlated traces. * @param channel current channel associated with the msg * @param msg the log msg * @return a formatted msg @@ -267,7 +267,7 @@ public static String format(Channel channel, String msg) { } /** - * Pretty hex dump will be returned when the object is {@link ByteBuf} or {@link ByteBufHolder} + * Pretty hex dump will be returned when the object is {@link ByteBuf} or {@link ByteBufHolder}. */ public static String toPrettyHexDump(Object msg) { Objects.requireNonNull(msg, "msg"); @@ -867,7 +867,7 @@ public String toString() { /** * A handler that can be used to extract {@link ByteBuf} out of {@link ByteBufHolder}, - * optionally also outputting additional messages + * optionally also outputting additional messages. * * @author Stephane Maldini * @author Simon Baslé diff --git a/reactor-netty-core/src/main/java/reactor/netty/channel/AbortedException.java b/reactor-netty-core/src/main/java/reactor/netty/channel/AbortedException.java index f4b7e89e88..da9319e6e9 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/channel/AbortedException.java +++ b/reactor-netty-core/src/main/java/reactor/netty/channel/AbortedException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,7 +19,7 @@ import java.net.SocketException; /** - * An exception marking prematurely or unexpectedly closed inbound + * An exception marking prematurely or unexpectedly closed inbound. * * @author Stephane Maldini * @since 0.6 diff --git a/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelMetricsRecorder.java b/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelMetricsRecorder.java index 7bd8b72e1c..d48626a6b0 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelMetricsRecorder.java +++ b/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,7 +26,7 @@ public interface ChannelMetricsRecorder { /** - * Records the amount of the data that is received, in bytes + * Records the amount of the data that is received, in bytes. * * @param remoteAddress The remote peer * @param bytes The amount of the data that is received, in bytes @@ -34,7 +34,7 @@ public interface ChannelMetricsRecorder { void recordDataReceived(SocketAddress remoteAddress, long bytes); /** - * Records the amount of the data that is sent, in bytes + * Records the amount of the data that is sent, in bytes. * * @param remoteAddress The remote peer * @param bytes The amount of the data that is sent, in bytes @@ -42,14 +42,14 @@ public interface ChannelMetricsRecorder { void recordDataSent(SocketAddress remoteAddress, long bytes); /** - * Increments the number of the errors that are occurred + * Increments the number of the errors that are occurred. * * @param remoteAddress The remote peer */ void incrementErrorsCount(SocketAddress remoteAddress); /** - * Records the time that is spent for TLS handshake + * Records the time that is spent for TLS handshake. * * @param remoteAddress The remote peer * @param time the time in nanoseconds that is spent for TLS handshake @@ -58,7 +58,7 @@ public interface ChannelMetricsRecorder { void recordTlsHandshakeTime(SocketAddress remoteAddress, Duration time, String status); /** - * Records the time that is spent for connecting to the remote address + * Records the time that is spent for connecting to the remote address. * Relevant only when on the client * * @param remoteAddress The remote peer @@ -68,8 +68,8 @@ public interface ChannelMetricsRecorder { void recordConnectTime(SocketAddress remoteAddress, Duration time, String status); /** - * Records the time that is spent for resolving the remote address - * Relevant only when on the client + * Records the time that is spent for resolving the remote address. + * Relevant only when on the client. * * @param remoteAddress The remote peer * @param time the time in nanoseconds that is spent for resolving to the remote address @@ -78,7 +78,7 @@ public interface ChannelMetricsRecorder { void recordResolveAddressTime(SocketAddress remoteAddress, Duration time, String status); /** - * Records a just accepted server connection + * Records a just accepted server connection. * * @param localAddress the server local address * @since 1.0.15 @@ -86,7 +86,7 @@ public interface ChannelMetricsRecorder { default void recordServerConnectionOpened(SocketAddress localAddress) { } /** - * Records a just disconnected server connection + * Records a just disconnected server connection. * * @param localAddress the server local address * @since 1.0.15 diff --git a/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperations.java b/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperations.java index bb3d0e875d..d3d4577c68 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperations.java +++ b/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperations.java @@ -55,7 +55,7 @@ import static reactor.netty.ReactorNetty.format; /** - * {@link NettyInbound} and {@link NettyOutbound} that apply to a {@link Connection} + * {@link NettyInbound} and {@link NettyOutbound} that apply to a {@link Connection}. * * @author Stephane Maldini * @since 0.6 @@ -104,7 +104,7 @@ public static void addMetricsHandler(Channel ch, ChannelMetricsRecorder recorder } /** - * Return the current {@link Channel} bound {@link ChannelOperations} or null if none + * Return the current {@link Channel} bound {@link ChannelOperations} or null if none. * * @param ch the current {@link Channel} * @@ -214,7 +214,7 @@ public final boolean isDisposed() { } /** - * Return true if dispose subscription has been terminated + * Return true if dispose subscription has been terminated. * * @return true if dispose subscription has been terminated */ @@ -332,7 +332,7 @@ public NettyOutbound sendUsing(Callable sourceInput, } /** - * Return a Mono succeeding when a {@link ChannelOperations} has been terminated + * Return a Mono succeeding when a {@link ChannelOperations} has been terminated. * * @return a Mono succeeding when a {@link ChannelOperations} has been terminated */ @@ -346,7 +346,7 @@ public final Mono onTerminate() { /** * Return the available parent {@link ConnectionObserver} for user-facing lifecycle - * handling + * handling. * * @return the available parent {@link ConnectionObserver}for user-facing lifecycle * handling @@ -379,7 +379,7 @@ protected final void discardWhenNoReceiver() { } /** - * Return true if inbound traffic is not expected anymore + * Return true if inbound traffic is not expected anymore. * * @return true if inbound traffic is not expected anymore */ @@ -410,7 +410,7 @@ protected final boolean isInboundComplete() { } /** - * React on inbound {@link Channel#read} + * React on inbound {@link Channel#read}. * * @param ctx the context * @param msg the read payload @@ -420,7 +420,7 @@ protected void onInboundNext(ChannelHandlerContext ctx, Object msg) { } /** - * React on inbound cancel (receive() subscriber cancelled) + * React on inbound cancel (receive() subscriber cancelled). */ protected void onInboundCancel() { if (log.isDebugEnabled()) { @@ -433,21 +433,21 @@ protected void onInboundCancel() { /** - * React on inbound completion (last packet) + * React on inbound completion (last packet). */ protected void onInboundComplete() { inbound.onInboundComplete(); } /** - * React after inbound completion (last packet) + * React after inbound completion (last packet). */ protected void afterInboundComplete() { // noop } /** - * React on inbound close (channel closed prematurely) + * React on inbound close (channel closed prematurely). */ protected void onInboundClose() { discardWhenNoReceiver(); @@ -455,7 +455,7 @@ protected void onInboundClose() { } /** - * React on inbound/outbound completion (last packet) + * React on inbound/outbound completion (last packet). */ protected void onOutboundComplete() { if (log.isDebugEnabled()) { @@ -466,7 +466,7 @@ protected void onOutboundComplete() { } /** - * React on inbound/outbound error + * React on inbound/outbound error. * * @param err the {@link Throwable} cause */ @@ -477,7 +477,7 @@ protected void onOutboundError(Throwable err) { /** - * Final release/close (last packet) + * Final release/close (last packet). */ protected final void terminate() { if (rebind(connection)) { @@ -500,7 +500,7 @@ protected final void terminate() { } /** - * React on inbound error + * React on inbound error. * * @param err the {@link Throwable} cause */ @@ -509,7 +509,7 @@ protected final void onInboundError(Throwable err) { } /** - * Return the delegate IO {@link Connection} for low-level IO access + * Return the delegate IO {@link Connection} for low-level IO access. * * @return the delegate IO {@link Connection} for low-level IO access */ @@ -518,7 +518,7 @@ protected final Connection connection() { } /** - * Return formatted name of this operation + * Return formatted name of this operation. * * @return formatted name of this operation */ @@ -532,7 +532,7 @@ protected String initShortId() { } /** - * Wrap an inbound error + * Wrap an inbound error. * * @param err the {@link Throwable} cause */ @@ -630,13 +630,13 @@ else if (localAddress != null) { } /** - * A {@link ChannelOperations} factory + * A {@link ChannelOperations} factory. */ @FunctionalInterface public interface OnSetup { /** - * Return an empty, no-op factory + * Return an empty, no-op factory. * * @return an empty, no-op factory */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperationsHandler.java b/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperationsHandler.java index b78398426b..ff5077bbb0 100755 --- a/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperationsHandler.java +++ b/reactor-netty-core/src/main/java/reactor/netty/channel/ChannelOperationsHandler.java @@ -35,7 +35,7 @@ /** * Netty {@link io.netty.channel.ChannelDuplexHandler} implementation that bridge data - * via an IPC {@link NettyOutbound} + * via an IPC {@link NettyOutbound}. * * @author Stephane Maldini */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/channel/ContextAwareChannelMetricsRecorder.java b/reactor-netty-core/src/main/java/reactor/netty/channel/ContextAwareChannelMetricsRecorder.java index 3289be4543..e82edbca08 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/channel/ContextAwareChannelMetricsRecorder.java +++ b/reactor-netty-core/src/main/java/reactor/netty/channel/ContextAwareChannelMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,7 +30,7 @@ public abstract class ContextAwareChannelMetricsRecorder implements ChannelMetricsRecorder { /** - * Increments the number of the errors that are occurred + * Increments the number of the errors that are occurred. * * @param contextView The current {@link ContextView} associated with the Mono/Flux pipeline * @param remoteAddress The remote peer @@ -38,8 +38,8 @@ public abstract class ContextAwareChannelMetricsRecorder implements ChannelMetri public abstract void incrementErrorsCount(ContextView contextView, SocketAddress remoteAddress); /** - * Records the time that is spent for connecting to the remote address - * Relevant only when on the client + * Records the time that is spent for connecting to the remote address. + * Relevant only when on the client. * * @param contextView The current {@link ContextView} associated with the Mono/Flux pipeline * @param remoteAddress The remote peer @@ -49,7 +49,7 @@ public abstract class ContextAwareChannelMetricsRecorder implements ChannelMetri public abstract void recordConnectTime(ContextView contextView, SocketAddress remoteAddress, Duration time, String status); /** - * Records the amount of the data that is received, in bytes + * Records the amount of the data that is received, in bytes. * * @param contextView The current {@link ContextView} associated with the Mono/Flux pipeline * @param remoteAddress The remote peer @@ -58,7 +58,7 @@ public abstract class ContextAwareChannelMetricsRecorder implements ChannelMetri public abstract void recordDataReceived(ContextView contextView, SocketAddress remoteAddress, long bytes); /** - * Records the amount of the data that is sent, in bytes + * Records the amount of the data that is sent, in bytes. * * @param contextView The current {@link ContextView} associated with the Mono/Flux pipeline * @param remoteAddress The remote peer @@ -67,7 +67,7 @@ public abstract class ContextAwareChannelMetricsRecorder implements ChannelMetri public abstract void recordDataSent(ContextView contextView, SocketAddress remoteAddress, long bytes); /** - * Records the time that is spent for TLS handshake + * Records the time that is spent for TLS handshake. * * @param contextView The current {@link ContextView} associated with the Mono/Flux pipeline * @param remoteAddress The remote peer diff --git a/reactor-netty-core/src/main/java/reactor/netty/package-info.java b/reactor-netty-core/src/main/java/reactor/netty/package-info.java index 049ec447c9..ea17e8bb23 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/package-info.java +++ b/reactor-netty-core/src/main/java/reactor/netty/package-info.java @@ -15,7 +15,7 @@ */ /** - * Main Reactor Netty Contracts used by all client and server implementations + * Main Reactor Netty Contracts used by all client and server implementations. */ @NonNullApi package reactor.netty; diff --git a/reactor-netty-core/src/main/java/reactor/netty/resources/ConnectionProvider.java b/reactor-netty-core/src/main/java/reactor/netty/resources/ConnectionProvider.java index c71c5a0421..00a549bfd1 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/resources/ConnectionProvider.java +++ b/reactor-netty-core/src/main/java/reactor/netty/resources/ConnectionProvider.java @@ -39,7 +39,7 @@ import java.util.function.Supplier; /** - * A {@link ConnectionProvider} will produce {@link Connection} + * A {@link ConnectionProvider} will produce {@link Connection}. * * @author Stephane Maldini * @since 0.8 @@ -99,7 +99,7 @@ public interface ConnectionProvider extends Disposable { .toLowerCase(Locale.ENGLISH); /** - * Creates a builder for {@link ConnectionProvider} + * Creates a builder for {@link ConnectionProvider}. * * @param name {@link ConnectionProvider} name * @return a new ConnectionProvider builder @@ -239,7 +239,7 @@ default Mono disposeLater() { } /** - * Returns the maximum number of connections before starting pending + * Returns the maximum number of connections before starting pending. * * @return the maximum number of connections before starting pending */ @@ -248,7 +248,7 @@ default int maxConnections() { } /** - * Returns the maximum number of connections per host before starting pending + * Returns the maximum number of connections per host before starting pending. * * @return the maximum number of connections per host before starting pending */ @@ -258,7 +258,7 @@ default Map maxConnectionsPerHost() { } /** - * Returns a builder to mutate properties of this {@link ConnectionProvider} + * Returns a builder to mutate properties of this {@link ConnectionProvider}. * * @return a builder to mutate properties of this {@link ConnectionProvider} * @since 1.0.14 @@ -269,7 +269,7 @@ default Builder mutate() { } /** - * Returns {@link ConnectionProvider} name used for metrics + * Returns {@link ConnectionProvider} name used for metrics. * * @return {@link ConnectionProvider} name used for metrics * @since 1.0.14 @@ -350,7 +350,7 @@ interface AllocationStrategy> { int getPermits(int desired); /** - * Returns the best estimate of the number of permits currently granted, between 0 and {@link Integer#MAX_VALUE} + * Returns the best estimate of the number of permits currently granted, between 0 and {@link Integer#MAX_VALUE}. * * @return the best estimate of the number of permits currently granted, between 0 and {@link Integer#MAX_VALUE} */ @@ -365,7 +365,7 @@ interface AllocationStrategy> { int permitMinimum(); /** - * Returns the maximum number of permits this strategy can grant in total, or {@link Integer#MAX_VALUE} for unbounded + * Returns the maximum number of permits this strategy can grant in total, or {@link Integer#MAX_VALUE} for unbounded. * * @return the maximum number of permits this strategy can grant in total, or {@link Integer#MAX_VALUE} for unbounded */ @@ -421,7 +421,7 @@ private Builder(String name) { } /** - * {@link ConnectionProvider} name is used for metrics + * {@link ConnectionProvider} name is used for metrics. * * @param name {@link ConnectionProvider} name * @return {@literal this} @@ -489,7 +489,7 @@ public final Builder forRemoteHost(SocketAddress remoteHost, ConsumerOpenSsl.isAvailable() + * OpenSsl.isAvailable(). */ TCP, /** @@ -299,7 +299,7 @@ public enum DefaultConfigurationType { * OpenSsl.isAlpnSupported(), * {@link #HTTP2_CIPHERS}, * ALPN support, - * HTTP/1.1 and HTTP/2 support + * HTTP/1.1 and HTTP/2 support. */ H2 } @@ -314,7 +314,7 @@ public interface DefaultConfigurationSpec { /** * Default configuration type that will be applied to the provided - * {@link SslContextBuilder} + * {@link SslContextBuilder}. * * @param type The default configuration type. * @return {@code this} @@ -631,7 +631,7 @@ static void addSslReadHandler(ChannelPipeline pipeline, boolean sslDebug) { static final class Build implements SslContextSpec, DefaultConfigurationSpec, Builder { /** - * Default SSL handshake timeout (milliseconds), fallback to 10 seconds + * Default SSL handshake timeout (milliseconds), fallback to 10 seconds. */ static final long DEFAULT_SSL_HANDSHAKE_TIMEOUT = Long.parseLong(System.getProperty( diff --git a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClient.java b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClient.java index 70a1b01c0e..5a01e4ec50 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClient.java +++ b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClient.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -74,7 +74,7 @@ public abstract class TcpClient extends ClientTransport { /** - * Prepare a pooled {@link TcpClient} + * Prepare a pooled {@link TcpClient}. * * @return a {@link TcpClient} */ @@ -84,7 +84,7 @@ public static TcpClient create() { /** - * Prepare a {@link TcpClient} + * Prepare a {@link TcpClient}. * * @param provider a {@link ConnectionProvider} to acquire connections * @@ -96,7 +96,7 @@ public static TcpClient create(ConnectionProvider provider) { } /** - * Prepare a non pooled {@link TcpClient} + * Prepare a non pooled {@link TcpClient}. * * @return a {@link TcpClient} */ @@ -219,7 +219,7 @@ public TcpClient doOnDisconnected(Consumer doOnDisconnected) } /** - * Attach an IO handler to react on connected client + * Attach an IO handler to react on connected client. * * @param handler an IO handler that can dispose underlying connection when {@link * Publisher} terminates. @@ -252,7 +252,7 @@ public TcpClient noProxy() { } /** - * Remove any previously applied SSL configuration customization + * Remove any previously applied SSL configuration customization. * * @return a new {@link TcpClient} */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientBootstrap.java b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientBootstrap.java index 61f6bf55df..a52f848ab5 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientBootstrap.java +++ b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientBootstrap.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,7 +32,7 @@ import java.util.function.Function; /** - * This class provides a migration for the {@link TcpClient#bootstrap(Function)} in 0.9.x + * This class provides a migration for the {@link TcpClient#bootstrap(Function)} in 0.9.x. * * @author Violeta Georgieva * @deprecated Use {@link TcpClient} methods for configurations. This class will be removed in version 1.1.0. diff --git a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientConfig.java b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientConfig.java index ee0ff2060d..bafe3dbe24 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientConfig.java +++ b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpClientConfig.java @@ -59,7 +59,7 @@ public ChannelOperations.OnSetup channelOperationsProvider() { } /** - * Return true if that {@link TcpClient} secured via SSL transport + * Return true if that {@link TcpClient} secured via SSL transport. * * @return true if that {@link TcpClient} secured via SSL transport */ @@ -69,7 +69,7 @@ public final boolean isSecure() { /** * Return the current {@link SslProvider} if that {@link TcpClient} secured via SSL - * transport or null + * transport or null. * * @return the current {@link SslProvider} if that {@link TcpClient} secured via SSL * transport or null @@ -140,7 +140,7 @@ protected ChannelPipelineConfigurer defaultOnChannelInit() { /** * Default value whether the SSL debugging on the client side will be enabled/disabled, - * fallback to SSL debugging disabled + * fallback to SSL debugging disabled. */ static final boolean SSL_DEBUG = Boolean.parseBoolean(System.getProperty(ReactorNetty.SSL_CLIENT_DEBUG, "false")); diff --git a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpResources.java b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpResources.java index ebc90b95f2..223fde7708 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpResources.java +++ b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpResources.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,7 +39,7 @@ import static java.util.Objects.requireNonNull; /** - * Hold the default Tcp resources + * Hold the default Tcp resources. * * @author Stephane Maldini * @since 0.6 @@ -101,7 +101,7 @@ public static Mono disposeLoopsAndConnectionsLater(Duration quietPeriod, D } /** - * Return the global TCP resources for event loops and pooling + * Return the global TCP resources for event loops and pooling. * * @return the global TCP resources for event loops and pooling */ @@ -110,7 +110,7 @@ public static TcpResources get() { } /** - * Reset TCP resources to default and return its instance + * Reset TCP resources to default and return its instance. * * @return the global TCP resources */ @@ -274,7 +274,7 @@ public EventLoopGroup onServerSelect(boolean useNative) { } /** - * Dispose underlying resources + * Dispose underlying resources. */ protected void _dispose() { defaultProvider.dispose(); diff --git a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpServer.java b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpServer.java index c6b162092b..cc5f7b8838 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpServer.java +++ b/reactor-netty-core/src/main/java/reactor/netty/tcp/TcpServer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -66,7 +66,7 @@ public abstract class TcpServer extends ServerTransport { /** - * Prepare a {@link TcpServer} + * Prepare a {@link TcpServer}. * * @return a new {@link TcpServer} */ @@ -105,7 +105,7 @@ public TcpServer doOnUnbound(Consumer doOnUnbound) { } /** - * Attaches an I/O handler to react on a connected client + * Attaches an I/O handler to react on a connected client. * * @param handler an I/O handler that can dispose underlying connection when * {@link Publisher} terminates. @@ -133,7 +133,7 @@ public TcpServer metrics(boolean enable, Supplier ClientTransport implementation * @param Client Configuration implementation @@ -204,7 +204,7 @@ public T host(String host) { } /** - * Remove any previously applied Proxy configuration customization + * Remove any previously applied Proxy configuration customization. * * @return a new {@link ClientTransport} reference */ @@ -233,7 +233,7 @@ public T port(int port) { } /** - * Apply a proxy configuration + * Apply a proxy configuration. * * @param proxyOptions the proxy configuration callback * @return a new {@link ClientTransport} reference diff --git a/reactor-netty-core/src/main/java/reactor/netty/transport/ClientTransportConfig.java b/reactor-netty-core/src/main/java/reactor/netty/transport/ClientTransportConfig.java index a56b6596bf..f7d2137b2f 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/transport/ClientTransportConfig.java +++ b/reactor-netty-core/src/main/java/reactor/netty/transport/ClientTransportConfig.java @@ -59,7 +59,7 @@ public int channelHash() { } /** - * Return the {@link ConnectionProvider} + * Return the {@link ConnectionProvider}. * * @return the {@link ConnectionProvider} */ @@ -68,7 +68,7 @@ public ConnectionProvider connectionProvider() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -78,7 +78,7 @@ public final Consumer doOnConnect() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -88,7 +88,7 @@ public final Consumer doOnConnected() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -98,7 +98,7 @@ public final Consumer doOnDisconnected() { } /** - * Return true if that {@link ClientTransportConfig} is configured with a proxy + * Return true if that {@link ClientTransportConfig} is configured with a proxy. * * @return true if that {@link ClientTransportConfig} is configured with a proxy */ @@ -107,7 +107,7 @@ public final boolean hasProxy() { } /** - * Return the configured {@link NameResolverProvider} or null + * Return the configured {@link NameResolverProvider} or null. * * @return the configured {@link NameResolverProvider} or null */ @@ -117,7 +117,7 @@ public NameResolverProvider getNameResolverProvider() { } /** - * Return the {@link ProxyProvider} if any or null + * Return the {@link ProxyProvider} if any or null. * * @return the {@link ProxyProvider} if any or null */ @@ -127,7 +127,7 @@ public final ProxyProvider proxyProvider() { } /** - * Return the remote configured {@link SocketAddress} + * Return the remote configured {@link SocketAddress}. * * @return the remote configured {@link SocketAddress} */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/transport/NameResolverProvider.java b/reactor-netty-core/src/main/java/reactor/netty/transport/NameResolverProvider.java index 5d6fed76a3..13b85836f3 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/transport/NameResolverProvider.java +++ b/reactor-netty-core/src/main/java/reactor/netty/transport/NameResolverProvider.java @@ -51,7 +51,7 @@ public final class NameResolverProvider { public interface NameResolverSpec { /** - * Build a new {@link NameResolverProvider} + * Build a new {@link NameResolverProvider}. * * @return a new {@link NameResolverProvider} */ @@ -181,7 +181,7 @@ public interface NameResolverSpec { NameResolverSpec resolvedAddressTypes(ResolvedAddressTypes resolvedAddressTypes); /** - * Sets the resolve cache to use for DNS resolution + * Sets the resolve cache to use for DNS resolution. * * @param resolveCache the resolution DNS cache * @return {@code this} @@ -410,7 +410,7 @@ public ResolvedAddressTypes resolvedAddressTypes() { } /** - * Returns the configured DNS resolver cache or null + * Returns the configured DNS resolver cache or null. * * @return the configured DNS resolver cache or null * @since 1.0.27 diff --git a/reactor-netty-core/src/main/java/reactor/netty/transport/ProxyProvider.java b/reactor-netty-core/src/main/java/reactor/netty/transport/ProxyProvider.java index 057a2d6127..3d3ec209e1 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/transport/ProxyProvider.java +++ b/reactor-netty-core/src/main/java/reactor/netty/transport/ProxyProvider.java @@ -45,14 +45,14 @@ import reactor.util.annotation.Nullable; /** - * Proxy configuration + * Proxy configuration. * * @author Violeta Georgieva */ public final class ProxyProvider { /** - * Creates a builder for {@link ProxyProvider ProxyProvider} + * Creates a builder for {@link ProxyProvider ProxyProvider}. * * @return a new ProxyProvider builder */ @@ -89,7 +89,7 @@ public static ProxyProvider.TypeSpec builder() { } /** - * The proxy type + * The proxy type. * * @return The proxy type */ @@ -108,7 +108,7 @@ public final Supplier getAddress() { /** * A predicate {@link Predicate} on {@link SocketAddress} that returns true when the provided address should be - * reached directly, bypassing the proxy + * reached directly, bypassing the proxy. * * @return The predicate {@link Predicate} to test the incoming {@link SocketAddress} if it should be reached * directly, bypassing the proxy @@ -119,7 +119,7 @@ public final Predicate getNonProxyHostsPredicate() { } /** - * Return a new eventual {@link ProxyHandler} + * Return a new eventual {@link ProxyHandler}. * * @return a new eventual {@link ProxyHandler} */ @@ -166,7 +166,7 @@ public boolean shouldProxy(SocketAddress address) { } /** - * Proxy Type + * Proxy Type. */ public enum Proxy { HTTP, SOCKS4, SOCKS5 @@ -487,7 +487,7 @@ static final class RegexShouldProxyPredicate implements Predicate /** * Creates a {@link RegexShouldProxyPredicate} based off the provided pattern with possible wildcards as - * described in https://docs.oracle.com/javase/7/docs/api/java/net/doc-files/net-properties.html + * described in https://docs.oracle.com/javase/7/docs/api/java/net/doc-files/net-properties.html. * * @param pattern The string wildcarded expression * @return a predicate whether we should direct to proxy @@ -652,7 +652,7 @@ public interface Builder { Builder connectTimeoutMillis(long connectTimeoutMillis); /** - * Builds new ProxyProvider + * Builds new ProxyProvider. * * @return builds new ProxyProvider */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransport.java b/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransport.java index 7fe6833536..11538b4c70 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransport.java +++ b/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransport.java @@ -64,7 +64,7 @@ import static reactor.netty.ReactorNetty.format; /** - * A generic server {@link Transport} that will {@link #bind()} to a local address and provide a {@link DisposableServer} + * A generic server {@link Transport} that will {@link #bind()} to a local address and provide a {@link DisposableServer}. * * @param ServerTransport implementation * @param Server Configuration implementation @@ -205,7 +205,7 @@ public T childAttr(AttributeKey key, @Nullable A value) { } /** - * Set or add the given {@link ConnectionObserver} for each remote connection + * Set or add the given {@link ConnectionObserver} for each remote connection. * * @param observer the {@link ConnectionObserver} addition * @return a new {@link ServerTransport} reference diff --git a/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransportConfig.java b/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransportConfig.java index cf2a0c4b6a..59b9227b0a 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransportConfig.java +++ b/reactor-netty-core/src/main/java/reactor/netty/transport/ServerTransportConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -48,7 +48,7 @@ public abstract class ServerTransportConfig extends TransportConfig { /** - * Return the read-only default channel attributes for each remote connection + * Return the read-only default channel attributes for each remote connection. * * @return the read-only default channel attributes for each remote connection */ @@ -61,7 +61,7 @@ public abstract class ServerTransportConfig extend /** * Return the configured {@link ConnectionObserver} if any or - * {@link ConnectionObserver#emptyListener()} for each remote connection + * {@link ConnectionObserver#emptyListener()} for each remote connection. * * @return the configured {@link ConnectionObserver} if any or * {@link ConnectionObserver#emptyListener()} for each remote connection @@ -71,7 +71,7 @@ public final ConnectionObserver childObserver() { } /** - * Return the read-only {@link ChannelOption} map for each remote connection + * Return the read-only {@link ChannelOption} map for each remote connection. * * @return the read-only {@link ChannelOption} map for each remote connection */ @@ -83,7 +83,7 @@ public final ConnectionObserver childObserver() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -93,7 +93,7 @@ public final Consumer doOnBind() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -103,7 +103,7 @@ public final Consumer doOnBound() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -113,7 +113,7 @@ public final Consumer doOnConnection() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -134,7 +134,7 @@ public final Consumer doOnUnbound() { Consumer doOnUnbound; /** - * Default ServerTransportConfig with options + * Default ServerTransportConfig with options. * * @param options default options for the selector * @param childOptions default options for each connected channel diff --git a/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConfig.java b/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConfig.java index 5a77bf4b88..6aa98266be 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConfig.java +++ b/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConfig.java @@ -59,7 +59,7 @@ public abstract class TransportConfig { /** - * Return the read-only default channel attributes + * Return the read-only default channel attributes. * * @return the read-only default channel attributes */ @@ -71,7 +71,7 @@ public abstract class TransportConfig { } /** - * Return the local {@link SocketAddress} supplier that will be bound or null + * Return the local {@link SocketAddress} supplier that will be bound or null. * * @return the {@link SocketAddress} supplier */ @@ -96,7 +96,7 @@ public int channelHash() { } /** - * Return the configured {@link ChannelGroup} or null + * Return the configured {@link ChannelGroup} or null. * * @return the configured {@link ChannelGroup} or null */ @@ -106,7 +106,7 @@ public final ChannelGroup channelGroup() { } /** - * Return the {@link ChannelInitializer} that will be used for initializing the channel pipeline + * Return the {@link ChannelInitializer} that will be used for initializing the channel pipeline. * * @param connectionObserver the configured {@link ConnectionObserver} * @param remoteAddress the remote address @@ -120,7 +120,7 @@ public final ChannelInitializer channelInitializer(ConnectionObserver c } /** - * Return the associated {@link ChannelOperations.OnSetup}, config implementations might override this + * Return the associated {@link ChannelOperations.OnSetup}, config implementations might override this. * * @return the associated {@link ChannelOperations.OnSetup} */ @@ -129,7 +129,7 @@ public ChannelOperations.OnSetup channelOperationsProvider() { } /** - * Return the configured {@link ConnectionObserver} if any or {@link ConnectionObserver#emptyListener()} + * Return the configured {@link ConnectionObserver} if any or {@link ConnectionObserver#emptyListener()}. * * @return the configured {@link ConnectionObserver} if any or {@link ConnectionObserver#emptyListener()} */ @@ -138,7 +138,7 @@ public final ConnectionObserver connectionObserver() { } /** - * Return the configured callback if any or {@link ChannelPipelineConfigurer#emptyConfigurer()} + * Return the configured callback if any or {@link ChannelPipelineConfigurer#emptyConfigurer()}. * * @return the configured callback if any or {@link ChannelPipelineConfigurer#emptyConfigurer()} */ @@ -147,7 +147,7 @@ public final ChannelPipelineConfigurer doOnChannelInit() { } /** - * Return {@code true} if prefer native event loop and channel factory (e.g. epoll or kqueue) + * Return {@code true} if prefer native event loop and channel factory (e.g. epoll or kqueue). * * @return {@code true} if prefer native event loop and channel factory (e.g. epoll or kqueue) */ @@ -156,7 +156,7 @@ public final boolean isPreferNative() { } /** - * Return the configured {@link LoggingHandler} or null + * Return the configured {@link LoggingHandler} or null. * * @return the configured {@link LoggingHandler} or null */ @@ -166,7 +166,7 @@ public final LoggingHandler loggingHandler() { } /** - * Return the configured {@link LoopResources} or the default + * Return the configured {@link LoopResources} or the default. * * @return the configured {@link LoopResources} or the default */ @@ -175,7 +175,7 @@ public final LoopResources loopResources() { } /** - * Return the configured metrics recorder {@link ChannelMetricsRecorder} or null + * Return the configured metrics recorder {@link ChannelMetricsRecorder} or null. * * @return the configured metrics recorder {@link ChannelMetricsRecorder} or null */ @@ -185,7 +185,7 @@ public final Supplier metricsRecorder() { } /** - * Return the read-only {@link ChannelOption} map + * Return the read-only {@link ChannelOption} map. * * @return the read-only {@link ChannelOption} map */ @@ -211,7 +211,7 @@ public final Supplier metricsRecorder() { boolean preferNative; /** - * Default TransportConfig with options + * Default TransportConfig with options. */ protected TransportConfig(Map, ?> options) { this.attrs = Collections.emptyMap(); @@ -222,7 +222,7 @@ protected TransportConfig(Map, ?> options) { } /** - * Default TransportConfig with options + * Default TransportConfig with options. */ protected TransportConfig(Map, ?> options, Supplier bindAddress) { this.attrs = Collections.emptyMap(); @@ -234,7 +234,7 @@ protected TransportConfig(Map, ?> options, Supplier *
  • {@link io.netty.channel.socket.SocketChannel}
    • *
  • {@link io.netty.channel.socket.ServerSocketChannel}
    • @@ -285,14 +285,14 @@ protected ChannelFactory connectionFactory(EventLoopGroup elg protected abstract ConnectionObserver defaultConnectionObserver(); /** - * Return the default {@link LoggingHandler} to wiretap this transport + * Return the default {@link LoggingHandler} to wiretap this transport. * * @return the default {@link LoggingHandler} to wiretap this transport */ protected abstract LoggingHandler defaultLoggingHandler(); /** - * Return the default {@link LoopResources} for this transport + * Return the default {@link LoopResources} for this transport. * * @return the default {@link LoopResources} for this transport */ @@ -306,7 +306,7 @@ protected ChannelFactory connectionFactory(EventLoopGroup elg protected abstract ChannelMetricsRecorder defaultMetricsRecorder(); /** - * Return the default callback if any or {@link ChannelPipelineConfigurer#emptyConfigurer()} + * Return the default callback if any or {@link ChannelPipelineConfigurer#emptyConfigurer()}. * * @return the default callback if any or {@link ChannelPipelineConfigurer#emptyConfigurer()} */ @@ -324,7 +324,7 @@ protected void loggingHandler(LoggingHandler loggingHandler) { } /** - * Obtains immediately the {@link ChannelMetricsRecorder} from the provided {@link Supplier} + * Obtains immediately the {@link ChannelMetricsRecorder} from the provided {@link Supplier}. * * @param metricsRecorderSupplier a supplier for the {@link ChannelMetricsRecorder} */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConnector.java b/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConnector.java index 5bb200d316..ce7d0f396a 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConnector.java +++ b/reactor-netty-core/src/main/java/reactor/netty/transport/TransportConnector.java @@ -180,7 +180,7 @@ public static Mono connect(TransportConfig config, SocketAddress remote } /** - * Set the channel attributes + * Set the channel attributes. * * @param channel the channel * @param attrs the attributes @@ -193,7 +193,7 @@ static void setAttributes(Channel channel, Map, ?> attrs) { } /** - * Set the channel options + * Set the channel options. * * @param channel the channel * @param options the options diff --git a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClient.java b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClient.java index 0b3753d9ba..3645ab5663 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClient.java +++ b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClient.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -64,7 +64,7 @@ public abstract class UdpClient extends ClientTransport { /** - * Prepare a {@link UdpClient} + * Prepare a {@link UdpClient}. * * @return a {@link UdpClient} */ @@ -113,7 +113,7 @@ public final UdpClient doOnDisconnected(Consumer doOnDisconn } /** - * Attach an IO handler to react on connected client + * Attach an IO handler to react on connected client. * * @param handler an IO handler that can dispose underlying connection when {@link * Publisher} terminates. diff --git a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClientConfig.java b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClientConfig.java index bbe0aa9427..a4d2ea9f43 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClientConfig.java +++ b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpClientConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -54,7 +54,7 @@ public final ChannelOperations.OnSetup channelOperationsProvider() { } /** - * Return the configured {@link InternetProtocolFamily} to run with or null + * Return the configured {@link InternetProtocolFamily} to run with or null. * * @return the configured {@link InternetProtocolFamily} to run with or null */ diff --git a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpResources.java b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpResources.java index 4d3f0fe1a0..8afe348534 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpResources.java +++ b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpResources.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -34,14 +34,14 @@ import static java.util.Objects.requireNonNull; /** - * Hold the default UDP resources + * Hold the default UDP resources. * * @author Violeta Georgieva */ public class UdpResources implements LoopResources { /** - * Return the global UDP resources for pooling + * Return the global UDP resources for pooling. * * @return the global UDP resources for pooling */ @@ -50,7 +50,7 @@ public static UdpResources get() { } /** - * Reset UDP resources to default and return its instance + * Reset UDP resources to default and return its instance. * * @return the global UDP resources */ @@ -205,7 +205,7 @@ public EventLoopGroup onServerSelect(boolean useNative) { } /** - * Dispose underlying resources + * Dispose underlying resources. */ protected void _dispose() { _disposeResolver(); @@ -322,7 +322,7 @@ static T create(@Nullable T previous, /** * Default worker thread count, fallback to available processor - * (but with a minimum value of 4) + * (but with a minimum value of 4). */ static final int DEFAULT_UDP_THREAD_COUNT = Integer.parseInt(System.getProperty( ReactorNetty.UDP_IO_THREAD_COUNT, diff --git a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServer.java b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServer.java index 70cc569281..e363230c96 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServer.java +++ b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -65,7 +65,7 @@ public abstract class UdpServer extends Transport { /** - * Prepare a {@link UdpServer} + * Prepare a {@link UdpServer}. * * @return a {@link UdpServer} */ @@ -173,7 +173,7 @@ public final UdpServer doOnUnbound(Consumer doOnUnbound) { } /** - * Attach an IO handler to react on connected client + * Attach an IO handler to react on connected client. * * @param handler an IO handler that can dispose underlying connection when {@link * Publisher} terminates. diff --git a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServerConfig.java b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServerConfig.java index e2a70582b7..c31513876a 100644 --- a/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServerConfig.java +++ b/reactor-netty-core/src/main/java/reactor/netty/udp/UdpServerConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -57,7 +57,7 @@ public ChannelOperations.OnSetup channelOperationsProvider() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -67,7 +67,7 @@ public final Consumer doOnBind() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -77,7 +77,7 @@ public final Consumer doOnBound() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -87,7 +87,7 @@ public final Consumer doOnUnbound() { } /** - * Return the configured {@link InternetProtocolFamily} to run with or null + * Return the configured {@link InternetProtocolFamily} to run with or null. * * @return the configured {@link InternetProtocolFamily} to run with or null */ diff --git a/reactor-netty-core/src/test/java/reactor/netty/BlockHoundIntegrationTest.java b/reactor-netty-core/src/test/java/reactor/netty/BlockHoundIntegrationTest.java index f01a79b662..770def5ae7 100644 --- a/reactor-netty-core/src/test/java/reactor/netty/BlockHoundIntegrationTest.java +++ b/reactor-netty-core/src/test/java/reactor/netty/BlockHoundIntegrationTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -27,7 +27,7 @@ import static org.assertj.core.api.Assertions.assertThatExceptionOfType; /** - * Smoke test that ensures that BlockHound is enabled + * Smoke test that ensures that BlockHound is enabled. */ class BlockHoundIntegrationTest { diff --git a/reactor-netty-core/src/test/java/reactor/netty/ReactorNettyTest.java b/reactor-netty-core/src/test/java/reactor/netty/ReactorNettyTest.java index 950f77a147..0ce949db57 100644 --- a/reactor-netty-core/src/test/java/reactor/netty/ReactorNettyTest.java +++ b/reactor-netty-core/src/test/java/reactor/netty/ReactorNettyTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,7 +35,7 @@ */ class ReactorNettyTest { - /** + /* * Original channel string: [id: 0x1320c27a] * Expected channel string: [1320c27a] */ @@ -44,7 +44,7 @@ void testFormatChannel() { doTestFormatChannel(new TestChannel(new EmbeddedChannel())); } - /** + /* * Original channel string: [id: 0x2f07a7a0, L:127.0.0.1:8080] * Expected channel string: [2f07a7a0, L:127.0.0.1:8080] */ @@ -54,7 +54,7 @@ void testFormatChannelWithLocalAddress() { InetSocketAddress.createUnresolved("127.0.0.1", 8080))); } - /** + /* * Original channel string: [id: 0x9ed4b854, L:127.0.0.1:8080 - R:127.0.0.1:9090] * Expected channel string: [9ed4b854, L:127.0.0.1:8080 - R:127.0.0.1:9090] */ @@ -65,7 +65,7 @@ void testFormatChannelWithLocalAndRemoteAddresses() { InetSocketAddress.createUnresolved("127.0.0.1", 9090))); } - /** + /* * Original channel id: ()[id: 0x1320c27a] * Expected channel id: ()[1320c27a] */ @@ -74,7 +74,7 @@ void testFormatChildChannel() { doTestFormatChannel(new ChildTestChannel(new TestChannel(new EmbeddedChannel()))); } - /** + /* * Original channel id: ()[id: 0x867c3169, L:127.0.0.1:8080] * Expected channel id: ()[867c3169, L:127.0.0.1:8080] */ @@ -84,7 +84,7 @@ void testFormatChildChannelWithLocalAddresses() { InetSocketAddress.createUnresolved("127.0.0.1", 8080))); } - /** + /* * Original channel id: ()[id: 0x43f4ed87, L:127.0.0.1:8080 - R:127.0.0.1:9090] * Expected channel id: ()[43f4ed87, L:127.0.0.1:8080 - R:127.0.0.1:9090] */ diff --git a/reactor-netty-core/src/test/java/reactor/netty/transport/ClientTransportTest.java b/reactor-netty-core/src/test/java/reactor/netty/transport/ClientTransportTest.java index da236dd882..69e49b7350 100644 --- a/reactor-netty-core/src/test/java/reactor/netty/transport/ClientTransportTest.java +++ b/reactor-netty-core/src/test/java/reactor/netty/transport/ClientTransportTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -238,7 +238,7 @@ static TestClientTransport createTestTransportForProxy() { } /** - * On Windows OS it is rare to have hosts file + * On Windows OS it is rare to have hosts file. */ @Test @DisabledOnOs(WINDOWS) @@ -247,7 +247,7 @@ void testDefaultHostsFileEntriesResolver() throws Exception { } /** - * On Windows OS it is rare to have hosts file + * On Windows OS it is rare to have hosts file. */ @Test @DisabledOnOs(WINDOWS) diff --git a/reactor-netty-core/src/test/java/reactor/netty/transport/TransportEventLoopMetricsTest.java b/reactor-netty-core/src/test/java/reactor/netty/transport/TransportEventLoopMetricsTest.java index 95317b40c1..520fb30748 100644 --- a/reactor-netty-core/src/test/java/reactor/netty/transport/TransportEventLoopMetricsTest.java +++ b/reactor-netty-core/src/test/java/reactor/netty/transport/TransportEventLoopMetricsTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -43,7 +43,7 @@ import static reactor.netty.Metrics.PENDING_TASKS; /** - * Tests for event loop metrics + * Tests for event loop metrics. * * @author Pierre De Rop * @since 1.0.14 diff --git a/reactor-netty-examples/src/main/java/reactor/netty/examples/documentation/http/server/sse/Application.java b/reactor-netty-examples/src/main/java/reactor/netty/examples/documentation/http/server/sse/Application.java index 3e71142b56..d0df0c76a4 100644 --- a/reactor-netty-examples/src/main/java/reactor/netty/examples/documentation/http/server/sse/Application.java +++ b/reactor-netty-examples/src/main/java/reactor/netty/examples/documentation/http/server/sse/Application.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -43,9 +43,9 @@ public static void main(String[] args) { } /** - * Prepares SSE response - * The "Content-Type" is "text/event-stream" - * The flushing strategy is "flush after every element" emitted by the provided Publisher + * Prepares SSE response. + * The "Content-Type" is "text/event-stream". + * The flushing strategy is "flush after every element" emitted by the provided Publisher. */ private static BiFunction> serveSse() { Flux flux = Flux.interval(Duration.ofSeconds(10)); diff --git a/reactor-netty-http-brave/src/main/java/reactor/netty/http/brave/TracingHttpClientDecorator.java b/reactor-netty-http-brave/src/main/java/reactor/netty/http/brave/TracingHttpClientDecorator.java index 8804255f3d..fe62c4cca5 100644 --- a/reactor-netty-http-brave/src/main/java/reactor/netty/http/brave/TracingHttpClientDecorator.java +++ b/reactor-netty-http-brave/src/main/java/reactor/netty/http/brave/TracingHttpClientDecorator.java @@ -43,7 +43,7 @@ /** * This class is based on - * https://github.com/spring-cloud/spring-cloud-sleuth/blob/d969aa7b549e9c82729e16dc7d846654e32ddef9/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/web/client/HttpClientBeanPostProcessor.java + * https://github.com/spring-cloud/spring-cloud-sleuth/blob/d969aa7b549e9c82729e16dc7d846654e32ddef9/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/web/client/HttpClientBeanPostProcessor.java. */ final class TracingHttpClientDecorator { diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/ContextAwareHttpMetricsRecorder.java b/reactor-netty-http/src/main/java/reactor/netty/http/ContextAwareHttpMetricsRecorder.java index f245a27c7a..b0533f8c7b 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/ContextAwareHttpMetricsRecorder.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/ContextAwareHttpMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,7 +30,7 @@ public abstract class ContextAwareHttpMetricsRecorder extends ContextAwareChannelMetricsRecorder implements HttpMetricsRecorder { /** - * Increments the number of the errors that are occurred + * Increments the number of the errors that are occurred. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param remoteAddress The remote peer @@ -39,7 +39,7 @@ public abstract class ContextAwareHttpMetricsRecorder extends ContextAwareChanne public abstract void incrementErrorsCount(ContextView contextView, SocketAddress remoteAddress, String uri); /** - * Records the amount of the data that is received, in bytes + * Records the amount of the data that is received, in bytes. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param remoteAddress The remote peer @@ -49,7 +49,7 @@ public abstract class ContextAwareHttpMetricsRecorder extends ContextAwareChanne public abstract void recordDataReceived(ContextView contextView, SocketAddress remoteAddress, String uri, long bytes); /** - * Records the amount of the data that is sent, in bytes + * Records the amount of the data that is sent, in bytes. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param remoteAddress The remote peer diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/Http2SettingsSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/Http2SettingsSpec.java index 977a2256c4..3a0627c6de 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/Http2SettingsSpec.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/Http2SettingsSpec.java @@ -32,7 +32,7 @@ public final class Http2SettingsSpec { public interface Builder { /** - * Build a new {@link Http2SettingsSpec} + * Build a new {@link Http2SettingsSpec}. * * @return a new {@link Http2SettingsSpec} */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/HttpDecoderSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/HttpDecoderSpec.java index 2929de984a..c86d330ffe 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/HttpDecoderSpec.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/HttpDecoderSpec.java @@ -19,7 +19,7 @@ /** * A configuration builder to fine tune the {@code HttpCodec} (or more precisely - * the settings for the decoder) + * the settings for the decoder). * * @author Violeta Georgieva */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/HttpInfos.java b/reactor-netty-http/src/main/java/reactor/netty/http/HttpInfos.java index 7854bc7a59..ddcdca0a43 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/HttpInfos.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/HttpInfos.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,14 +32,14 @@ public interface HttpInfos { /** - * Returns resolved HTTP cookies + * Returns resolved HTTP cookies. * * @return Resolved HTTP cookies */ Map> cookies(); /** - * Returns the decoded path portion from the {@link #uri()} + * Returns the decoded path portion from the {@link #uri()}. * * @return the decoded path portion from the {@link #uri()} * @since 0.9.6 @@ -69,28 +69,28 @@ public interface HttpInfos { String requestId(); /** - * Is the request keep alive + * Is the request keep alive. * * @return is keep alive */ boolean isKeepAlive(); /** - * Returns true if websocket connection (upgraded) + * Returns true if websocket connection (upgraded). * * @return true if websocket connection */ boolean isWebsocket(); /** - * Returns the resolved request method (HTTP 1.1 etc.) + * Returns the resolved request method (HTTP 1.1 etc.). * * @return the resolved request method (HTTP 1.1 etc.) */ HttpMethod method(); /** - * Returns the decoded path portion from the {@link #uri()} without the leading and trailing '/' if present + * Returns the decoded path portion from the {@link #uri()} without the leading and trailing '/' if present. * * @return the decoded path portion from the {@link #uri()} without the leading and trailing '/' if present */ @@ -111,14 +111,14 @@ default String path() { } /** - * Returns the resolved target address + * Returns the resolved target address. * * @return the resolved target address */ String uri(); /** - * Returns the resolved request version (HTTP 1.1 etc) + * Returns the resolved request version (HTTP 1.1 etc). * * @return the resolved request version (HTTP 1.1 etc) */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/HttpMetricsRecorder.java b/reactor-netty-http/src/main/java/reactor/netty/http/HttpMetricsRecorder.java index 3dde958fd5..9a85a55de8 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/HttpMetricsRecorder.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/HttpMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -27,7 +27,7 @@ public interface HttpMetricsRecorder extends ChannelMetricsRecorder { /** - * Records the amount of the data that is received, in bytes + * Records the amount of the data that is received, in bytes. * * @param remoteAddress The remote peer * @param uri the requested URI @@ -36,7 +36,7 @@ public interface HttpMetricsRecorder extends ChannelMetricsRecorder { void recordDataReceived(SocketAddress remoteAddress, String uri, long bytes); /** - * Records the amount of the data that is sent, in bytes + * Records the amount of the data that is sent, in bytes. * * @param remoteAddress The remote peer * @param uri the requested URI @@ -45,7 +45,7 @@ public interface HttpMetricsRecorder extends ChannelMetricsRecorder { void recordDataSent(SocketAddress remoteAddress, String uri, long bytes); /** - * Increments the number of the errors that are occurred + * Increments the number of the errors that are occurred. * * @param remoteAddress The remote peer * @param uri the requested URI diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/HttpOperations.java b/reactor-netty-http/src/main/java/reactor/netty/http/HttpOperations.java index 8a9f059665..80e9bbf764 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/HttpOperations.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/HttpOperations.java @@ -90,7 +90,7 @@ protected HttpOperations(Connection connection, ConnectionObserver listener, Htt } /** - * Has headers been sent + * Has headers been sent. * * @return true if headers have been sent */ @@ -302,7 +302,7 @@ static void autoAddHttpExtractor(Connection c, String name, ChannelHandler handl } /** - * Mark the headers sent + * Mark the headers sent. * * @return true if marked for the first time */ @@ -327,7 +327,7 @@ protected final boolean markSentHeaders(Object... objectsToRelease) { } /** - * Mark the body sent + * Mark the body sent. * * @return true if marked for the first time */ @@ -336,7 +336,7 @@ protected final boolean markSentBody() { } /** - * Has Body been sent + * Has Body been sent. * * @return true if body has been sent * @since 1.0.37 @@ -346,7 +346,7 @@ protected final boolean hasSentBody() { } /** - * Mark the headers and body sent + * Mark the headers and body sent. * * @return true if marked for the first time */ @@ -379,7 +379,7 @@ protected final String initShortId() { } /** - * Returns the decoded path portion from the provided {@code uri} + * Returns the decoded path portion from the provided {@code uri}. * * @param uri an HTTP URL that may contain a path with query/fragment * @return the decoded path portion from the provided {@code uri} @@ -418,7 +418,7 @@ else if (!SCHEME_PATTERN.matcher(tempUri).matches()) { } /** - * Outbound Netty HttpMessage + * Outbound Netty HttpMessage. * * @return Outbound Netty HttpMessage */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/HttpProtocol.java b/reactor-netty-http/src/main/java/reactor/netty/http/HttpProtocol.java index da1060d285..d93041d71f 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/HttpProtocol.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/HttpProtocol.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,14 +17,14 @@ /** * An enum defining various HTTP negotiations between H2, H2C-upgrade, - * H2C-prior-knowledge and HTTP/1.1 + * H2C-prior-knowledge and HTTP/1.1. * * @author Stephane Maldini */ public enum HttpProtocol { /** - * The default supported HTTP protocol by HttpServer and HttpClient + * The default supported HTTP protocol by HttpServer and HttpClient. */ HTTP11, diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/HttpResources.java b/reactor-netty-http/src/main/java/reactor/netty/http/HttpResources.java index a94268145b..dd429d431a 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/HttpResources.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/HttpResources.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,7 +30,7 @@ import static java.util.Objects.requireNonNull; /** - * Hold the default HTTP/1.x resources + * Hold the default HTTP/1.x resources. * * @author Stephane Maldini * @since 0.6 @@ -101,7 +101,7 @@ public static Mono disposeLoopsAndConnectionsLater(Duration quietPeriod, D } /** - * Return the global HTTP resources for event loops and pooling + * Return the global HTTP resources for event loops and pooling. * * @return the global HTTP resources for event loops and pooling */ @@ -110,7 +110,7 @@ public static HttpResources get() { } /** - * Reset http resources to default and return its instance + * Reset http resources to default and return its instance. * * @return the global HTTP resources */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/ContextAwareHttpClientMetricsRecorder.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/ContextAwareHttpClientMetricsRecorder.java index 77d4ed0727..8b2193cfe5 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/ContextAwareHttpClientMetricsRecorder.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/ContextAwareHttpClientMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,7 +23,7 @@ import java.time.Duration; /** - * {@link ContextView} aware class for collecting metrics on HTTP client level + * {@link ContextView} aware class for collecting metrics on HTTP client level. * * @author Violeta Georgieva * @since 1.0.8 @@ -32,7 +32,7 @@ public abstract class ContextAwareHttpClientMetricsRecorder extends ContextAware implements HttpClientMetricsRecorder { /** - * Records the time that is spent in consuming incoming data + * Records the time that is spent in consuming incoming data. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param remoteAddress The remote peer @@ -45,7 +45,7 @@ public abstract void recordDataReceivedTime(ContextView contextView, SocketAddre String method, String status, Duration time); /** - * Records the time that is spent in sending outgoing data + * Records the time that is spent in sending outgoing data. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param remoteAddress The remote peer @@ -57,7 +57,7 @@ public abstract void recordDataSentTime(ContextView contextView, SocketAddress r String method, Duration time); /** - * Records the total time for the request/response + * Records the total time for the request/response. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param remoteAddress The remote peer diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/Http2AllocationStrategy.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/Http2AllocationStrategy.java index 2dd5c49c61..c6d3ba29d7 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/Http2AllocationStrategy.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/Http2AllocationStrategy.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2022-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,7 +33,7 @@ public final class Http2AllocationStrategy implements ConnectionProvider.Allocat public interface Builder { /** - * Build a new {@link Http2AllocationStrategy} + * Build a new {@link Http2AllocationStrategy}. * * @return a new {@link Http2AllocationStrategy} */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClient.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClient.java index 3d7ba7f28f..30b94a7810 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClient.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClient.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -109,12 +109,12 @@ public abstract class HttpClient extends ClientTransport> { /** - * Configure URI to use for this request/response + * Configure URI to use for this request/response. * * @param uri target URI, if starting with "/" it will be prepended with * {@link #baseUrl(String)} when available @@ -124,7 +124,7 @@ public interface UriConfiguration> { S uri(String uri); /** - * Configure URI to use for this request/response on subscribe + * Configure URI to use for this request/response on subscribe. * * @param uri target URI, if starting with "/" it will be prepended with * {@link #baseUrl(String)} when available @@ -575,7 +575,7 @@ public final HttpClient cookie(String name, Consumer cookieBuild /** * Configure the * {@link ClientCookieEncoder}, {@link ClientCookieDecoder} will be - * chosen based on the encoder + * chosen based on the encoder. * * @param encoder the preferred ClientCookieEncoder * @@ -590,7 +590,7 @@ public final HttpClient cookieCodec(ClientCookieEncoder encoder) { /** * Configure the - * {@link ClientCookieEncoder} and {@link ClientCookieDecoder} + * {@link ClientCookieEncoder} and {@link ClientCookieDecoder}. * * @param encoder the preferred ClientCookieEncoder * @param decoder the preferred ClientCookieDecoder @@ -1060,7 +1060,7 @@ public final HttpClient headersWhen(Function redirectRequestConsumer() { } /** - * Return the configured response timeout or null + * Return the configured response timeout or null. * * @return the configured response timeout or null */ @@ -265,7 +265,7 @@ public Duration responseTimeout() { /** * Returns the current {@link SslProvider} if that {@link HttpClient} secured via SSL - * transport or null + * transport or null. * * @return the current {@link SslProvider} if that {@link HttpClient} secured via SSL * transport or null @@ -286,7 +286,7 @@ public String uri() { /** * Returns the configured function that receives the actual uri and returns the uri tag value - * that will be used for the metrics with {@link reactor.netty.Metrics#URI} tag + * that will be used for the metrics with {@link reactor.netty.Metrics#URI} tag. * * @return the configured function that receives the actual uri and returns the uri tag value * that will be used for the metrics with {@link reactor.netty.Metrics#URI} tag @@ -723,7 +723,7 @@ static void configureHttp11Pipeline(ChannelPipeline p, /** * Default value whether the SSL debugging on the client side will be enabled/disabled, - * fallback to SSL debugging disabled + * fallback to SSL debugging disabled. */ static final boolean SSL_DEBUG = Boolean.parseBoolean(System.getProperty(ReactorNetty.SSL_CLIENT_DEBUG, "false")); diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientForm.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientForm.java index bda1a6479a..420bba7e9b 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientForm.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientForm.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,12 +24,12 @@ import reactor.util.annotation.Nullable; /** - * An HTTP Form builder + * An HTTP Form builder. */ public interface HttpClientForm { /** - * Add an HTTP Form attribute + * Add an HTTP Form attribute. * * @param name Attribute name * @param value Attribute value @@ -39,7 +39,7 @@ public interface HttpClientForm { HttpClientForm attr(String name, String value); /** - * Set the Form {@link Charset} + * Set the Form {@link Charset}. * * @param charset form charset * @@ -58,7 +58,7 @@ public interface HttpClientForm { HttpClientForm cleanOnTerminate(boolean clean); /** - * Set Form encoding + * Set Form encoding. * * @param mode the encoding mode for this form encoding * @return this builder @@ -66,7 +66,7 @@ public interface HttpClientForm { HttpClientForm encoding(HttpPostRequestEncoder.EncoderMode mode); /** - * Set Upload factories (allows memory threshold configuration) + * Set Upload factories (allows memory threshold configuration). * * @param factory the new {@link HttpDataFactory} to use * @return this builder @@ -74,7 +74,7 @@ public interface HttpClientForm { HttpClientForm factory(HttpDataFactory factory); /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param file File reference @@ -84,7 +84,7 @@ public interface HttpClientForm { HttpClientForm file(String name, File file); /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param stream File content as InputStream @@ -94,7 +94,7 @@ public interface HttpClientForm { HttpClientForm file(String name, InputStream stream); /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param file File reference @@ -107,7 +107,7 @@ default HttpClientForm file(String name, File file, @Nullable String contentType } /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param filename File name to override origin name @@ -119,7 +119,7 @@ default HttpClientForm file(String name, File file, @Nullable String contentType HttpClientForm file(String name, String filename, File file, @Nullable String contentType); /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param stream File content as InputStream @@ -132,7 +132,7 @@ default HttpClientForm file(String name, InputStream stream, @Nullable String co } /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param filename File name to override origin name @@ -144,7 +144,7 @@ default HttpClientForm file(String name, InputStream stream, @Nullable String co HttpClientForm file(String name, String filename, InputStream stream, @Nullable String contentType); /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param files File references @@ -155,7 +155,7 @@ default HttpClientForm file(String name, InputStream stream, @Nullable String co HttpClientForm files(String name, File[] files, String[] contentTypes); /** - * Add an HTTP File Upload attribute + * Add an HTTP File Upload attribute. * * @param name File name * @param files File references @@ -167,7 +167,7 @@ default HttpClientForm file(String name, InputStream stream, @Nullable String co HttpClientForm files(String name, File[] files, String[] contentTypes, boolean[] textFiles); /** - * Define if this request will be encoded as Multipart + * Define if this request will be encoded as Multipart. * * @param multipart should this form be encoded as Multipart * diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientInfos.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientInfos.java index 37dacee695..835f35e4f8 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientInfos.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientInfos.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -50,14 +50,14 @@ public interface HttpClientInfos extends HttpInfos { ContextView currentContextView(); /** - * Return the previous redirections or empty array + * Return the previous redirections or empty array. * * @return the previous redirections or empty array */ String[] redirectedFrom(); /** - * Return outbound headers to be sent + * Return outbound headers to be sent. * * @return outbound headers to be sent */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientMetricsRecorder.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientMetricsRecorder.java index 633219bd27..c1d59e3ef0 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientMetricsRecorder.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,14 +21,14 @@ import java.time.Duration; /** - * Interface for collecting metrics on HTTP client level + * Interface for collecting metrics on HTTP client level. * * @author Violeta Georgieva */ public interface HttpClientMetricsRecorder extends HttpMetricsRecorder { /** - * Records the time that is spent in consuming incoming data + * Records the time that is spent in consuming incoming data. * * @param remoteAddress The remote peer * @param uri the requested URI @@ -39,7 +39,7 @@ public interface HttpClientMetricsRecorder extends HttpMetricsRecorder { void recordDataReceivedTime(SocketAddress remoteAddress, String uri, String method, String status, Duration time); /** - * Records the time that is spent in sending outgoing data + * Records the time that is spent in sending outgoing data. * * @param remoteAddress The remote peer * @param uri the requested URI @@ -49,7 +49,7 @@ public interface HttpClientMetricsRecorder extends HttpMetricsRecorder { void recordDataSentTime(SocketAddress remoteAddress, String uri, String method, Duration time); /** - * Records the total time for the request/response + * Records the total time for the request/response. * * @param remoteAddress The remote peer * @param uri the requested URI diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientRequest.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientRequest.java index 3d0164969e..2a33847504 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientRequest.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientRequest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,7 +30,7 @@ public interface HttpClientRequest extends HttpClientInfos { /** - * Add an outbound cookie + * Add an outbound cookie. * * @return this outbound */ @@ -67,7 +67,7 @@ public interface HttpClientRequest extends HttpClientInfos { HttpClientRequest headers(HttpHeaders headers); /** - * Return true if redirected will be followed + * Return true if redirected will be followed. * * @return true if redirected will be followed */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientState.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientState.java index b71e61cb46..d88b11cf4c 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientState.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientState.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,13 +18,13 @@ import reactor.netty.ConnectionObserver; /** - * Specific Http Client state observable by {@link HttpClient#observe(ConnectionObserver)} + * Specific Http Client state observable by {@link HttpClient#observe(ConnectionObserver)}. * * @author Stephane Maldini */ public enum HttpClientState implements ConnectionObserver.State { /** - * The request has been prepared and ready for I/O handler to be invoked + * The request has been prepared and ready for I/O handler to be invoked. */ REQUEST_PREPARED() { @Override @@ -33,7 +33,7 @@ public String toString() { } }, /** - * The request has been sent + * The request has been sent. */ REQUEST_SENT() { @Override @@ -43,7 +43,7 @@ public String toString() { }, /** * The request has been sent but the response has not been fully received and the - * connection has been prematurely closed + * connection has been prematurely closed. */ RESPONSE_INCOMPLETE() { @Override @@ -52,7 +52,7 @@ public String toString() { } }, /** - * The response status and headers have been received + * The response status and headers have been received. */ RESPONSE_RECEIVED() { @Override @@ -61,7 +61,7 @@ public String toString() { } }, /** - * The response fully received + * The response fully received. */ RESPONSE_COMPLETED() { @Override @@ -71,7 +71,7 @@ public String toString() { }, /** * Propagated when a stream is bound to a channelOperation and ready for - * user interaction + * user interaction. */ STREAM_CONFIGURED() { @Override diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientTcpConfig.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientTcpConfig.java index 898073ef02..c1e55c0a20 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientTcpConfig.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpClientTcpConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -43,7 +43,7 @@ import java.util.function.Supplier; /** - * This class provides a migration for the {@link HttpClient#tcpConfiguration(Function)} in 0.9.x + * This class provides a migration for the {@link HttpClient#tcpConfiguration(Function)} in 0.9.x. * * @author Violeta Georgieva * @deprecated Use {@link HttpClient} methods for TCP level configurations. This class will be removed in version 1.1.0. diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpResponseDecoderSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpResponseDecoderSpec.java index 07adfcf17f..664a1f35b6 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpResponseDecoderSpec.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/HttpResponseDecoderSpec.java @@ -63,7 +63,7 @@ public HttpResponseDecoderSpec get() { /** * Configure whether to throw an exception on a channel inactive - * in case there was a missing response + * in case there was a missing response. * * @param failOnMissingResponse true - throw an exception on a channel inactive * in case there was a missing response, otherwise false diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/PrematureCloseException.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/PrematureCloseException.java index 1881a10bbf..09096d9fbc 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/PrematureCloseException.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/PrematureCloseException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,7 +24,7 @@ * An error for signalling that the connection was closed prematurely * {@link ChannelInboundHandler#channelInactive(io.netty.channel.ChannelHandlerContext)}, * {@link ChannelOperations#onInboundClose()}, - * {@link ChannelOperations#onInboundError()} + * {@link ChannelOperations#onInboundError()}. * * @author Violeta Georgieva */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/RedirectClientException.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/RedirectClientException.java index 6a62064f14..6e3615fc41 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/RedirectClientException.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/RedirectClientException.java @@ -22,7 +22,7 @@ import io.netty.handler.codec.http.HttpResponseStatus; /** - * An error for signalling that an error occurred during a communication over HTTP version + * An error for signalling that an error occurred during a communication over HTTP version. * */ final class RedirectClientException extends RuntimeException { diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/WebsocketClientSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/WebsocketClientSpec.java index e34109a778..a417aa6daf 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/WebsocketClientSpec.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/WebsocketClientSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,7 +21,7 @@ import java.util.Objects; /** - * Websocket client configuration + * Websocket client configuration. * * @author Violeta Georgieva * @since 0.9.7 @@ -29,7 +29,7 @@ public interface WebsocketClientSpec extends WebsocketSpec { /** - * Returns the configured WebSocket version + * Returns the configured WebSocket version. * * @return returns the configured WebSocket version * @since 1.0.3 @@ -37,7 +37,7 @@ public interface WebsocketClientSpec extends WebsocketSpec { WebSocketVersion version(); /** - * Create builder with default properties:
    + * Create builder with default properties.
    * version = {@link io.netty.handler.codec.http.websocketx.WebSocketVersion#V13} *
    * protocols = null @@ -81,7 +81,7 @@ public final Builder version(WebSocketVersion version) { } /** - * Builds new {@link WebsocketClientSpec} + * Builds new {@link WebsocketClientSpec}. * * @return builds new {@link WebsocketClientSpec} */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/client/package-info.java b/reactor-netty-http/src/main/java/reactor/netty/http/client/package-info.java index ffb64665a6..3140a42433 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/client/package-info.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/client/package-info.java @@ -15,7 +15,7 @@ */ /** - * Http Client abstractions and factory + * Http Client abstractions and factory. */ @NonNullApi package reactor.netty.http.client; diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/logging/package-info.java b/reactor-netty-http/src/main/java/reactor/netty/http/logging/package-info.java index 53915496b3..1df14c406a 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/logging/package-info.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/logging/package-info.java @@ -15,7 +15,7 @@ */ /** - * Http message log factory + * Http message log factory. */ @NonNullApi package reactor.netty.http.logging; diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/ConnectionInfo.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/ConnectionInfo.java index bfd8092e23..04e3134f98 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/ConnectionInfo.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/ConnectionInfo.java @@ -192,7 +192,7 @@ public int getHostPort() { } /** - * Returns the default host port number based on scheme + * Returns the default host port number based on scheme. * @param scheme a connection scheme like "http", "https", or "wss" * @return the default host port number based on scheme * @since 1.0.32 diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/ContextAwareHttpServerMetricsRecorder.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/ContextAwareHttpServerMetricsRecorder.java index 20af1b354c..540d245f62 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/ContextAwareHttpServerMetricsRecorder.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/ContextAwareHttpServerMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,7 +22,7 @@ import java.time.Duration; /** - * {@link ContextView} aware class for collecting metrics on HTTP server level + * {@link ContextView} aware class for collecting metrics on HTTP server level. * * @author Violeta Georgieva * @since 1.0.8 @@ -30,7 +30,7 @@ public abstract class ContextAwareHttpServerMetricsRecorder extends ContextAwareHttpMetricsRecorder implements HttpServerMetricsRecorder { /** - * Records the time that is spent in consuming incoming data + * Records the time that is spent in consuming incoming data. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param uri The requested URI @@ -40,7 +40,7 @@ public abstract class ContextAwareHttpServerMetricsRecorder extends ContextAware public abstract void recordDataReceivedTime(ContextView contextView, String uri, String method, Duration time); /** - * Records the time that is spent in sending outgoing data + * Records the time that is spent in sending outgoing data. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param uri The requested URI @@ -51,7 +51,7 @@ public abstract class ContextAwareHttpServerMetricsRecorder extends ContextAware public abstract void recordDataSentTime(ContextView contextView, String uri, String method, String status, Duration time); /** - * Records the total time for the request/response + * Records the total time for the request/response. * * @param contextView The current {@link ContextView} associated with the Mono/Flux * @param uri The requested URI diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/DefaultHttpServerRoutes.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/DefaultHttpServerRoutes.java index 4415e9b525..202d6effa4 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/DefaultHttpServerRoutes.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/DefaultHttpServerRoutes.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,6 +51,7 @@ final class DefaultHttpServerRoutes implements HttpServerRoutes { public HttpServerRoutes directory(String uri, Path directory, @Nullable Function interceptor) { Objects.requireNonNull(directory, "directory"); + Path absPath = directory.toAbsolutePath().normalize(); return route(HttpPredicate.prefix(uri), (req, resp) -> { String prefix = URI.create(req.uri()) @@ -61,8 +62,8 @@ public HttpServerRoutes directory(String uri, Path directory, prefix = prefix.substring(1); } - Path p = directory.resolve(prefix); - if (Files.isReadable(p)) { + Path p = absPath.resolve(prefix).toAbsolutePath().normalize(); + if (Files.isReadable(p) && p.startsWith(absPath)) { if (interceptor != null) { return interceptor.apply(resp) diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpPredicate.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpPredicate.java index 58b7deba15..3fdda6bbe5 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpPredicate.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpPredicate.java @@ -32,7 +32,7 @@ import static java.util.Objects.requireNonNull; /** - * A Predicate to match against ServerRequest + * A Predicate to match against ServerRequest. * * @author Stephane Maldini */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpRouteHandlerMetadata.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpRouteHandlerMetadata.java index 98c758a0d5..3590503179 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpRouteHandlerMetadata.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpRouteHandlerMetadata.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,7 +30,7 @@ public interface HttpRouteHandlerMetadata { /** - * Get the http path this handler can handle + * Get the http path this handler can handle. * * @return the http path */ @@ -38,7 +38,7 @@ public interface HttpRouteHandlerMetadata { String getPath(); /** - * Get the http method this handler can handle + * Get the http method this handler can handle. * * @return the http method {@link HttpMethod} * @since 1.0.11 diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServer.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServer.java index 2aa730f237..84811121b6 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServer.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -78,7 +78,7 @@ public abstract class HttpServer extends ServerTransport { /** - * Prepare an {@link HttpServer} + * Prepare an {@link HttpServer}. * * @return a new {@link HttpServer} */ @@ -315,7 +315,7 @@ public final HttpServer compress(boolean compressionEnabled) { /** * Enable GZip response compression if the client request presents accept encoding - * headers AND the response reaches a minimum threshold + * headers AND the response reaches a minimum threshold. * * @param minResponseSize compression is performed once response size exceeds the given * value in bytes @@ -334,7 +334,7 @@ public final HttpServer compress(int minResponseSize) { /** * Configure the * {@link ServerCookieEncoder}; {@link ServerCookieDecoder} will be - * chosen based on the encoder + * chosen based on the encoder. * * @param encoder the preferred ServerCookieEncoder * @@ -352,7 +352,7 @@ public final HttpServer cookieCodec(ServerCookieEncoder encoder) { /** * Configure the - * {@link ServerCookieEncoder} and {@link ServerCookieDecoder} + * {@link ServerCookieEncoder} and {@link ServerCookieDecoder}. * * @param encoder the preferred ServerCookieEncoder * @param decoder the preferred ServerCookieDecoder @@ -410,7 +410,7 @@ else if (configuration().forwardedHeaderHandler != null) { } /** - * Attach an I/O handler to react on a connected client + * Attach an I/O handler to react on a connected client. * * @param handler an I/O handler that can dispose underlying connection when {@link * Publisher} terminates. Only the first registered handler will subscribe to the @@ -431,7 +431,7 @@ public final HttpServer host(String host) { } /** - * Apply HTTP/2 configuration + * Apply HTTP/2 configuration. * * @param http2Settings configures {@link Http2SettingsSpec} before requesting * @return a new {@link HttpServer} @@ -664,7 +664,7 @@ else if (configuration().metricsRecorder() != null) { } /** - * Removes any previously applied SSL configuration customization + * Removes any previously applied SSL configuration customization. * * @return a new {@link HttpServer} */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerConfig.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerConfig.java index e231c4bf2b..9fb8e8bb14 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerConfig.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerConfig.java @@ -141,7 +141,7 @@ public HttpServerFormDecoderProvider formDecoderProvider() { } /** - * Return the HTTP/2 configuration + * Return the HTTP/2 configuration. * * @return the HTTP/2 configuration */ @@ -171,7 +171,7 @@ public boolean isForwarded() { } /** - * Returns true if that {@link HttpServer} secured via SSL transport + * Returns true if that {@link HttpServer} secured via SSL transport. * * @return true if that {@link HttpServer} secured via SSL transport */ @@ -245,7 +245,7 @@ public SslProvider sslProvider() { /** * Returns the configured function that receives the actual uri and returns the uri tag value - * that will be used for the metrics with {@link reactor.netty.Metrics#URI} tag + * that will be used for the metrics with {@link reactor.netty.Metrics#URI} tag. * * @return the configured function that receives the actual uri and returns the uri tag value * that will be used for the metrics with {@link reactor.netty.Metrics#URI} tag @@ -710,7 +710,7 @@ static void configureHttp11Pipeline(ChannelPipeline p, /** * Default value whether the SSL debugging on the server side will be enabled/disabled, - * fallback to SSL debugging disabled + * fallback to SSL debugging disabled. */ static final boolean SSL_DEBUG = Boolean.parseBoolean(System.getProperty(ReactorNetty.SSL_SERVER_DEBUG, "false")); @@ -769,7 +769,7 @@ static final class H2CleartextCodec extends ChannelHandlerAdapter { final Long maxStreams; /** - * Used when full H2 preface is received + * Used when full H2 preface is received. */ H2CleartextCodec(Http11OrH2CleartextCodec upgrader, @Nullable Long maxStreams) { this(upgrader, true, true, maxStreams); @@ -961,7 +961,7 @@ static final class Http11OrH2CleartextCodec extends ChannelInitializer } /** - * Inline channel initializer + * Inline channel initializer. */ @Override protected void initChannel(Channel ch) { diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerMetricsRecorder.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerMetricsRecorder.java index 98e83eb42d..3605f19c3b 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerMetricsRecorder.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerMetricsRecorder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,14 +21,14 @@ import java.time.Duration; /** - * Interface for collecting metrics on HTTP server level + * Interface for collecting metrics on HTTP server level. * * @author Violeta Georgieva */ public interface HttpServerMetricsRecorder extends HttpMetricsRecorder { /** - * Records the time that is spent in consuming incoming data + * Records the time that is spent in consuming incoming data. * * @param uri the requested URI * @param method the HTTP method @@ -37,7 +37,7 @@ public interface HttpServerMetricsRecorder extends HttpMetricsRecorder { void recordDataReceivedTime(String uri, String method, Duration time); /** - * Records the time that is spent in sending outgoing data + * Records the time that is spent in sending outgoing data. * * @param uri the requested URI * @param method the HTTP method @@ -47,7 +47,7 @@ public interface HttpServerMetricsRecorder extends HttpMetricsRecorder { void recordDataSentTime(String uri, String method, String status, Duration time); /** - * Records the total time for the request/response + * Records the total time for the request/response. * * @param uri the requested URI * @param method the HTTP method @@ -57,7 +57,7 @@ public interface HttpServerMetricsRecorder extends HttpMetricsRecorder { void recordResponseTime(String uri, String method, String status, Duration time); /** - * Record a new active in-use http connection + * Record a new active in-use http connection. * * @param localAddress the local server address * @since 1.0.15 @@ -65,7 +65,7 @@ public interface HttpServerMetricsRecorder extends HttpMetricsRecorder { default void recordServerConnectionActive(SocketAddress localAddress) { } /** - * Record an inactive http connection + * Record an inactive http connection. * * @param localAddress the local server address * @since 1.0.15 @@ -73,7 +73,7 @@ default void recordServerConnectionActive(SocketAddress localAddress) { } default void recordServerConnectionInactive(SocketAddress localAddress) { } /** - * Record an opened HTTP/2 stream + * Record an opened HTTP/2 stream. * * @param localAddress the local server address * @since 1.0.21 @@ -81,7 +81,7 @@ default void recordServerConnectionInactive(SocketAddress localAddress) { } default void recordStreamOpened(SocketAddress localAddress) { } /** - * Record a closed HTTP/2 stream + * Record a closed HTTP/2 stream. * * @param localAddress the local server address * @since 1.0.21 diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerOperations.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerOperations.java index 3eb38d1c3c..11552cf4bc 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerOperations.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerOperations.java @@ -869,7 +869,7 @@ else if (cause instanceof TooLongHttpHeaderException) { /** * There is no need of invoking {@link #discard()}, the inbound will - * be canceled on channel inactive event if there is no subscriber available + * be canceled on channel inactive event if there is no subscriber available. * * @param err the {@link Throwable} cause */ @@ -1103,7 +1103,7 @@ static Set filterHeaderNames(String declaredHeaderNames) { static final class TrailerNameValidator implements DefaultHeaders.NameValidator { /** - * Contains the headers names specified with {@link HttpHeaderNames#TRAILER} + * Contains the headers names specified with {@link HttpHeaderNames#TRAILER}. */ final Set declaredHeaderNames; diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRequest.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRequest.java index 61e2026c4d..77b5e9d61c 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRequest.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRequest.java @@ -70,7 +70,7 @@ public interface HttpServerRequest extends NettyInbound, HttpServerInfos { HttpServerRequest paramsResolver(Function> paramsResolver); /** - * Returns a {@link Flux} of {@link HttpContent} containing received chunks + * Returns a {@link Flux} of {@link HttpContent} containing received chunks. * * @return a {@link Flux} of {@link HttpContent} containing received chunks */ @@ -137,7 +137,7 @@ default Flux receiveContent() { InetSocketAddress remoteAddress(); /** - * Returns inbound {@link HttpHeaders} + * Returns inbound {@link HttpHeaders}. * * @return inbound {@link HttpHeaders} */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerResponse.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerResponse.java index d911a3673f..28d8971f1b 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerResponse.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerResponse.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -40,7 +40,7 @@ public interface HttpServerResponse extends NettyOutbound, HttpServerInfos { /** - * Adds an outbound cookie + * Adds an outbound cookie. * * @return this {@link HttpServerResponse} */ @@ -57,7 +57,7 @@ public interface HttpServerResponse extends NettyOutbound, HttpServerInfos { HttpServerResponse addHeader(CharSequence name, CharSequence value); /** - * Sets Transfer-Encoding header + * Sets Transfer-Encoding header. * * @param chunked true if Transfer-Encoding: chunked * @@ -69,7 +69,7 @@ public interface HttpServerResponse extends NettyOutbound, HttpServerInfos { HttpServerResponse withConnection(Consumer withConnection); /** - * Enables/Disables compression handling (gzip/deflate) for the underlying response + * Enables/Disables compression handling (gzip/deflate) for the underlying response. * * @param compress should handle compression * @@ -78,7 +78,7 @@ public interface HttpServerResponse extends NettyOutbound, HttpServerInfos { HttpServerResponse compression(boolean compress); /** - * Returns true if headers and status have been sent to the client + * Returns true if headers and status have been sent to the client. * * @return true if headers and status have been sent to the client */ @@ -104,14 +104,14 @@ public interface HttpServerResponse extends NettyOutbound, HttpServerInfos { HttpServerResponse headers(HttpHeaders headers); /** - * Sets the request {@code keepAlive} if true otherwise remove the existing connection keep alive header + * Sets the request {@code keepAlive} if true otherwise remove the existing connection keep alive header. * * @return this {@link HttpServerResponse} */ HttpServerResponse keepAlive(boolean keepAlive); /** - * Returns the outbound HTTP headers, sent back to the clients + * Returns the outbound HTTP headers, sent back to the clients. * * @return headers sent back to the clients */ @@ -126,7 +126,7 @@ public interface HttpServerResponse extends NettyOutbound, HttpServerInfos { Mono send(); /** - * Returns a {@link NettyOutbound} successful on committed response + * Returns a {@link NettyOutbound} successful on committed response. * * @return a {@link NettyOutbound} successful on committed response */ @@ -176,21 +176,21 @@ Mono sendWebsocket( WebsocketServerSpec websocketServerSpec); /** - * Adds "text/event-stream" content-type for Server-Sent Events + * Adds "text/event-stream" content-type for Server-Sent Events. * * @return this {@link HttpServerResponse} */ HttpServerResponse sse(); /** - * Returns the assigned HTTP status + * Returns the assigned HTTP status. * * @return the assigned HTTP status */ HttpResponseStatus status(); /** - * Sets an HTTP status to be sent along with the headers + * Sets an HTTP status to be sent along with the headers. * * @param status an HTTP status to be sent along with the headers * @return this {@link HttpServerResponse} @@ -198,7 +198,7 @@ Mono sendWebsocket( HttpServerResponse status(HttpResponseStatus status); /** - * Sets an HTTP status to be sent along with the headers + * Sets an HTTP status to be sent along with the headers. * * @param status an HTTP status to be sent along with the headers * @return this {@link HttpServerResponse} diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRoutes.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRoutes.java index b4b3a65eb0..af18d70211 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRoutes.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerRoutes.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -44,7 +44,7 @@ public interface HttpServerRoutes extends BiFunction> { /** - * Returns a new default routing registry {@link HttpServerRoutes} + * Returns a new default routing registry {@link HttpServerRoutes}. * * @return a new default routing registry {@link HttpServerRoutes} */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerState.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerState.java index 8126acaf39..d2c5c3a59f 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerState.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerState.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,14 +18,14 @@ import reactor.netty.ConnectionObserver; /** - * Specific Http Server state observable by {@link HttpServer#observe(ConnectionObserver)} + * Specific Http Server state observable by {@link HttpServer#observe(ConnectionObserver)}. * * @author Violeta Georgieva */ public enum HttpServerState implements ConnectionObserver.State { /** - * The request was received + * The request was received. */ REQUEST_RECEIVED() { @Override @@ -34,7 +34,7 @@ public String toString() { } }, /** - * The request was received but with decoding failures + * The request was received but with decoding failures. */ REQUEST_DECODING_FAILED { @Override diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerTcpConfig.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerTcpConfig.java index 67f409068e..362d155161 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerTcpConfig.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerTcpConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2018-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -42,7 +42,7 @@ import java.util.function.Supplier; /** - * This class provides a migration for the {@link HttpServer#tcpConfiguration(Function)} in 0.9.x + * This class provides a migration for the {@link HttpServer#tcpConfiguration(Function)} in 0.9.x. * * @author Violeta Georgieva * @deprecated Use {@link HttpServer} methods for TCP level configurations. This class will be removed in version 1.1.0. diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/ProxyProtocolSupportType.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/ProxyProtocolSupportType.java index 222df2ee89..47bab92387 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/ProxyProtocolSupportType.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/ProxyProtocolSupportType.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2019-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,7 +35,7 @@ public enum ProxyProtocolSupportType { ON, /** - * Disable the proxy protocol support + * Disable the proxy protocol support. */ OFF } diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerOperations.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerOperations.java index d4419b8af8..f79bd7e5ed 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerOperations.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerOperations.java @@ -50,7 +50,7 @@ import static reactor.netty.ReactorNetty.format; /** - * Conversion between Netty types and Reactor types ({@link HttpOperations} + * Conversion between Netty types and Reactor types ({@link HttpOperations}. * * @author Stephane Maldini * @author Simon Baslé diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerSpec.java index 6feb9d0aca..3658c0bbe8 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerSpec.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/WebsocketServerSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,7 +18,7 @@ import reactor.netty.http.websocket.WebsocketSpec; /** - * Websocket server configuration + * Websocket server configuration. * * @author Violeta Georgieva * @since 0.9.5 @@ -26,7 +26,7 @@ public interface WebsocketServerSpec extends WebsocketSpec { /** - * Create builder with default properties:
    + * Create builder with default properties.
    * protocols = null *
    * maxFramePayloadLength = 65536 @@ -47,7 +47,7 @@ private Builder() { } /** - * Builds new {@link WebsocketServerSpec} + * Builds new {@link WebsocketServerSpec}. * * @return builds new {@link WebsocketServerSpec} */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogArgProvider.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogArgProvider.java index 5fe3bae675..93db057e3e 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogArgProvider.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogArgProvider.java @@ -44,7 +44,7 @@ public interface AccessLogArgProvider { String zonedDateTime(); /** - * Returns the date-time of the moment when the request was received + * Returns the date-time of the moment when the request was received. * * @return zoned date-time * @since 1.0.6 diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogHandlerFactory.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogHandlerFactory.java index 6a53871611..209412722a 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogHandlerFactory.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/AccessLogHandlerFactory.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -28,11 +28,11 @@ public enum AccessLogHandlerFactory { /** - * HTTP/1.1 + * HTTP/1.1. */ H1, /** - * HTTP/2.0 + * HTTP/2.0. */ H2; diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/package-info.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/package-info.java index 59b8210c5f..619dee0d75 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/package-info.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/logging/package-info.java @@ -15,7 +15,7 @@ */ /** - * Http access log + * Http access log. */ @NonNullApi package reactor.netty.http.server.logging; diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/package-info.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/package-info.java index 6865266691..f254e3cb0a 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/server/package-info.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/server/package-info.java @@ -15,7 +15,7 @@ */ /** - * Http Server abstractions and factory + * Http Server abstractions and factory. */ @NonNullApi package reactor.netty.http.server; diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketInbound.java b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketInbound.java index 107c7f4bf9..49e3e3374e 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketInbound.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketInbound.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,7 +26,7 @@ import reactor.util.annotation.Nullable; /** - * A websocket framed inbound + * A websocket framed inbound. * * @author Stephane Maldini * @author Simon Baslé @@ -44,7 +44,7 @@ public interface WebsocketInbound extends NettyInbound { String selectedSubprotocol(); /** - * Returns the websocket remote headers sent during handshake + * Returns the websocket remote headers sent during handshake. * * @return the websocket remote headers sent during handshake */ diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketOutbound.java b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketOutbound.java index 68185060e4..fcd2febeed 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketOutbound.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketOutbound.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2011-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -29,7 +29,7 @@ import reactor.util.annotation.Nullable; /** - * A websocket framed outbound + * A websocket framed outbound. * * @author Stephane Maldini * @author Simon Baslé @@ -50,7 +50,7 @@ public interface WebsocketOutbound extends NettyOutbound { NettyOutbound send(Publisher dataStream); /** - * Prepare to send a close frame on subscribe then close the underlying channel + * Prepare to send a close frame on subscribe then close the underlying channel. * * @return a {@link Mono} fulfilled when the send succeeded or failed, immediately * completed if already closed @@ -58,7 +58,7 @@ public interface WebsocketOutbound extends NettyOutbound { Mono sendClose(); /** - * Prepare to send a close frame on subscribe then close the underlying channel + * Prepare to send a close frame on subscribe then close the underlying channel. * * @param rsv * reserved bits used for protocol extensions @@ -69,7 +69,7 @@ public interface WebsocketOutbound extends NettyOutbound { Mono sendClose(int rsv); /** - * Prepare to send a close frame on subscribe then close the underlying channel + * Prepare to send a close frame on subscribe then close the underlying channel. * * @param statusCode * Integer status code as per     RFC 6455#section-7.4. For @@ -87,7 +87,7 @@ public interface WebsocketOutbound extends NettyOutbound { Mono sendClose(int statusCode, @Nullable String reasonText); /** - * Prepare to send a close frame on subscribe then close the underlying channel + * Prepare to send a close frame on subscribe then close the underlying channel. * * @param rsv * reserved bits used for protocol extensions diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java index 40f0ee507c..307f65a6c8 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpec.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,7 +21,7 @@ import java.util.function.Supplier; /** - * Wrapper for websocket configuration + * Wrapper for websocket configuration. * * @author Dmitrii Borin * @author Violeta Georgieva diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpecImpl.java b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpecImpl.java index b9f1a3f59e..fc28948481 100644 --- a/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpecImpl.java +++ b/reactor-netty-http/src/main/java/reactor/netty/http/websocket/WebsocketSpecImpl.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,7 +18,7 @@ import reactor.util.annotation.Nullable; /** - * Configurer implementation for {@link WebsocketSpec} + * Configurer implementation for {@link WebsocketSpec}. * * @author Dmitrii Borin * @author Violeta Georgieva diff --git a/reactor-netty-http/src/test/java/reactor/netty/ByteBufFluxTest.java b/reactor-netty-http/src/test/java/reactor/netty/ByteBufFluxTest.java index a7895af01a..ace1929e41 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/ByteBufFluxTest.java +++ b/reactor-netty-http/src/test/java/reactor/netty/ByteBufFluxTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2017-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,7 +33,7 @@ import static org.assertj.core.api.Assertions.assertThat; /** - * Unit tests for {@link ByteBufFlux} + * Unit tests for {@link ByteBufFlux}. * * @author Silvano Riz */ diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/Http2Tests.java b/reactor-netty-http/src/test/java/reactor/netty/http/Http2Tests.java index 20016b42cc..7d864a199d 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/Http2Tests.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/Http2Tests.java @@ -531,7 +531,7 @@ private static void doTestIssue1394_ProtocolSchemeNotCompatible(HttpProtocol pro .verify(Duration.ofSeconds(30)); } - /** + /* * https://github.com/reactor/reactor-netty/issues/1813 */ @Test @@ -539,7 +539,7 @@ void testTooManyPermitsReturned_DefaultPool() { testTooManyPermitsReturned(createClient(() -> disposableServer.address())); } - /** + /* * https://github.com/reactor/reactor-netty/issues/1813 */ @Test diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/HttpMetricsHandlerTests.java b/reactor-netty-http/src/test/java/reactor/netty/http/HttpMetricsHandlerTests.java index 5bf898a395..7a30e8e1bd 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/HttpMetricsHandlerTests.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/HttpMetricsHandlerTests.java @@ -493,7 +493,7 @@ else if (clientProtocols.length == 2 && serverCtx != null, numWrites, bytesWrite); } - /** + /* * https://github.com/reactor/reactor-netty/issues/1559 */ @ParameterizedTest diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/HttpProtocolsTests.java b/reactor-netty-http/src/test/java/reactor/netty/http/HttpProtocolsTests.java index d2580931ad..6a7c34fe44 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/HttpProtocolsTests.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/HttpProtocolsTests.java @@ -93,7 +93,7 @@ /** * Test a combination of {@link HttpServer} + {@link HttpProtocol} - * with a combination of {@link HttpClient} + {@link HttpProtocol} + * with a combination of {@link HttpClient} + {@link HttpProtocol}. * * @author Violeta Georgieva * @since 1.0.0 diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/client/ConnectionPoolTests.java b/reactor-netty-http/src/test/java/reactor/netty/http/client/ConnectionPoolTests.java index ed0b63e5d4..b1b701439f 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/client/ConnectionPoolTests.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/client/ConnectionPoolTests.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2022 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -59,7 +59,7 @@ import static org.assertj.core.api.Assertions.assertThat; /** - * This class tests https://github.com/reactor/reactor-netty/issues/1472 + * This class tests https://github.com/reactor/reactor-netty/issues/1472. */ class ConnectionPoolTests extends BaseHttpTest { diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/client/HttpRedirectTest.java b/reactor-netty-http/src/test/java/reactor/netty/http/client/HttpRedirectTest.java index 971856702f..2bc7fcf6a2 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/client/HttpRedirectTest.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/client/HttpRedirectTest.java @@ -236,7 +236,7 @@ void testIssue253() { .verify(Duration.ofSeconds(30)); } - /** + /* * https://github.com/reactor/reactor-netty/issues/278 * https://github.com/reactor/reactor-netty/issues/1533 */ diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/server/ConnectionInfoTests.java b/reactor-netty-http/src/test/java/reactor/netty/http/server/ConnectionInfoTests.java index b7d688ee5c..17d42f2da2 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/server/ConnectionInfoTests.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/server/ConnectionInfoTests.java @@ -63,7 +63,7 @@ import static reactor.netty.http.server.ConnectionInfo.getDefaultHostPort; /** - * Tests for {@link ConnectionInfo} + * Tests for {@link ConnectionInfo}. * * @author Brian Clozel */ diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/server/DefaultHttpServerRoutesTest.java b/reactor-netty-http/src/test/java/reactor/netty/http/server/DefaultHttpServerRoutesTest.java index d4c1432498..d32f92b287 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/server/DefaultHttpServerRoutesTest.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/server/DefaultHttpServerRoutesTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,7 +32,7 @@ import static org.assertj.core.api.Assertions.assertThat; /** - * Tests for {@link DefaultHttpServerRoutes} + * Tests for {@link DefaultHttpServerRoutes}. * * @author Sascha Dais * @since 1.0.8 diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/server/Http2ConnectionInfoTests.java b/reactor-netty-http/src/test/java/reactor/netty/http/server/Http2ConnectionInfoTests.java index 2da90d0f41..97f96f8e31 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/server/Http2ConnectionInfoTests.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/server/Http2ConnectionInfoTests.java @@ -24,7 +24,7 @@ import javax.net.ssl.SSLException; /** - * Tests for HTTP/2.0 and {@link ConnectionInfo} + * Tests for HTTP/2.0 and {@link ConnectionInfo}. * * @author Violeta Georgieva * @since 1.0.0 diff --git a/reactor-netty-http/src/test/java/reactor/netty/http/server/HttpServerTests.java b/reactor-netty-http/src/test/java/reactor/netty/http/server/HttpServerTests.java index b670d06a8a..92055f8944 100644 --- a/reactor-netty-http/src/test/java/reactor/netty/http/server/HttpServerTests.java +++ b/reactor-netty-http/src/test/java/reactor/netty/http/server/HttpServerTests.java @@ -3067,7 +3067,7 @@ private void doTestIsFormUrlencoded(String headerValue, boolean expectation) { } /** - * This test verifies if server h2 streams are closed properly when the server does not consume client post data chunks + * This test verifies if server h2 streams are closed properly when the server does not consume client post data chunks. */ @ParameterizedTest @MethodSource("h2cCompatibleCombinations") @@ -3082,7 +3082,7 @@ void testIssue1978H2CWithDelay(HttpProtocol[] serverProtocols, HttpProtocol[] cl } /** - * This test verifies if server h2 streams are closed properly when the server does not consume client post data chunks + * This test verifies if server h2 streams are closed properly when the server does not consume client post data chunks. */ @ParameterizedTest @MethodSource("h2CompatibleCombinations") diff --git a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClient.java b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClient.java index fa234b34f6..8b66864312 100644 --- a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClient.java +++ b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClient.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -49,7 +49,7 @@ public abstract class QuicClient extends QuicTransport { /** - * Prepare a {@link QuicClient} + * Prepare a {@link QuicClient}. * * @return a {@link QuicClient} */ diff --git a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClientConfig.java b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClientConfig.java index 97f49ef213..b8948a84fa 100644 --- a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClientConfig.java +++ b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicClientConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -52,7 +52,7 @@ public final class QuicClientConfig extends QuicTransportConfig doOnConnect() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -99,7 +99,7 @@ public Consumer doOnConnected() { } /** - * Return the configured callback or null + * Return the configured callback or null. * * @return the configured callback or null */ @@ -109,7 +109,7 @@ public Consumer doOnDisconnected() { } /** - * Return the remote configured {@link SocketAddress} + * Return the remote configured {@link SocketAddress}. * * @return the remote configured {@link SocketAddress} */ diff --git a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicResources.java b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicResources.java index 6e493dcd43..c79bcfa1a2 100644 --- a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicResources.java +++ b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicResources.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,14 +30,14 @@ import static java.util.Objects.requireNonNull; /** - * Hold the default QUIC resources + * Hold the default QUIC resources. * * @author Violeta Georgieva */ public class QuicResources implements LoopResources { /** - * Return the global QUIC resources for loops + * Return the global QUIC resources for loops. * * @return the global QUIC resources for loops */ @@ -46,7 +46,7 @@ public static QuicResources get() { } /** - * Reset QUIC resources to default and return its instance + * Reset QUIC resources to default and return its instance. * * @return the global QUIC resources */ @@ -199,7 +199,7 @@ public EventLoopGroup onServerSelect(boolean useNative) { } /** - * Dispose underlying resources + * Dispose underlying resources. */ protected void _dispose() { defaultLoops.dispose(); @@ -277,7 +277,7 @@ static T create(@Nullable T previous, /** * Default worker thread count, fallback to available processor - * (but with a minimum value of 4) + * (but with a minimum value of 4). */ // static final int DEFAULT_QUIC_THREAD_COUNT = Integer.parseInt(System.getProperty( // ReactorNetty.QUIC_IO_THREAD_COUNT, diff --git a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServer.java b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServer.java index 220ced7648..ee84a0e72a 100644 --- a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServer.java +++ b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -55,7 +55,7 @@ public abstract class QuicServer extends QuicTransport { /** - * Prepare a {@link QuicServer} + * Prepare a {@link QuicServer}. * * @return a {@link QuicServer} */ diff --git a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServerConfig.java b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServerConfig.java index ba1617d98c..143f5c7a29 100644 --- a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServerConfig.java +++ b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicServerConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -56,7 +56,7 @@ public final class QuicServerConfig extends QuicTransportConfig {@link QuicTransport} implementation * @param {@link QuicTransportConfig} implementation @@ -261,7 +261,7 @@ public final T idleTimeout(Duration idleTimeout) { } /** - * Configure QUIC initial settings + * Configure QUIC initial settings. * * @param initialSettings configures QUIC initial settings * @return a {@link QuicTransport} reference @@ -417,7 +417,7 @@ public final T streamAttr(AttributeKey key, @Nullable A value) { } /** - * Set or add the given {@link ConnectionObserver} for each stream + * Set or add the given {@link ConnectionObserver} for each stream. * * @param observer the {@link ConnectionObserver} addition * @return a {@link QuicTransport} reference diff --git a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicTransportConfig.java b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicTransportConfig.java index 15bad80a75..9ed889865f 100644 --- a/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicTransportConfig.java +++ b/reactor-netty-incubator-quic/src/main/java/reactor/netty/incubator/quic/QuicTransportConfig.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -305,7 +305,7 @@ public final int sendQueueLen() { /** * Return the configured {@link ConnectionObserver} if any or - * {@link ConnectionObserver#emptyListener()} for each stream + * {@link ConnectionObserver#emptyListener()} for each stream. * * @return the configured {@link ConnectionObserver} if any or * {@link ConnectionObserver#emptyListener()} for each stream diff --git a/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/BaseQuicTests.java b/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/BaseQuicTests.java index 4db8d33016..bd6c70bbc1 100644 --- a/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/BaseQuicTests.java +++ b/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/BaseQuicTests.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 VMware, Inc. or its affiliates, All Rights Reserved. + * Copyright (c) 2021-2023 VMware, Inc. or its affiliates, All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -74,7 +74,7 @@ void dispose() { } /** - * Creates {@link QuicServer} bound on a random port with: + * Creates {@link QuicServer} bound on a random port with. *
      *
    • InsecureQuicTokenHandler
      • *
    • wire logging enabled
      • @@ -151,7 +151,7 @@ public static QuicServer createServer(int port, Consumer *
    • wire logging enabled
      • *
    • InsecureTrustManagerFactory
      • @@ -182,7 +182,7 @@ public static QuicClient createClient(Supplier remoteAddress) { } /** - * Creates {@link QuicClient} with a specified remote address to connect to and the following configuration: + * Creates {@link QuicClient} with a specified remote address to connect to and the following configuration. *
        *
      • wire logging enabled
        • *
      • InsecureTrustManagerFactory
        • diff --git a/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicClientTests.java b/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicClientTests.java index f12fd176ef..5bd1a53493 100644 --- a/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicClientTests.java +++ b/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicClientTests.java @@ -55,7 +55,7 @@ void testCannotConnectToRemote() { } /** - * DATA_BLOCKED + * DATA_BLOCKED. */ @Test void testMaxDataNotSpecifiedBidirectional() throws Exception { @@ -66,7 +66,7 @@ void testMaxDataNotSpecifiedBidirectional() throws Exception { } /** - * DATA_BLOCKED + * DATA_BLOCKED. */ @Test void testMaxDataNotSpecifiedUnidirectional() throws Exception { @@ -76,7 +76,7 @@ void testMaxDataNotSpecifiedUnidirectional() throws Exception { } /** - * STREAM_DATA_BLOCKED + * STREAM_DATA_BLOCKED. */ @Test void testMaxStreamDataNotSpecifiedUnidirectional() throws Exception { @@ -86,7 +86,7 @@ void testMaxStreamDataNotSpecifiedUnidirectional() throws Exception { } /** - * STREAM_DATA_BLOCKED + * STREAM_DATA_BLOCKED. */ @Test void testMaxStreamDataLocalNotSpecifiedBidirectional() throws Exception { @@ -94,7 +94,7 @@ void testMaxStreamDataLocalNotSpecifiedBidirectional() throws Exception { } /** - * STREAM_DATA_BLOCKED + * STREAM_DATA_BLOCKED. */ @Test void testMaxStreamDataRemoteNotSpecifiedBidirectional() throws Exception { diff --git a/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicServerTests.java b/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicServerTests.java index 20c1c1b760..14389458dc 100644 --- a/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicServerTests.java +++ b/reactor-netty-incubator-quic/src/test/java/reactor/netty/incubator/quic/QuicServerTests.java @@ -53,7 +53,7 @@ class QuicServerTests extends BaseQuicTests { /** - * DATA_BLOCKED + * DATA_BLOCKED. */ @Test void testMaxDataNotSpecifiedBidirectional() throws Exception { @@ -64,7 +64,7 @@ void testMaxDataNotSpecifiedBidirectional() throws Exception { } /** - * DATA_BLOCKED + * DATA_BLOCKED. */ @Test void testMaxDataNotSpecifiedUnidirectional() throws Exception { @@ -74,7 +74,7 @@ void testMaxDataNotSpecifiedUnidirectional() throws Exception { } /** - * STREAM_DATA_BLOCKED + * STREAM_DATA_BLOCKED. */ @Test void testMaxStreamDataNotSpecifiedUnidirectional() throws Exception { @@ -84,7 +84,7 @@ void testMaxStreamDataNotSpecifiedUnidirectional() throws Exception { } /** - * STREAM_DATA_BLOCKED + * STREAM_DATA_BLOCKED. */ @Test void testMaxStreamDataLocalNotSpecifiedBidirectional() throws Exception { @@ -92,7 +92,7 @@ void testMaxStreamDataLocalNotSpecifiedBidirectional() throws Exception { } /** - * STREAM_DATA_BLOCKED + * STREAM_DATA_BLOCKED. */ @Test void testMaxStreamDataRemoteNotSpecifiedBidirectional() throws Exception {