http://www.jboss.org/xnio: The API JAR of the XNIO project (JBoss by Red Hat) 
/*
 * JBoss, Home of Professional Open Source
 *
 * Copyright 2009 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.xnio.channels;

import java.io.IOException;

import javax.net.ssl.SSLSession;

import org.xnio.ChannelListener;


A channel which can use SSL/TLS to negotiate a security layer.

/**
 * A channel which can use SSL/TLS to negotiate a security layer.
 */
public interface SslChannel extends ConnectedChannel {

    
Start or restart the SSL/TLS handshake.  To force a complete SSL/TLS session renegotiation, the current
session should be invalidated prior to calling this method.  This method is not needed for the initial handshake
as sending or receiving over the channel will automatically initiate it.

Throws:
  • IOException – if an I/O error occurs
/**
     * Start or restart the SSL/TLS handshake.  To force a complete SSL/TLS session renegotiation, the current
     * session should be invalidated prior to calling this method.  This method is not needed for the initial handshake
     * as sending or receiving over the channel will automatically initiate it.
     *
     * @throws IOException if an I/O error occurs
     */
    void startHandshake() throws IOException;

    
Get the current SSLSession for this channel. 
Returns:the current SSLSession
/**
     * Get the current {@code SSLSession} for this channel.
     *
     * @return the current {@code SSLSession}
     */
    SSLSession getSslSession();

    
{@inheritDoc} 
/** {@inheritDoc} */
    ChannelListener.Setter<? extends SslChannel> getCloseSetter();

    
Get the setter which can be used to change the handshake listener for this channel.

Returns:the setter
/**
     * Get the setter which can be used to change the handshake listener for this channel.
     *
     * @return the setter
     */
    ChannelListener.Setter<? extends SslChannel> getHandshakeSetter();
}