//
// ========================================================================
// Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under
// the terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0
//
// This Source Code may also be made available under the following
// Secondary Licenses when the conditions for such availability set
// forth in the Eclipse Public License, v. 2.0 are satisfied:
// the Apache License v2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.io.ssl;
import java.util.EventListener;
import java.util.EventObject;
import javax.net.ssl.SSLEngine;
import javax.net.ssl.SSLException;
Implementations of this interface are notified of TLS handshake events.
Similar to HandshakeCompletedListener
, but for SSLEngine
.
Typical usage if to add instances of this class as beans to a server connector, or
to a client connector.
/**
* <p>Implementations of this interface are notified of TLS handshake events.</p>
* <p>Similar to {@link javax.net.ssl.HandshakeCompletedListener}, but for {@link SSLEngine}.</p>
* <p>Typical usage if to add instances of this class as beans to a server connector, or
* to a client connector.</p>
*/
public interface SslHandshakeListener extends EventListener
{
Callback method invoked when the TLS handshake succeeds.
Params: - event – the event object carrying information about the TLS handshake event
Throws: - SSLException – if any error happen during handshake
/**
* <p>Callback method invoked when the TLS handshake succeeds.</p>
*
* @param event the event object carrying information about the TLS handshake event
* @throws SSLException if any error happen during handshake
*/
default void handshakeSucceeded(Event event) throws SSLException
{
}
Callback method invoked when the TLS handshake fails.
Params: - event – the event object carrying information about the TLS handshake event
- failure – the failure that caused the TLS handshake to fail
/**
* <p>Callback method invoked when the TLS handshake fails.</p>
*
* @param event the event object carrying information about the TLS handshake event
* @param failure the failure that caused the TLS handshake to fail
*/
default void handshakeFailed(Event event, Throwable failure)
{
}
The event object carrying information about TLS handshake events.
/**
* <p>The event object carrying information about TLS handshake events.</p>
*/
public static class Event extends EventObject
{
public Event(Object source)
{
super(source);
}
Returns: the SSLEngine associated to the TLS handshake event
/**
* @return the SSLEngine associated to the TLS handshake event
*/
public SSLEngine getSSLEngine()
{
return (SSLEngine)getSource();
}
}
}