HandshakeCompletedEvent
open class HandshakeCompletedEvent : EventObject
| kotlin.Any | ||
| ↳ | java.util.EventObject | |
| ↳ | javax.net.ssl.HandshakeCompletedEvent | |
This event indicates that an SSL handshake completed on a given SSL connection. All of the core information about that handshake's result is captured through an "SSLSession" object. As a convenience, this event class provides direct access to some important session attributes.
The source of this event is the SSLSocket on which handshaking just completed.
Summary
| Public constructors | |
|---|---|
HandshakeCompletedEvent(sock: SSLSocket!, s: SSLSession!)Constructs a new HandshakeCompletedEvent. |
|
| Public methods | |
|---|---|
| open String! |
Returns the cipher suite in use by the session which was produced by the handshake. |
| open Array<Certificate!>! |
Returns the certificate(s) that were sent to the peer during handshaking. |
| open Principal! |
Returns the principal that was sent to the peer during handshaking. |
| open Array<X509Certificate!>! |
Returns the identity of the peer which was identified as part of defining the session. |
| open Array<Certificate!>! |
Returns the identity of the peer which was established as part of defining the session. |
| open Principal! |
Returns the identity of the peer which was established as part of defining the session. |
| open SSLSession! |
Returns the session that triggered this event. |
| open SSLSocket! |
Returns the socket which is the source of this event. |
| Inherited functions | |
|---|---|
| Inherited properties | |
|---|---|
Public constructors
HandshakeCompletedEvent
HandshakeCompletedEvent(
sock: SSLSocket!,
s: SSLSession!)
Constructs a new HandshakeCompletedEvent.
| Parameters | |
|---|---|
sock |
SSLSocket!: the SSLSocket acting as the source of the event |
s |
SSLSession!: the SSLSession this event is associated with |
Public methods
getCipherSuite
open fun getCipherSuite(): String!
Returns the cipher suite in use by the session which was produced by the handshake. (This is a convenience method for getting the ciphersuite from the SSLsession.)
| Return | |
|---|---|
String! |
the name of the cipher suite negotiated during this session. |
getLocalCertificates
open fun getLocalCertificates(): Array<Certificate!>!
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.
| Return | |
|---|---|
Array<Certificate!>! |
an ordered array of certificates, with the local certificate first followed by any certificate authorities. If no certificates were sent, then null is returned. |
See Also
getLocalPrincipal
open fun getLocalPrincipal(): Principal!
Returns the principal that was sent to the peer during handshaking.
| Return | |
|---|---|
Principal! |
the principal sent to the peer. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. If no principal was sent, then null is returned. |
getPeerCertificateChain
open fun getPeerCertificateChain(): Array<X509Certificate!>!
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.
| Return | |
|---|---|
Array<X509Certificate!>! |
an ordered array of peer X.509 certificates, with the peer's own certificate first followed by any certificate authorities. (The certificates are in the original JSSE javax.security.cert.X509Certificate format). |
| Exceptions | |
|---|---|
javax.net.ssl.SSLPeerUnverifiedException |
if the peer is not verified. |
See Also
getPeerCertificates
open fun getPeerCertificates(): Array<Certificate!>!
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.
| Return | |
|---|---|
Array<Certificate!>! |
an ordered array of the peer certificates, with the peer's own certificate first followed by any certificate authorities. |
| Exceptions | |
|---|---|
javax.net.ssl.SSLPeerUnverifiedException |
if the peer is not verified. |
See Also
getPeerPrincipal
open fun getPeerPrincipal(): Principal!
Returns the identity of the peer which was established as part of defining the session.
| Return | |
|---|---|
Principal! |
the peer's principal. Returns an X500Principal of the end-entity certiticate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. |
| Exceptions | |
|---|---|
javax.net.ssl.SSLPeerUnverifiedException |
if the peer's identity has not been verified |
getSession
open fun getSession(): SSLSession!
Returns the session that triggered this event.
| Return | |
|---|---|
SSLSession! |
the SSLSession for this handshake |
getSocket
open fun getSocket(): SSLSocket!
Returns the socket which is the source of this event. (This is a convenience function, to let applications write code without type casts.)
| Return | |
|---|---|
SSLSocket! |
the socket on which the connection was made. |