libjava/classpath/javax/net/ssl/HandshakeCompletedEvent.java

   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.cert.Certificate;
  42
  43 import javax.security.cert.X509Certificate;
  44
  45 /**
  46  * An event raised by a SSLSocket and passed to the {@link
  47  * HandshakeCompletedListener#handshakeCompleted(HandshakeCompletedEvent)}
  48  * method of all registered listeners when a SSL handshake in a SSL
  49  * protocol is completed.
  50  *
  51  * @author Casey Marshall (rsdio@metastatic.org)
  52  */
  53 public class HandshakeCompletedEvent extends java.util.EventObject
  54 {
  55   // Fields.
  56   // -------------------------------------------------------------------
  57
  58   /** Serialization constant. */
  59   private static final long serialVersionUID = 7914963744257769778L;
  60
  61   /** The session. */
  62   private final transient SSLSession session;
  63
  64   // Constructor.
  65   // -------------------------------------------------------------------
  66
  67   /**
  68    * Creates a new handshake completed event.
  69    *
  70    * @param socket The socket (also the source) creating this event.
  71    * @param session The associated session object.
  72    * @throws NullPointerException If <i>session</i> is null.
  73    */
  74   public HandshakeCompletedEvent(SSLSocket socket, SSLSession session)
  75   {
  76     super(socket);
  77     if (session == null)
  78       throw new NullPointerException();
  79     this.session = session;
  80   }
  81
  82   // Instance methods.
  83   // --------------------------------------------------------------------
  84
  85   /**
  86    * Returns the name of the cipher that was negotiated in this
  87    * connection.
  88    *
  89    * @return The negotiated cipher name.
  90    */
  91   public String getCipherSuite()
  92   {
  93     if (session != null)
  94       return session.getCipherSuite();
  95     return null;
  96   }
  97
  98   /**
  99    * Returns the local certificates being used in this connection.
 100    *
 101    * @return The local certificates.
 102    */
 103   public Certificate[] getLocalCertificates()
 104   {
 105     if (session != null)
 106       return session.getLocalCertificates();
 107     return null;
 108   }
 109
 110   /**
 111    * Returns the peer's certificates being used in this connection.
 112    *
 113    * @return The peer's certificates.
 114    * @throws SSLPeerUnverifiedException If the peer has not been
 115    *   verified.
 116    */
 117   public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException
 118   {
 119     if (session != null)
 120       return session.getPeerCertificates();
 121     return null;
 122   }
 123
 124   public X509Certificate[] getPeerCertificateChain() throws SSLPeerUnverifiedException
 125   {
 126     if (session != null)
 127       return session.getPeerCertificateChain();
 128     return null;
 129   }
 130
 131   /**
 132    * Returns the SSL session object associated with this connection.
 133    *
 134    * @return The session object.
 135    */
 136   public SSLSession getSession()
 137   {
 138     return session;
 139   }
 140
 141   /**
 142    * Returns the socket over which this connection is being
 143    * negotiated. This method is equivalent to the {@link
 144    * java.util.EventObject#getSource()} method.
 145    *
 146    * @return The socket.
 147    */
 148   public SSLSocket getSocket()
 149   {
 150     return (SSLSocket) getSource();
 151   }
 152 }