com.fireflysource.net.tcp.secure.SecureEngineFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of firefly-net Show documentation
There is a newer version: 5.0.2
package com.fireflysource.net.tcp.secure;

import kotlinx.coroutines.CoroutineScope;

import java.util.List;

/**
 * The TLS engine factory.
 *
 * @author Pengtao Qiu
 */
public interface SecureEngineFactory {

    /**
     * Create a TLS engine.
     *
     * @param coroutineScope     The coroutine scope.
     * @param clientMode         If true, the current connection is the client tcp connection.
     * @param supportedProtocols The supported application layer protocols.
     * @return The TLS engine.
     */
    SecureEngine create(CoroutineScope coroutineScope, boolean clientMode, List supportedProtocols);

    /**
     * Create a TLS engine using advisory peer information.
     * Applications using this factory method are providing hints for an internal session reuse strategy.
     * Some cipher suites (such as Kerberos) require remote hostname information, in which case peerHost needs to be specified.
     *
     * @param coroutineScope     The coroutine scope.
     * @param clientMode         If true, the current connection is the client tcp connection.
     * @param peerHost           the non-authoritative name of the host.
     * @param peerPort           the non-authoritative port.
     * @param supportedProtocols The supported application layer protocols.
     * @return The TLS engine.
     */
    SecureEngine create(CoroutineScope coroutineScope, boolean clientMode, String peerHost, int peerPort, List supportedProtocols);

    /**
     * Create a TLS engine by default coroutine scope.
     *
     * @param clientMode         If true, the current connection is the client tcp connection.
     * @param supportedProtocols The supported application layer protocols.
     * @return The TLS engine.
     */
    default SecureEngine create(boolean clientMode, List supportedProtocols) {
        return create(null, clientMode, supportedProtocols);
    }

    /**
     * Create a TLS engine by default coroutine scope and advisory peer information.
     * Applications using this factory method are providing hints for an internal session reuse strategy.
     * Some cipher suites (such as Kerberos) require remote hostname information, in which case peerHost needs to be specified.
     *
     * @param clientMode         If true, the current connection is the client tcp connection.
     * @param peerHost           the non-authoritative name of the host.
     * @param peerPort           the non-authoritative port.
     * @param supportedProtocols The supported application layer protocols.
     * @return The TLS engine.
     */
    default SecureEngine create(boolean clientMode, String peerHost, int peerPort, List supportedProtocols) {
        return create(null, clientMode, peerHost, peerPort, supportedProtocols);
    }
}