1 /* HandshakeCompletedEvent.java -- SSL handshake completed. 2 Copyright (C) 2004 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package javax.net.ssl; 40 41 import java.security.Principal; 42 import java.security.cert.Certificate; 43 44 import javax.security.cert.X509Certificate; 45 46 /** 47 * An event raised by a SSLSocket and passed to the {@link 48 * HandshakeCompletedListener#handshakeCompleted(HandshakeCompletedEvent)} 49 * method of all registered listeners when a SSL handshake in a SSL 50 * protocol is completed. 51 * 52 * @author Casey Marshall (rsdio@metastatic.org) 53 */ 54 public class HandshakeCompletedEvent extends java.util.EventObject 55 { 56 // Fields. 57 // ------------------------------------------------------------------- 58 59 /** Serialization constant. */ 60 private static final long serialVersionUID = 7914963744257769778L; 61 62 /** The session. */ 63 private final transient SSLSession session; 64 65 // Constructor. 66 // ------------------------------------------------------------------- 67 68 /** 69 * Creates a new handshake completed event. 70 * 71 * @param socket The socket (also the source) creating this event. 72 * @param session The associated session object. 73 * @throws NullPointerException If <i>session</i> is null. 74 */ HandshakeCompletedEvent(SSLSocket socket, SSLSession session)75 public HandshakeCompletedEvent(SSLSocket socket, SSLSession session) 76 { 77 super(socket); 78 if (session == null) 79 throw new NullPointerException(); 80 this.session = session; 81 } 82 83 // Instance methods. 84 // -------------------------------------------------------------------- 85 86 /** 87 * Returns the name of the cipher that was negotiated in this 88 * connection. 89 * 90 * @return The negotiated cipher name. 91 */ getCipherSuite()92 public String getCipherSuite() 93 { 94 if (session != null) 95 return session.getCipherSuite(); 96 return null; 97 } 98 99 /** 100 * Returns the local certificates being used in this connection. 101 * 102 * @return The local certificates. 103 */ getLocalCertificates()104 public Certificate[] getLocalCertificates() 105 { 106 if (session != null) 107 return session.getLocalCertificates(); 108 return null; 109 } 110 111 /** 112 * Returns the local identity used in this connection, or 113 * <code>null</code> if there is none. 114 * 115 * @return The local identity. 116 * @since 1.5 117 */ getLocalPrincipal()118 public Principal getLocalPrincipal () 119 { 120 if (session != null) 121 return session.getLocalPrincipal (); 122 return null; 123 } 124 125 /** 126 * Returns the peer's certificates being used in this connection. 127 * 128 * @return The peer's certificates. 129 * @throws SSLPeerUnverifiedException If the peer has not been 130 * verified. 131 */ getPeerCertificates()132 public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException 133 { 134 if (session != null) 135 return session.getPeerCertificates(); 136 return null; 137 } 138 getPeerCertificateChain()139 public X509Certificate[] getPeerCertificateChain() throws SSLPeerUnverifiedException 140 { 141 if (session != null) 142 return session.getPeerCertificateChain(); 143 return null; 144 } 145 146 /** 147 * Returns the peer's identity, or <code>null</code> if there is 148 * none. 149 * 150 * @return The peer's identity. 151 * @throws SSLPeerUnverifiedException If the remote peer's identity 152 * could not be verified. 153 * @since 1.5 154 */ getPeerPrincipal()155 public Principal getPeerPrincipal () throws SSLPeerUnverifiedException 156 { 157 if (session != null) 158 return session.getPeerPrincipal (); 159 return null; 160 } 161 162 /** 163 * Returns the SSL session object associated with this connection. 164 * 165 * @return The session object. 166 */ getSession()167 public SSLSession getSession() 168 { 169 return session; 170 } 171 172 /** 173 * Returns the socket over which this connection is being 174 * negotiated. This method is equivalent to the {@link 175 * java.util.EventObject#getSource()} method. 176 * 177 * @return The socket. 178 */ getSocket()179 public SSLSocket getSocket() 180 { 181 return (SSLSocket) getSource(); 182 } 183 } 184