org.bouncycastle.jsse.BCSSLSocket Maven / Gradle / Ivy

Go to download
package org.bouncycastle.jsse;

import javax.net.SocketFactory;
import javax.net.ssl.SSLSocket;

/**
 * A BCJSSE-specific interface to expose extended functionality on {@link javax.net.ssl.SSLSocket}
 * implementations.
 */
public interface BCSSLSocket
{
    String getApplicationProtocol();

    BCApplicationProtocolSelector getBCHandshakeApplicationProtocolSelector();

    void setBCHandshakeApplicationProtocolSelector(BCApplicationProtocolSelector selector);

    BCExtendedSSLSession getBCHandshakeSession();

    /**
     * Returns an accessor for extended SSL connection data. This method will initiate the initial
     * handshake if necessary and then block until the handshake has been established. If an error
     * occurs during the initial handshake, this method returns null.
     * 
     * @return A {@link BCSSLConnection} instance.
     */
    BCSSLConnection getConnection();

    String getHandshakeApplicationProtocol();

    /**
     * Returns a {@link BCSSLParameters} with properties reflecting the current configuration.
     * @return the current {@link BCSSLParameters parameters}
     */
    BCSSLParameters getParameters();

    /**
     * Allows explicit setting of the 'host' {@link String} when the {@link SocketFactory} methods
     * that include it as an argument are not used.
     * 
     * Must be called prior to attempting to connect the socket to have any effect.
     * 
     *
     * @param host
     *            the server host name with which to connect, or null for the loopback
     *            address.
     */
    void setHost(String host);

    /**
     * Sets parameters according to the properties in a {@link BCSSLParameters}.
     * 
     * Note that any properties set to null will be ignored, which will leave the corresponding
     * settings unchanged.
     * 
     *
     * @param parameters
     *            the {@link BCSSLParameters parameters} to set
     * @throws IllegalArgumentException
     *             if the cipherSuites or protocols properties contain unsupported values
     */
    void setParameters(BCSSLParameters parameters);
}