Tomcat 10.1.19 · org.apache.tomcat.util.net.ServletConnectionImpl

Modifier and Type	Field and Description
private final String	connectionId
private final String	protocol
private final String	protocolConnectionId
private final boolean	secure

Access	Constructor and Description
public	ServletConnectionImpl(String connectionId, String protocol, String protocolConnectionId, boolean secure)

Method Summary

Modifier and Type	Method and Description
public String	getConnectionId() Implements jakarta.servlet.ServletConnection.getConnectionId. Obtain a unique (within the lifetime of the JVM) identifier string for the network connection to the JVM that is being used for the `ServletRequest` from which this `ServletConnection` was obtained.
public String	getProtocol() Implements jakarta.servlet.ServletConnection.getProtocol. Obtain the name of the protocol as presented to the server after the removal, if present, of any TLS or similar encryption.
public String	getProtocolConnectionId() Implements jakarta.servlet.ServletConnection.getProtocolConnectionId. Obtain the connection identifier for the network connection to the server that is being used for the `ServletRequest` from which this `ServletConnection` was obtained as defined by the protocol in use.
public boolean	isSecure() Implements jakarta.servlet.ServletConnection.isSecure. Determine whether or not the incoming network connection to the server used encryption or not.

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

connectionId	back to summary
private final String connectionId

protocol	back to summary
private final String protocol

protocolConnectionId	back to summary
private final String protocolConnectionId

secure	back to summary
private final boolean secure

ServletConnectionImpl	back to summary
public ServletConnectionImpl(String connectionId, String protocol, String protocolConnectionId, boolean secure)

Method Detail

getConnectionId back to summary

getConnectionId	back to summary
public String getConnectionId() Implements jakarta.servlet.ServletConnection.getConnectionId. Doc from jakarta.servlet.ServletConnection.getConnectionId. Obtain a unique (within the lifetime of the JVM) identifier string for the network connection to the JVM that is being used for the `ServletRequest` from which this `ServletConnection` was obtained. There is no defined format for this string. The format is implementation dependent. Returns:String A unique identifier for the network connection Annotations @Override

public String getConnectionId()

Implements jakarta.servlet.ServletConnection.getConnectionId.

Doc from jakarta.servlet.ServletConnection.getConnectionId.

Obtain a unique (within the lifetime of the JVM) identifier string for the network connection to the JVM that is being used for the ServletRequest from which this ServletConnection was obtained.

There is no defined format for this string. The format is implementation dependent.

Returns:String

A unique identifier for the network connection

Annotations

@Override

getProtocol	back to summary
public String getProtocol() Implements jakarta.servlet.ServletConnection.getProtocol. Doc from jakarta.servlet.ServletConnection.getProtocol. 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. If the protocol has an entry in the IANA registry for ALPN names 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". Returns:String The name of the protocol presented to the server after decryption of TLS, or similar encryption, if any. Annotations @Override

getProtocol

back to summary

public String getProtocol()

Implements jakarta.servlet.ServletConnection.getProtocol.

Doc from jakarta.servlet.ServletConnection.getProtocol.

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.

If the protocol has an entry in the IANA registry for ALPN names 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".

Returns:String

The name of the protocol presented to the server after decryption of TLS, or similar encryption, if any.

Annotations

@Override

getProtocolConnectionId back to summary

getProtocolConnectionId	back to summary
public String getProtocolConnectionId() Implements jakarta.servlet.ServletConnection.getProtocolConnectionId. Doc from jakarta.servlet.ServletConnection.getProtocolConnectionId. Obtain the connection identifier for the network connection to the server that is being used for the `ServletRequest` from which this `ServletConnection` was obtained as defined by the protocol in use. Note that some protocols do not define such an identifier. Examples of protocol provided connection identifiers include: HTTP 1.x None, so the empty string should be returned HTTP 2 None, so the empty string should be returned HTTP 3 The QUIC connection ID AJP None, so the empty string should be returned Returns:String The connection identifier if one is defined, otherwise an empty string Annotations @Override

public String getProtocolConnectionId()

Implements jakarta.servlet.ServletConnection.getProtocolConnectionId.

Doc from jakarta.servlet.ServletConnection.getProtocolConnectionId.

Obtain the connection identifier for the network connection to the server that is being used for the ServletRequest from which this ServletConnection was obtained as defined by the protocol in use. Note that some protocols do not define such an identifier.

Examples of protocol provided connection identifiers include:

HTTP 1.x: None, so the empty string should be returned
HTTP 2: None, so the empty string should be returned
HTTP 3: The QUIC connection ID
AJP: None, so the empty string should be returned

Returns:String

The connection identifier if one is defined, otherwise an empty string

Annotations

@Override

isSecure back to summary

isSecure	back to summary
public boolean isSecure() Implements jakarta.servlet.ServletConnection.isSecure. Doc from jakarta.servlet.ServletConnection.isSecure. 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 `X-Forwarded-Proto`. Returns:boolean `true` if the incoming network connection used encryption, otherwise `false` Annotations @Override

public boolean isSecure()

Implements jakarta.servlet.ServletConnection.isSecure.

Doc from jakarta.servlet.ServletConnection.isSecure.

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 X-Forwarded-Proto.

Returns:boolean

true if the incoming network connection used encryption, otherwise false

Annotations

@Override

public Class ServletConnectionImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail