org.eclipse.jetty.server.ConnectionFactory Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.server;
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 a HTTP connection that can handle multiple versions of HTTP from 0.9 to 1.1
* - spdy/2
- Creates a HTTP connection that handles a specific version of the SPDY 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 a HTTP connection (aka https)
* - SSL-npn
- Create an SSL connection chained to a NPN connection, that uses a negotiation with
* the client to determine the next protocol.
*
*/
public interface ConnectionFactory
{
/* ------------------------------------------------------------ */
/**
* @return A string representing the protocol name.
*/
public String getProtocol();
/**
* 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);
}