All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.netty5.handler.ssl.JdkApplicationProtocolNegotiator Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2014 The Netty Project
 *
 * The Netty Project licenses this file to you 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:
 *
 *   https://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 io.netty5.handler.ssl;

import io.netty5.buffer.BufferAllocator;
import io.netty5.buffer.DefaultBufferAllocators;

import javax.net.ssl.SSLEngine;
import java.util.List;
import java.util.Set;

/**
 * JDK extension methods to support {@link ApplicationProtocolNegotiator}
 *
 * @deprecated use {@link ApplicationProtocolConfig}
 */
@Deprecated
public interface JdkApplicationProtocolNegotiator extends ApplicationProtocolNegotiator {
    /**
     * Abstract factory pattern for wrapping an {@link SSLEngine} object. This is useful for NPN/APLN JDK support.
     */
    interface SslEngineWrapperFactory {
        /**
         * Abstract factory pattern for wrapping an {@link SSLEngine} object. This is useful for NPN/APLN support.
         *
         * @param engine The engine to wrap.
         * @param applicationNegotiator The application level protocol negotiator
         * @param isServer 
    *
  • {@code true} if the engine is for server side of connections
  • *
  • {@code false} if the engine is for client side of connections
  • *
* @return The resulting wrapped engine. This may just be {@code engine}. */ SSLEngine wrapSslEngine( SSLEngine engine, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer); } abstract class AllocatorAwareSslEngineWrapperFactory implements SslEngineWrapperFactory { @Override public final SSLEngine wrapSslEngine(SSLEngine engine, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer) { // Allocator is only used by Conscrypt engine, which require off-heap buffers. BufferAllocator alloc = DefaultBufferAllocators.offHeapAllocator(); return wrapSslEngine(engine, alloc, applicationNegotiator, isServer); } /** * Abstract factory pattern for wrapping an {@link SSLEngine} object. This is useful for NPN/APLN support. * * @param engine The engine to wrap. * @param alloc the buffer allocator. * @param applicationNegotiator The application level protocol negotiator * @param isServer
    *
  • {@code true} if the engine is for server side of connections
  • *
  • {@code false} if the engine is for client side of connections
  • *
* @return The resulting wrapped engine. This may just be {@code engine}. */ abstract SSLEngine wrapSslEngine(SSLEngine engine, BufferAllocator alloc, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer); } /** * Interface to define the role of an application protocol selector in the SSL handshake process. Either * {@link ProtocolSelector#unsupported()} OR {@link ProtocolSelector#select(List)} will be called for each SSL * handshake. */ interface ProtocolSelector { /** * Callback invoked to let the application know that the peer does not support this * {@link ApplicationProtocolNegotiator}. */ void unsupported(); /** * Callback invoked to select the application level protocol from the {@code protocols} provided. * * @param protocols the protocols sent by the protocol advertiser * @return the protocol selected by this {@link ProtocolSelector}. A {@code null} value will indicate the no * protocols were selected but the handshake should not fail. The decision to fail the handshake is left to the * other end negotiating the SSL handshake. * @throws Exception If the {@code protocols} provide warrant failing the SSL handshake with a fatal alert. */ String select(List protocols) throws Exception; } /** * A listener to be notified by which protocol was select by its peer. Either the * {@link ProtocolSelectionListener#unsupported()} OR the {@link ProtocolSelectionListener#selected(String)} method * will be called for each SSL handshake. */ interface ProtocolSelectionListener { /** * Callback invoked to let the application know that the peer does not support this * {@link ApplicationProtocolNegotiator}. */ void unsupported(); /** * Callback invoked to let this application know the protocol chosen by the peer. * * @param protocol the protocol selected by the peer. May be {@code null} or empty as supported by the * application negotiation protocol. * @throws Exception This may be thrown if the selected protocol is not acceptable and the desired behavior is * to fail the handshake with a fatal alert. */ void selected(String protocol) throws Exception; } /** * Factory interface for {@link ProtocolSelector} objects. */ interface ProtocolSelectorFactory { /** * Generate a new instance of {@link ProtocolSelector}. * @param engine The {@link SSLEngine} that the returned {@link ProtocolSelector} will be used to create an * instance for. * @param supportedProtocols The protocols that are supported. * @return A new instance of {@link ProtocolSelector}. */ ProtocolSelector newSelector(SSLEngine engine, Set supportedProtocols); } /** * Factory interface for {@link ProtocolSelectionListener} objects. */ interface ProtocolSelectionListenerFactory { /** * Generate a new instance of {@link ProtocolSelectionListener}. * @param engine The {@link SSLEngine} that the returned {@link ProtocolSelectionListener} will be used to * create an instance for. * @param supportedProtocols The protocols that are supported in preference order. * @return A new instance of {@link ProtocolSelectionListener}. */ ProtocolSelectionListener newListener(SSLEngine engine, List supportedProtocols); } /** * Get the {@link SslEngineWrapperFactory}. */ SslEngineWrapperFactory wrapperFactory(); /** * Get the {@link ProtocolSelectorFactory}. */ ProtocolSelectorFactory protocolSelectorFactory(); /** * Get the {@link ProtocolSelectionListenerFactory}. */ ProtocolSelectionListenerFactory protocolListenerFactory(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy