- java.lang.Object
-
- java.util.EventObject
-
- javax.net.ssl.HandshakeCompletedEvent
-
- All Implemented Interfaces:
- Serializable
public class HandshakeCompletedEvent extends EventObject
This event indicates that an SSL handshake completed on a given SSL connection. All of the core information about that handshake's result is captured through an "SSLSession" object. As a convenience, this event class provides direct access to some important session attributes.The source of this event is the SSLSocket on which handshaking just completed.
- Since:
- 1.4
- See Also:
SSLSocket
,HandshakeCompletedListener
,SSLSession
, Serialized Form
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description HandshakeCompletedEvent(SSLSocket sock, SSLSession s)
Constructs a new HandshakeCompletedEvent.
-
Method Summary
Methods Modifier and Type Method and Description String
getCipherSuite()
Returns the cipher suite in use by the session which was produced by the handshake.Certificate[]
getLocalCertificates()
Returns the certificate(s) that were sent to the peer during handshaking.Principal
getLocalPrincipal()
Returns the principal that was sent to the peer during handshaking.X509Certificate[]
getPeerCertificateChain()
Returns the identity of the peer which was identified as part of defining the session.Certificate[]
getPeerCertificates()
Returns the identity of the peer which was established as part of defining the session.Principal
getPeerPrincipal()
Returns the identity of the peer which was established as part of defining the session.SSLSession
getSession()
Returns the session that triggered this event.SSLSocket
getSocket()
Returns the socket which is the source of this event.
-
-
-
Constructor Detail
-
HandshakeCompletedEvent
public HandshakeCompletedEvent(SSLSocket sock, SSLSession s)
Constructs a new HandshakeCompletedEvent.- Parameters:
sock
- the SSLSocket acting as the source of the events
- the SSLSession this event is associated with
-
-
Method Detail
-
getSession
public SSLSession getSession()
Returns the session that triggered this event.- Returns:
- the
SSLSession
for this handshake
-
getCipherSuite
public String getCipherSuite()
Returns the cipher suite in use by the session which was produced by the handshake. (This is a convenience method for getting the ciphersuite from the SSLsession.)- Returns:
- the name of the cipher suite negotiated during this session.
-
getLocalCertificates
public Certificate[] getLocalCertificates()
Returns the certificate(s) that were sent to the peer during handshaking. Note: This method is useful only when using certificate-based cipher suites. When multiple certificates are available for use in a handshake, the implementation chooses what it considers the "best" certificate chain available, and transmits that to the other side. This method allows the caller to know which certificate chain was actually used.- Returns:
- an ordered array of certificates, with the local certificate first followed by any certificate authorities. If no certificates were sent, then null is returned.
- See Also:
getLocalPrincipal()
-
getPeerCertificates
public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException
Returns the identity of the peer which was established as part of defining the session. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.- Returns:
- an ordered array of the peer certificates, with the peer's own certificate first followed by any certificate authorities.
- Throws:
SSLPeerUnverifiedException
- if the peer is not verified.- See Also:
getPeerPrincipal()
-
getPeerCertificateChain
public X509Certificate[] getPeerCertificateChain() throws SSLPeerUnverifiedException
Returns the identity of the peer which was identified as part of defining the session. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.Note: this method exists for compatibility with previous releases. New applications should use
getPeerCertificates()
instead.- Returns:
- an ordered array of peer X.509 certificates,
with the peer's own certificate first followed by any
certificate authorities. (The certificates are in
the original JSSE
X509Certificate
format). - Throws:
SSLPeerUnverifiedException
- if the peer is not verified.- See Also:
getPeerPrincipal()
-
getPeerPrincipal
public Principal getPeerPrincipal() throws SSLPeerUnverifiedException
Returns the identity of the peer which was established as part of defining the session.- Returns:
- the peer's principal. Returns an X500Principal of the end-entity certiticate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites.
- Throws:
SSLPeerUnverifiedException
- if the peer's identity has not been verified- Since:
- 1.5
- See Also:
getPeerCertificates()
,getLocalPrincipal()
-
getLocalPrincipal
public Principal getLocalPrincipal()
Returns the principal that was sent to the peer during handshaking.- Returns:
- the principal sent to the peer. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. If no principal was sent, then null is returned.
- Since:
- 1.5
- See Also:
getLocalCertificates()
,getPeerPrincipal()
-
getSocket
public SSLSocket getSocket()
Returns the socket which is the source of this event. (This is a convenience function, to let applications write code without type casts.)- Returns:
- the socket on which the connection was made.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/11/2024 22:00:59 Cette version de la page est en cache (à la date du 21/11/2024 22:00:59) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/net/ssl/HandshakeCompletedEvent.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.