javax.net.ssl

Class HandshakeCompletedEvent

Implemented Interfaces:
Serializable

public class HandshakeCompletedEvent
extends 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.
See Also:
Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

HandshakeCompletedEvent(SSLSocket socket, 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.
Principal
getLocalPrincipal()
Returns the local identity used in this connection, or null if there is none.
X509Certificate[]
getPeerCertificateChain()
Certificate[]
getPeerCertificates()
Returns the peer's certificates being used in this connection.
Principal
getPeerPrincipal()
Returns the peer's identity, or null if there is none.
SSLSession
getSession()
Returns the SSL session object associated with this connection.
SSLSocket
getSocket()
Returns the socket over which this connection is being negotiated.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HandshakeCompletedEvent

public HandshakeCompletedEvent(SSLSocket socket,
                               SSLSession session)
Creates a new handshake completed event.
Parameters:
socket - The socket (also the source) creating this event.
session - The associated session object.
Throws:
NullPointerException - 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.

getLocalPrincipal

public Principal getLocalPrincipal()
Returns the local identity used in this connection, or null if there is none.
Returns:
The local identity.
Since:
1.5

getPeerCertificateChain

public X509Certificate[] getPeerCertificateChain()
            throws SSLPeerUnverifiedException

getPeerCertificates

public Certificate[] getPeerCertificates()
            throws SSLPeerUnverifiedException
Returns the peer's certificates being used in this connection.
Returns:
The peer's certificates.
Throws:
SSLPeerUnverifiedException - If the peer has not been verified.

getPeerPrincipal

public Principal getPeerPrincipal()
            throws SSLPeerUnverifiedException
Returns the peer's identity, or null if there is none.
Returns:
The peer's identity.
Throws:
SSLPeerUnverifiedException - If the remote peer's identity could not be verified.
Since:
1.5

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 EventObject.getSource() method.
Returns:
The socket.

HandshakeCompletedEvent.java -- SSL handshake completed. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.