Added in API level 24

ExtendedSSLSession

abstract class ExtendedSSLSession : SSLSession

kotlin.Any
↳	javax.net.ssl.ExtendedSSLSession

Extends the SSLSession interface to support additional session attributes.

Summary

Public constructors
`ExtendedSSLSession()` Constructor for subclasses to call.

Public methods
abstract Array<String!>!	`getLocalSupportedSignatureAlgorithms()` Obtains an array of supported signature algorithms that the local side is willing to use.
abstract Array<String!>!	`getPeerSupportedSignatureAlgorithms()` Obtains an array of supported signature algorithms that the peer is able to use.
open MutableList<SNIServerName!>!	`getRequestedServerNames()` Obtains a `List` containing all `SNIServerName`s of the requested Server Name Indication (SNI) extension.
open MutableList<ByteArray!>!	`getStatusResponses()` Returns a `List` containing DER-encoded OCSP responses (using the ASN.1 type OCSPResponse defined in RFC 6960) for the client to verify status of the server's certificate during handshaking.

Inherited functions

From class SSLSession

`Int`	`getApplicationBufferSize()` Gets the current size of the largest application data that is expected when using this session. `SSLEngine` application data buffers must be large enough to hold the application data from any inbound network application data packet received. Typically, outbound application data buffers can be of any size.
`String!`	`getCipherSuite()` Returns the name of the SSL cipher suite which is used for all connections in the session. This defines the level of protection provided to the data sent on the connection, including the kind of encryption used and most aspects of how authentication is done.
`Long`	`getCreationTime()` Returns the time at which this Session representation was created, in milliseconds since midnight, January 1, 1970 UTC.
`ByteArray!`	`getId()` Returns the identifier assigned to this Session.
`Long`	`getLastAccessedTime()` Returns the last time this Session representation was accessed by the session level infrastructure, in milliseconds since midnight, January 1, 1970 UTC. Access indicates a new connection being established using session data. Application level operations, such as getting or setting a value associated with the session, are not reflected in this access time. This information is particularly useful in session management policies. For example, a session manager thread could leave all sessions in a given context which haven't been used in a long time; or, the sessions might be sorted according to age to optimize some task.
`Array<Certificate!>!`	`getLocalCertificates()` Returns the certificate(s) that were sent to the peer during handshaking. Note: This method is useful only when using certificate-based cipher suites. When multiple certificates are available for use in a handshake, the implementation chooses what it considers the "best" certificate chain available, and transmits that to the other side. This method allows the caller to know which certificate chain was actually used.
`Principal!`	`getLocalPrincipal()` Returns the principal that was sent to the peer during handshaking.
`Int`	`getPacketBufferSize()` Gets the current size of the largest SSL/TLS packet that is expected when using this session. A `SSLEngine` using this session may generate SSL/TLS packets of any size up to and including the value returned by this method. All `SSLEngine` network buffers should be sized at least this large to avoid insufficient space problems when performing `wrap` and `unwrap` calls.
`Array<X509Certificate!>!`	`getPeerCertificateChain()` Returns the identity of the peer which was identified as part of defining the session. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException. Note: this method exists for compatibility with previous releases. New applications should use `getPeerCertificates` instead.
`Array<Certificate!>!`	`getPeerCertificates()` Returns the identity of the peer which was established as part of defining the session. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.
`String!`	`getPeerHost()` Returns the host name of the peer in this session. For the server, this is the client's host; and for the client, it is the server's host. The name may not be a fully qualified host name or even a host name at all as it may represent a string encoding of the peer's network address. If such a name is desired, it might be resolved through a name service based on the value returned by this method. This value is not authenticated and should not be relied upon. It is mainly used as a hint for `SSLSession` caching strategies.
`Int`	`getPeerPort()` Returns the port number of the peer in this session. For the server, this is the client's port number; and for the client, it is the server's port number. This value is not authenticated and should not be relied upon. It is mainly used as a hint for `SSLSession` caching strategies.
`Principal!`	`getPeerPrincipal()` Returns the identity of the peer which was established as part of defining the session.
`String!`	`getProtocol()` Returns the standard name of the protocol used for all connections in the session. This defines the protocol used in the connection.
`SSLSessionContext!`	`getSessionContext()` Returns the context in which this session is bound. This context may be unavailable in some environments, in which case this method returns null. If the context is available and there is a security manager installed, the caller may require permission to access it or a security exception may be thrown. In a Java environment, the security manager's `checkPermission` method is called with a `SSLPermission("getSSLSessionContext")` permission.
`Any!`	`getValue(name: String!)` Returns the object bound to the given name in the session's application layer data. Returns null if there is no such binding. For security reasons, the same named values may not be visible across different access control contexts.
`Array<String!>!`	`getValueNames()` Returns an array of the names of all the application layer data objects bound into the Session. For security reasons, the same named values may not be visible across different access control contexts.
`Unit`	`invalidate()` Invalidates the session. Future connections will not be able to resume or join this session. However, any existing connection using this session can continue to use the session until the connection is closed.
`Boolean`	`isValid()` Returns whether this session is valid and available for resuming or joining.
`Unit`	`putValue(name: String!, value: Any!)` Binds the specified `value` object into the session's application layer data with the given `name`. Any existing binding using the same `name` is replaced. If the new (or existing) `value` implements the `SSLSessionBindingListener` interface, the object represented by `value` is notified appropriately. For security reasons, the same named values may not be visible across different access control contexts.
`Unit`	`removeValue(name: String!)` Removes the object bound to the given name in the session's application layer data. Does nothing if there is no object bound to the given name. If the bound existing object implements the `SessionBindingListener` interface, it is notified appropriately. For security reasons, the same named values may not be visible across different access control contexts.

