001 /* HandshakeCompletedEvent.java -- SSL handshake completed.
002 Copyright (C) 2004 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.net.ssl;
040
041 import java.security.Principal;
042 import java.security.cert.Certificate;
043
044 import javax.security.cert.X509Certificate;
045
046 /**
047 * An event raised by a SSLSocket and passed to the {@link
048 * HandshakeCompletedListener#handshakeCompleted(HandshakeCompletedEvent)}
049 * method of all registered listeners when a SSL handshake in a SSL
050 * protocol is completed.
051 *
052 * @author Casey Marshall (rsdio@metastatic.org)
053 */
054 public class HandshakeCompletedEvent extends java.util.EventObject
055 {
056 // Fields.
057 // -------------------------------------------------------------------
058
059 /** Serialization constant. */
060 private static final long serialVersionUID = 7914963744257769778L;
061
062 /** The session. */
063 private final transient SSLSession session;
064
065 // Constructor.
066 // -------------------------------------------------------------------
067
068 /**
069 * Creates a new handshake completed event.
070 *
071 * @param socket The socket (also the source) creating this event.
072 * @param session The associated session object.
073 * @throws NullPointerException If <i>session</i> is null.
074 */
075 public HandshakeCompletedEvent(SSLSocket socket, SSLSession session)
076 {
077 super(socket);
078 if (session == null)
079 throw new NullPointerException();
080 this.session = session;
081 }
082
083 // Instance methods.
084 // --------------------------------------------------------------------
085
086 /**
087 * Returns the name of the cipher that was negotiated in this
088 * connection.
089 *
090 * @return The negotiated cipher name.
091 */
092 public String getCipherSuite()
093 {
094 if (session != null)
095 return session.getCipherSuite();
096 return null;
097 }
098
099 /**
100 * Returns the local certificates being used in this connection.
101 *
102 * @return The local certificates.
103 */
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 */
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 */
132 public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException
133 {
134 if (session != null)
135 return session.getPeerCertificates();
136 return null;
137 }
138
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 */
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 */
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 */
179 public SSLSocket getSocket()
180 {
181 return (SSLSocket) getSource();
182 }
183 }