org.eclipse.jetty.server.ConnectionFactory Maven / Gradle / Ivy

//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.server;

import java.nio.ByteBuffer;
import java.util.List;

import org.eclipse.jetty.http.BadMessageException;
import org.eclipse.jetty.http.HttpFields;
import org.eclipse.jetty.http.MetaData;
import org.eclipse.jetty.io.Connection;
import org.eclipse.jetty.io.EndPoint;

/**
 * A Factory to create {@link Connection} instances for {@link Connector}s.
 * 
 * A Connection factory is responsible for instantiating and configuring a {@link Connection} instance
 * to handle an {@link EndPoint} accepted by a {@link Connector}.
 * 

 * A ConnectionFactory has a protocol name that represents the protocol of the Connections
 * created.  Example of protocol names include:
 * 

 * http
Creates an HTTP connection that can handle multiple versions of HTTP from 0.9 to 1.1
 * h2
Creates an HTTP/2 connection that handles the HTTP/2 protocol
 * SSL-XYZ
Create an SSL connection chained to a connection obtained from a connection factory
 * with a protocol "XYZ".
 * SSL-http
Create an SSL connection chained to an HTTP connection (aka https)
 * SSL-ALPN
Create an SSL connection chained to a ALPN connection, that uses a negotiation with
 * the client to determine the next protocol.
 * 
 */
public interface ConnectionFactory
{
    /**
     * @return A string representing the primary protocol name.
     */
    public String getProtocol();

    /**
     * @return A list of alternative protocol names/versions including the primary protocol.
     */
    public List getProtocols();

    /**
     * Creates a new {@link Connection} with the given parameters
     *
     * @param connector The {@link Connector} creating this connection
     * @param endPoint the {@link EndPoint} associated with the connection
     * @return a new {@link Connection}
     */
    public Connection newConnection(Connector connector, EndPoint endPoint);

    public interface Upgrading extends ConnectionFactory
    {

        /**
         * Create a connection for an upgrade request.
         * This is a variation of {@link #newConnection(Connector, EndPoint)} that can create (and/or customise)
         * a connection for an upgrade request.  Implementations may call {@link #newConnection(Connector, EndPoint)} or
         * may construct the connection instance themselves.
         *
         * @param connector The connector to upgrade for.
         * @param endPoint The endpoint of the connection.
         * @param upgradeRequest The meta data of the upgrade request.
         * @param responseFields The fields to be sent with the 101 response
         * @return Null to indicate that request processing should continue normally without upgrading. A new connection instance to
         * indicate that the upgrade should proceed.
         * @throws BadMessageException Thrown to indicate the upgrade attempt was illegal and that a bad message response should be sent.
         */
        public Connection upgradeConnection(Connector connector, EndPoint endPoint, MetaData.Request upgradeRequest, HttpFields.Mutable responseFields) throws BadMessageException;
    }

    /**
     * Connections created by this factory MUST implement {@link Connection.UpgradeTo}.
     */
    interface Detecting extends ConnectionFactory
    {
        /**
         * The possible outcomes of the {@link #detect(ByteBuffer)} method.
         */
        enum Detection
        {
            /**
             * A {@link Detecting} can work with the given bytes.
             */
            RECOGNIZED,
            /**
             * A {@link Detecting} cannot work with the given bytes.
             */
            NOT_RECOGNIZED,
            /**
             * A {@link Detecting} requires more bytes to make a decision.
             */
            NEED_MORE_BYTES
        }

        /**
         * Check the bytes in the given {@code buffer} to figure out if this {@link Detecting} instance
         * can work with them or not.
         * The {@code buffer} MUST be left untouched by this method: bytes MUST NOT be consumed and MUST NOT be modified.
         * @param buffer the buffer.
         * @return One of:
         * 
         * {@link Detection#RECOGNIZED} if this {@link Detecting} instance can work with the bytes in the buffer
         * {@link Detection#NOT_RECOGNIZED} if this {@link Detecting} instance cannot work with the bytes in the buffer
         * {@link Detection#NEED_MORE_BYTES} if this {@link Detecting} instance requires more bytes to make a decision
         * 
         */
        Detection detect(ByteBuffer buffer);
    }

    /**
     * A ConnectionFactory that can configure the connector.
     */
    interface Configuring extends ConnectionFactory
    {
        /**
         * Called during {@link Connector#start()}.
         * @param connector The connector to configure
         */
        void configure(Connector connector);
    }
}