/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.
*/ package jakarta.servlet;
/** * Provides information about the connection made to the Servlet container. This interface is intended primarily for * debugging purposes and as such provides the raw information as seen by the container. Unless explicitly stated * otherwise in the Javadoc for a method, no adjustment is made for the presence of reverse proxies or similar * configurations. * * @since Servlet 6.0
*/ publicinterface ServletConnection {
/** * Obtain a unique (within the lifetime of the JVM) identifier string for the network connection to the JVM that is * being used for the {@code ServletRequest} from which this {@code ServletConnection} was obtained. * <p> * There is no defined format for this string. The format is implementation dependent. * * @return A unique identifier for the network connection
*/
String getConnectionId();
/** * Obtain the name of the protocol as presented to the server after the removal, if present, of any TLS or similar * encryption. This may not be the same as the protocol seen by the application. For example, a reverse proxy may * present AJP whereas the application will see HTTP 1.1. * <p> * If the protocol has an entry in the <a href= * "https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids">IANA * registry for ALPN names</a> then the identification sequence, in string form, must be returned. Registered * identification sequences MUST only be used for the associated protocol. Return values for other protocols are * implementation dependent. Unknown protocols should return the string "unknown". * * @return The name of the protocol presented to the server after decryption of TLS, or similar encryption, if any.
*/
String getProtocol();
/** * Obtain the connection identifier for the network connection to the server that is being used for the * {@code ServletRequest} from which this {@code ServletConnection} was obtained as defined by the protocol in use. * Note that some protocols do not define such an identifier. * <p> * Examples of protocol provided connection identifiers include: * <dl> * <dt>HTTP 1.x</dt> * <dd>None, so the empty string should be returned</dd> * <dt>HTTP 2</dt> * <dd>None, so the empty string should be returned</dd> * <dt>HTTP 3</dt> * <dd>The QUIC connection ID</dd> * <dt>AJP</dt> * <dd>None, so the empty string should be returned</dd> * </dl> * * @return The connection identifier if one is defined, otherwise an empty string
*/
String getProtocolConnectionId();
/** * Determine whether or not the incoming network connection to the server used encryption or not. Note that where a * reverse proxy is used, the application may have a different view as to whether encryption is being used due to * the use of headers like {@code X-Forwarded-Proto}. * * @return {@code true} if the incoming network connection used encryption, otherwise {@code false}
*/ boolean isSecure();
}
¤ Dauer der Verarbeitung: 0.25 Sekunden
(vorverarbeitet)
¤
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.