Add a task to compile javadoc across all packages (#597)

Also fixes various issues that prevent javadoc compliation.
This commit is contained in:
Lai Jiang 2020-05-27 10:33:46 -04:00 committed by GitHub
parent 275b4b1cee
commit 02e43ab134
71 changed files with 236 additions and 249 deletions

View file

@ -76,18 +76,19 @@ public class EppServiceHandler extends HttpsRelayServiceHandler {
}
/**
* Write <hello> to the server after SSL handshake completion to request <greeting>
* Write {@code <hello>} to the server after SSL handshake completion to request {@code
* <greeting>}
*
* <p>When handling EPP over TCP, the server should issue a <greeting> to the client when a
* connection is established. Nomulus app however does not automatically sends the <greeting> upon
* connection. The proxy therefore first sends a <hello> to registry to request a <greeting>
* response.
* <p>When handling EPP over TCP, the server should issue a {@code <greeting>} to the client when
* a connection is established. Nomulus app however does not automatically sends the {@code
* <greeting>} upon connection. The proxy therefore first sends a {@code <hello>} to registry to
* request a {@code <greeting>} response.
*
* <p>The <hello> request is only sent after SSL handshake is completed between the client and the
* proxy so that the client certificate hash is available, which is needed to communicate with the
* server. Because {@link SslHandshakeCompletionEvent} is triggered before any calls to {@link
* #channelRead} are scheduled by the event loop executor, the <hello> request is guaranteed to be
* the first message sent to the server.
* <p>The {@code <hello>} request is only sent after SSL handshake is completed between the client
* and the proxy so that the client certificate hash is available, which is needed to communicate
* with the server. Because {@link SslHandshakeCompletionEvent} is triggered before any calls to
* {@link #channelRead} are scheduled by the event loop executor, the {@code <hello>} request is
* guaranteed to be the first message sent to the server.
*
* @see <a href="https://tools.ietf.org/html/rfc5734">RFC 5732 EPP Transport over TCP</a>
* @see <a href="https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">The Proxy

View file

@ -48,7 +48,7 @@ import javax.net.ssl.SSLHandshakeException;
*
* <p>This handler reads in a {@link ByteBuf}, converts it to an {@link FullHttpRequest}, and passes
* it to the {@code channelRead} method of the next inbound handler the channel pipeline, which is
* usually a {@link RelayHandler<FullHttpRequest>}. The relay handler writes the request to the
* usually a {@code RelayHandler<FullHttpRequest>}. The relay handler writes the request to the
* relay channel, which is connected to an HTTPS endpoint. After the relay channel receives a {@link
* FullHttpResponse} back, its own relay handler writes the response back to this channel, which is
* the relay channel of the relay channel. This handler then handles write request by encoding the