public class

HandshakeCompletedEvent

extends EventObject
java.lang.Object
   ↳ java.util.EventObject
     ↳ javax.net.ssl.HandshakeCompletedEvent

Class Overview

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.

See Also

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
HandshakeCompletedEvent(SSLSocket sock, SSLSession s)
Constructs a new HandshakeCompletedEvent.
Public Methods
String getCipherSuite()
Returns the cipher suite in use by the session which was produced by the handshake.
Certificate[] getLocalCertificates()
Returns the certificate(s) that were sent to the peer during handshaking.
Principal getLocalPrincipal()
Returns the principal that was sent to the peer during handshaking.
X509Certificate[] getPeerCertificateChain()
Returns the identity of the peer which was identified as part of defining the session.
Certificate[] getPeerCertificates()
Returns the identity of the peer which was established as part of defining the session.
Principal getPeerPrincipal()
Returns the identity of the peer which was established as part of defining the session.
SSLSession getSession()
Returns the session that triggered this event.
SSLSocket getSocket()
Returns the socket which is the source of this event.
[Expand]
Inherited Methods
From class java.util.EventObject
From class java.lang.Object

Public Constructors

public HandshakeCompletedEvent (SSLSocket sock, SSLSession s)

Constructs a new HandshakeCompletedEvent.

Parameters
sock the SSLSocket acting as the source of the event
s the SSLSession this event is associated with

Public Methods

public String getCipherSuite ()

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.)

Returns
  • the name of the cipher suite negotiated during this session.

public 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.

Returns
  • 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

public Principal getLocalPrincipal ()

Returns the principal that was sent to the peer during handshaking.

Returns
  • 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.
See Also

public 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.

Returns
  • 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 X509Certificate format).
Throws
SSLPeerUnverifiedException if the peer is not verified.
See Also

public 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.

Returns
  • an ordered array of the peer certificates, with the peer's own certificate first followed by any certificate authorities.
Throws
SSLPeerUnverifiedException if the peer is not verified.
See Also

public Principal getPeerPrincipal ()

Returns the identity of the peer which was established as part of defining the session.

Returns
  • the peer's principal. Returns an X500Principal of the end-entity certiticate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites.
Throws
SSLPeerUnverifiedException if the peer's identity has not been verified
See Also

public SSLSession getSession ()

Returns the session that triggered this event.

Returns
  • the SSLSession for this handshake

public SSLSocket getSocket ()

Returns the socket which is the source of this event. (This is a convenience function, to let applications write code without type casts.)

Returns
  • the socket on which the connection was made.