Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package io.vertx.core.http;
import io.vertx.codegen.annotations.*;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.net.SocketAddress;
import javax.net.ssl.SSLPeerUnverifiedException;
import javax.net.ssl.SSLSession;
import javax.security.cert.X509Certificate;
import java.security.cert.Certificate;
import java.util.List;
import java.util.concurrent.TimeUnit;
/**
* Represents an HTTP connection.
*
* HTTP/1.x connection provides an limited implementation, the following methods are implemented:
*
*
{@link #close}
*
{@link #closeHandler}
*
{@link #exceptionHandler}
*
*
* @author Julien Viet
*/
@VertxGen
public interface HttpConnection {
/**
* @return the current connection window size or {@code -1} for HTTP/1.x
*/
default int getWindowSize() {
return -1;
}
/**
* Update the current connection wide window size to a new size.
*
* Increasing this value, gives better performance when several data streams are multiplexed
*
* This is not implemented for HTTP/1.x.
*
* @param windowSize the new window size
* @return a reference to this, so the API can be used fluently
*/
@Fluent
default HttpConnection setWindowSize(int windowSize) {
return this;
}
/**
* Like {@link #goAway(long, int)} with a last stream id {@code -1} which means to disallow any new stream creation.
*/
@Fluent
default HttpConnection goAway(long errorCode) {
return goAway(errorCode, -1);
}
/**
* Like {@link #goAway(long, int, Buffer)} with no buffer.
*/
@Fluent
default HttpConnection goAway(long errorCode, int lastStreamId) {
return goAway(errorCode, lastStreamId, null);
}
/**
* Send a go away frame to the remote endpoint of the connection.
*
*
*
a {@literal GOAWAY} frame is sent to the to the remote endpoint with the {@code errorCode} and {@code debugData}
*
any stream created after the stream identified by {@code lastStreamId} will be closed
*
for an {@literal errorCode} is different than {@code 0} when all the remaining streams are closed this connection will be closed automatically
*
*
* This is not implemented for HTTP/1.x.
*
* @param errorCode the {@literal GOAWAY} error code
* @param lastStreamId the last stream id
* @param debugData additional debug data sent to the remote endpoint
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection goAway(long errorCode, int lastStreamId, Buffer debugData);
/**
* Set an handler called when a {@literal GOAWAY} frame is received.
*
* This is not implemented for HTTP/1.x.
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection goAwayHandler(@Nullable Handler handler);
/**
* Set an handler called when a {@literal GOAWAY} frame has been sent or received and all connections are closed.
*
* This is not implemented for HTTP/1.x.
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection shutdownHandler(@Nullable Handler handler);
/**
* Shutdown a 30 seconds timeout ({@code shutdown(30, TimeUnit.SECONDS)}).
*/
default void shutdown(Handler> handler) {
shutdown(30, TimeUnit.SECONDS, handler);
}
/**
* Like {@link #shutdown(Handler)} but returns a {@code Future} of the asynchronous result
*/
default Future shutdown() {
return shutdown(30, TimeUnit.SECONDS);
}
/**
* Like {@link #shutdown(long, TimeUnit, Handler)}, in milliseconds.
*
* @deprecated instead use {@link #shutdown(long, TimeUnit, Handler)}
*/
@Deprecated
default void shutdown(long timeout, Handler> handler) {
shutdown(timeout, TimeUnit.MILLISECONDS, handler);
}
/**
* Like {@link #shutdown(long, Handler)} but returns a {@code Future} of the asynchronous result
*
* @deprecated instead use {@link #shutdown(long, TimeUnit)}
*/
@Deprecated
default Future shutdown(long timeoutMs) {
return shutdown(timeoutMs, TimeUnit.MILLISECONDS);
}
/**
* Initiate a graceful connection shutdown, the connection is taken out of service and closed when all the inflight requests
* are processed, otherwise after a {@code timeout} the connection will be closed. Client connection are immediately removed
* from the pool.
*
*
*
HTTP/2 connections will send a go away frame immediately to signal the other side the connection will close.
*
HTTP/1.x connection will be closed.
*
*
* @param timeout the amount of time after which all resources are forcibly closed
* @param unit the of the timeout
* @param handler the handler notified with the result
*/
default void shutdown(long timeout, TimeUnit unit, Handler> handler) {
Future fut = shutdown(timeout, unit);
if (handler != null) {
fut.onComplete(handler);
}
}
/**
* Like {@link #shutdown(long, TimeUnit, Handler)} but returns a {@code Future} of the asynchronous result
*/
Future shutdown(long timeout, TimeUnit unit);
/**
* Set a close handler. The handler will get notified when the connection is closed.
*
* @param handler the handler to be notified
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection closeHandler(Handler handler);
/**
* Like {@link #close(Handler)} but returns a {@code Future} of the asynchronous result
*/
Future close();
/**
* Close the connection and all the currently active streams.
*
* An HTTP/2 connection will send a {@literal GOAWAY} frame before.
*
* @param handler the handler to be completed when the connection is closed
*/
default void close(Handler> handler) {
close().onComplete(handler);
}
/**
* @return the latest server settings acknowledged by the remote endpoint - this is not implemented for HTTP/1.x
*/
Http2Settings settings();
/**
* Send to the remote endpoint an update of the server settings.
*
* This is not implemented for HTTP/1.x.
*
* @param settings the new settings
* @return a future completed with the result
*/
Future updateSettings(Http2Settings settings);
/**
* Send to the remote endpoint an update of this endpoint settings
*
* The {@code completionHandler} will be notified when the remote endpoint has acknowledged the settings.
*
* This is not implemented for HTTP/1.x.
*
* @param settings the new settings
* @param completionHandler the handler notified when the settings have been acknowledged by the remote endpoint
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection updateSettings(Http2Settings settings, Handler> completionHandler);
/**
* @return the current remote endpoint settings for this connection - this is not implemented for HTTP/1.x
*/
Http2Settings remoteSettings();
/**
* Set an handler that is called when remote endpoint {@link Http2Settings} are updated.
*
* This is not implemented for HTTP/1.x.
*
* @param handler the handler for remote endpoint settings
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection remoteSettingsHandler(Handler handler);
/**
* Send a {@literal PING} frame to the remote endpoint.
*
* This is not implemented for HTTP/1.x.
*
* @param data the 8 bytes data of the frame
* @param pongHandler an async result handler notified with pong reply or the failure
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection ping(Buffer data, Handler> pongHandler);
/**
* Same as {@link #ping(Buffer, Handler)} but returns a {@code Future} of the asynchronous result
*/
Future ping(Buffer data);
/**
* Set an handler notified when a {@literal PING} frame is received from the remote endpoint.
*
* This is not implemented for HTTP/1.x.
*
* @param handler the handler to be called when a {@literal PING} is received
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection pingHandler(@Nullable Handler handler);
/**
* Set an handler called when a connection error happens
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpConnection exceptionHandler(Handler handler);
/**
* @return the remote address for this connection, possibly {@code null} (e.g a server bound on a domain socket).
* If {@code useProxyProtocol} is set to {@code true}, the address returned will be of the actual connecting client.
*/
@CacheReturn
SocketAddress remoteAddress();
/**
* Like {@link #remoteAddress()} but returns the proxy remote address when {@code real} is {@code true}
*/
SocketAddress remoteAddress(boolean real);
/**
* @return the local address for this connection, possibly {@code null} (e.g a server bound on a domain socket)
* If {@code useProxyProtocol} is set to {@code true}, the address returned will be of the proxy.
*/
@CacheReturn
SocketAddress localAddress();
/**
* Like {@link #localAddress()} ()} but returns the server local address when {@code real} is {@code true}
*/
SocketAddress localAddress(boolean real);
/**
* @return true if this {@link io.vertx.core.http.HttpConnection} is encrypted via SSL/TLS.
*/
boolean isSsl();
/**
* @return SSLSession associated with the underlying socket. Returns null if connection is
* not SSL.
* @see javax.net.ssl.SSLSession
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
SSLSession sslSession();
/**
* Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of
* of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on. Use {@link #sslSession()} to
* access that method.
*
* @return an ordered array of the peer certificates. Returns null if connection is
* not SSL.
* @throws javax.net.ssl.SSLPeerUnverifiedException SSL peer's identity has not been verified.
* @see javax.net.ssl.SSLSession#getPeerCertificateChain()
* @see #sslSession()
* @deprecated instead use {@link #peerCertificates()} or {@link #sslSession()}
*/
@Deprecated
@GenIgnore
X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException;
/**
* @return an ordered list of the peer certificates. Returns null if connection is
* not SSL.
* @throws javax.net.ssl.SSLPeerUnverifiedException SSL peer's identity has not been verified.
* @see javax.net.ssl.SSLSession#getPeerCertificateChain()
* @see #sslSession()
*/
@GenIgnore()
List peerCertificates() throws SSLPeerUnverifiedException;
/**
* Returns the SNI server name presented during the SSL handshake by the client.
*
* @return the indicated server name
*/
String indicatedServerName();
}