Public constructors

ExtendedSSLSession

Added in API level 24

ExtendedSSLSession()

Constructor for subclasses to call.

Public methods

getLocalSupportedSignatureAlgorithms

Added in API level 24

abstract fun getLocalSupportedSignatureAlgorithms(): Array<String!>!

Obtains an array of supported signature algorithms that the local side is willing to use.

Note: this method is used to indicate to the peer which signature algorithms may be used for digital signatures in TLS/DTLS 1.2. It is not meaningful for TLS/DTLS versions prior to 1.2.

The signature algorithm name must be a standard Java Security name (such as "SHA1withRSA", "SHA256withECDSA", and so on). See the Java Security Standard Algorithm Names document for information about standard algorithm names.

Note: the local supported signature algorithms should conform to the algorithm constraints specified by getAlgorithmConstraints() method in SSLParameters.

Return
`Array<String!>!`	An array of supported signature algorithms, in descending order of preference. The return value is an empty array if no signature algorithm is supported.

See Also

javax.net.ssl.SSLParameters#getAlgorithmConstraints

getPeerSupportedSignatureAlgorithms

Added in API level 24

abstract fun getPeerSupportedSignatureAlgorithms(): Array<String!>!

Obtains an array of supported signature algorithms that the peer is able to use.

Note: this method is used to indicate to the local side which signature algorithms may be used for digital signatures in TLS/DTLS 1.2. It is not meaningful for TLS/DTLS versions prior to 1.2.

Return
`Array<String!>!`	An array of supported signature algorithms, in descending order of preference. The return value is an empty array if the peer has not sent the supported signature algorithms.

See Also

getRequestedServerNames

Added in API level 24

open fun getRequestedServerNames(): MutableList<SNIServerName!>!

Obtains a List containing all SNIServerNames of the requested Server Name Indication (SNI) extension.

In server mode, unless the return List is empty, the server should use the requested server names to guide its selection of an appropriate authentication certificate, and/or other aspects of security policy.

In client mode, unless the return List is empty, the client should use the requested server names to guide its endpoint identification of the peer's identity, and/or other aspects of security policy.

Return
`MutableList<SNIServerName!>!`	a non-null immutable list of `SNIServerName`s of the requested server name indications. The returned list may be empty if no server name indications were requested.

Exceptions
`java.lang.UnsupportedOperationException`	if the underlying provider does not implement the operation

See Also

getStatusResponses

Added in API level 37

open fun getStatusResponses(): MutableList<ByteArray!>!

Returns a List containing DER-encoded OCSP responses (using the ASN.1 type OCSPResponse defined in RFC 6960) for the client to verify status of the server's certificate during handshaking.

This method only applies to certificate-based server authentication. An X509ExtendedTrustManager will use the returned value for server certificate validation.

Return

MutableList<ByteArray!>! a non-null unmodifiable list of byte arrays, each entry containing a DER-encoded OCSP response (using the ASN.1 type OCSPResponse defined in RFC 6960). The order of the responses must match the order of the certificates presented by the server in its Certificate message (See SSLSession.getLocalCertificates() for server mode, and SSLSession.getPeerCertificates() for client mode). It is possible that fewer response entries may be returned than the number of presented certificates. If an entry in the list is a zero-length byte array, it should be treated by the caller as if the OCSP entry for the corresponding certificate is missing. The returned list may be empty if no OCSP responses were presented during handshaking or if OCSP stapling is not supported by either endpoint for this handshake.

Return
`MutableList<ByteArray!>!`	a non-null unmodifiable list of byte arrays, each entry containing a DER-encoded OCSP response (using the ASN.1 type OCSPResponse defined in RFC 6960). The order of the responses must match the order of the certificates presented by the server in its Certificate message (See `SSLSession.getLocalCertificates()` for server mode, and `SSLSession.getPeerCertificates()` for client mode). It is possible that fewer response entries may be returned than the number of presented certificates. If an entry in the list is a zero-length byte array, it should be treated by the caller as if the OCSP entry for the corresponding certificate is missing. The returned list may be empty if no OCSP responses were presented during handshaking or if OCSP stapling is not supported by either endpoint for this handshake.

Exceptions
`java.lang.UnsupportedOperationException`	if the underlying provider does not implement the operation

See Also

javax.net.ssl.X509ExtendedTrustManager