HandshakeListener.java

/**
 * This file is part of SecureNIO. Copyright (C) 2014 K. Dermitzakis
 * <dermitza@gmail.com>
 *
 * SecureNIO is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * SecureNIO is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SecureNIO. If not, see <http://www.gnu.org/licenses/>.
 */
package ch.dermitza.securenio.socket.secure;

import ch.dermitza.securenio.socket.SocketIF;

/**
 * Handshake listeners listen for {@link javax.net.ssl.SSLEngine} handshake
 * completions and act upon them. As such, task listeners are only useful for
 * {@link SecureSocket} implementations. Only one handshake listener is
 * associated with each {@link SecureSocket} instance.
 *
 * @author K. Dermitzakis
 * @version 0.19
 * @since   0.18
 */
public interface HandshakeListener {

    /**
     * This method is called from the {@link SecureSocket} once the
     * {@link javax.net.ssl.SSLEngine#getHandshakeStatus()} is FINISHED.
     * Handshake listeners are notified that they can begin operating in the
     * relevant {@link SecureSocket}
     *
     * @param socket The SocketIF that just had its SSL/TLS handshake completed.
     * @see SecureSocket
     * @see ch.dermitza.securenio.AbstractSelector
     */
    public void handshakeComplete(SocketIF socket);
    
   // public void crap(SocketIF socket);
}