javax.net.ssl

Class HandshakeCompletedEvent

java.util.EventObject
|
+--javax.net.ssl.HandshakeCompletedEvent

public class HandshakeCompletedEvent

extends java.util.EventObject

An event raised by a SSLSocket and passed to the HandshakeCompletedListener#handshakeCompleted(HandshakeCompletedEvent) method of all registered listeners when a SSL handshake in a SSL protocol is completed.

Author:

Casey Marshall (rsdio@metastatic.org)

Constructor Summary

HandshakeCompletedEvent(javax.net.ssl.SSLSocket socket, javax.net.ssl.SSLSession session)

Creates a new handshake completed event.

Method Summary

`String`	`getCipherSuite()` Returns the name of the cipher that was negotiated in this connection.
`Certificate[]`	`getLocalCertificates()` Returns the local certificates being used in this connection.
`javax.security.cert.X509Certificate[]`	`getPeerCertificateChain()`
`Certificate[]`	`getPeerCertificates()` Returns the peer's certificates being used in this connection.
`javax.net.ssl.SSLSession`	`getSession()` Returns the SSL session object associated with this connection.
`javax.net.ssl.SSLSocket`	`getSocket()` Returns the socket over which this connection is being negotiated.

Constructor Details

HandshakeCompletedEvent

public HandshakeCompletedEvent(javax.net.ssl.SSLSocket socket, javax.net.ssl.SSLSession session)

Creates a new handshake completed event.

Parameters:

socket - The socket (also the source) creating this event.
session - The associated session object.

Throws:

- If session is null.

Method Details

getCipherSuite

public String getCipherSuite()

Returns the name of the cipher that was negotiated in this connection.

Returns:

The negotiated cipher name.

getLocalCertificates

public Certificate[] getLocalCertificates()

Returns the local certificates being used in this connection.

Returns:

The local certificates.

getPeerCertificateChain

public X509Certificate[] getPeerCertificateChain()

getPeerCertificates

public Certificate[] getPeerCertificates()

Returns the peer's certificates being used in this connection.

Returns:

The peer's certificates.

Throws:

SSLPeerUnverifiedException - If the peer has not been verified.

getSession

public SSLSession getSession()

Returns the SSL session object associated with this connection.

Returns:

The session object.

getSocket

public SSLSocket getSocket()

Returns the socket over which this connection is being negotiated. This method is equivalent to the java.util.EventObject#getSource() method.

Returns:

The socket.