Class HandshakeCompletedEvent

java.lang.Object
java.util.EventObject
javax.net.ssl.HandshakeCompletedEvent
All Implemented Interfaces:
Serializable
public class HandshakeCompletedEvent extends EventObject
This event indicates that an SSL handshake completed on a given SSL connection. All 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.

Since:
1.4
See Also:

  • Field Summary

    Fields declared in class EventObject

    source
    Modifier and Type
    Field
    Description
    protected Object
    source
    The object on which the Event initially occurred.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HandshakeCompletedEvent(SSLSocket sock, SSLSession s)
    Constructs a new HandshakeCompletedEvent.

  • Method Summary

    Modifier and Type
    Method
    Description
    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()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The getPeerCertificates() method that returns an array of java.security.cert.Certificate should be used instead.
    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.

    Methods declared in class EventObject

    getSource, toString
    Modifier and Type
    Method
    Description
    Object
    getSource()
    The object on which the Event initially occurred.
    String
    toString()
    Returns a String representation of this EventObject.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Creates and returns a copy of this object.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    int
    hashCode()
    Returns a hash code value for this object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  • Constructor Details

    • HandshakeCompletedEvent

      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

  • Method Details

    • getSession

      public SSLSession getSession()
      Returns the session that triggered this event.
      Returns:
      the SSLSession for this handshake

    • getCipherSuite

      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.

    • getLocalCertificates

      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:

    • getPeerCertificates

      public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException
      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.

      Note: The returned value may not be a valid certificate chain and should not be relied on for trust decisions.

      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:

    • getPeerCertificateChain

      @Deprecated(since="9", forRemoval=true) public X509Certificate[] getPeerCertificateChain() throws SSLPeerUnverifiedException
      Deprecated, for removal: This API element is subject to removal in a future version.
      The getPeerCertificates() method that returns an array of java.security.cert.Certificate should be used instead.
      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: The returned value may not be a valid certificate chain and should not be relied on for trust decisions.

      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.
      UnsupportedOperationException - if the underlying provider does not implement the SSLSession.getPeerCertificateChain() operation.
      See Also:

    • getPeerPrincipal

      public Principal getPeerPrincipal() throws SSLPeerUnverifiedException
      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 certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites.
      Throws:
      SSLPeerUnverifiedException - if the peer's identity has not been verified
      Since:
      1.5
      See Also:

    • getLocalPrincipal

      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.
      Since:
      1.5
      See Also:

    • getSocket

      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.