org.eclipse.jetty.server

Class ServerConnector

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.AbstractConnector

org.eclipse.jetty.server.AbstractNetworkConnector

org.eclipse.jetty.server.ServerConnector

All Implemented Interfaces:

Closeable, AutoCloseable, Connector, NetworkConnector, Container, Destroyable, Dumpable, Graceful, LifeCycle

Direct Known Subclasses:

NetworkTrafficServerConnector

@ManagedObject(value="HTTP connector using NIO ByteChannels and Selectors")
public class ServerConnector
extends AbstractNetworkConnector

This Connector implementation is the primary connector for the Jetty server over TCP/IP. By the use of various ConnectionFactory instances it is able to accept connections for HTTP, HTTP/2 and WebSocket, either directly or over SSL.

The connector is a fully asynchronous NIO based implementation that by default will use all the commons services (eg Executor, Scheduler) of the passed Server instance, but all services may also be constructor injected into the connector so that it may operate with dedicated or otherwise shared services.

Connection Factories

Various convenience constructors are provided to assist with common configurations of ConnectionFactories, whose generic use is described in AbstractConnector. If no connection factories are passed, then the connector will default to use a HttpConnectionFactory. If an non null SslContextFactory instance is passed, then this used to instantiate a SslConnectionFactory which is prepended to the other passed or default factories.

Selectors

The connector will use the Executor service to execute a number of Selector Tasks, which are implemented to each use a NIO Selector instance to asynchronously schedule a set of accepted connections. It is the selector thread that will call the Callback instances passed in the EndPoint.fillInterested(Callback) or EndPoint.write(Callback, java.nio.ByteBuffer...) methods. It is expected that these callbacks may do some non-blocking IO work, but will always dispatch to the Executor service any blocking, long running or application tasks.

The default number of selectors is equal to the number of processors available to the JVM, which should allow optimal performance even if all the connections used are performing significant non-blocking work in the callback tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ServerConnector.ServerConnectorManager

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.server.AbstractConnector

LOG

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
ServerConnector(Server server) HTTP Server Connection.
ServerConnector(Server server, ConnectionFactory... factories) Generic Server Connection with default configuration.
ServerConnector(Server server, Executor executor, Scheduler scheduler, ByteBufferPool bufferPool, int acceptors, int selectors, ConnectionFactory... factories) Generic Server Connection.
ServerConnector(Server server, int acceptors, int selectors) HTTP Server Connection.
ServerConnector(Server server, int acceptors, int selectors, ConnectionFactory... factories) HTTP Server Connection.
ServerConnector(Server server, int acceptors, int selectors, SslContextFactory sslContextFactory) HTTP Server Connection.
ServerConnector(Server server, SslContextFactory sslContextFactory) HTTP Server Connection.
ServerConnector(Server server, SslContextFactory sslContextFactory, ConnectionFactory... factories) Generic SSL Server Connection.

Method Summary

Modifier and Type	Method and Description
void	accept(int acceptorID)
void	close() Performs the activities needed to close the network communication (for example, to stop accepting network connections).
protected void	configure(Socket socket)
protected void	doStart()
int	getAcceptQueueSize()
int	getLocalPort()
boolean	getReuseAddress()
SelectorManager	getSelectorManager()
int	getSelectorPriorityDelta() Deprecated. not implemented
int	getSoLingerTime()
Object	getTransport()
boolean	isInheritChannel()
boolean	isOpen() A Connector may be opened and not started (to reserve a port) or closed and running (to allow graceful shutdown of existing connections)
protected SelectChannelEndPoint	newEndPoint(SocketChannel channel, ManagedSelector selectSet, SelectionKey key)
protected SelectorManager	newSelectorManager(Executor executor, Scheduler scheduler, int selectors)
void	open() Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).
void	setAcceptQueueSize(int acceptQueueSize)
void	setInheritChannel(boolean inheritChannel) Sets whether this connector uses a channel inherited from the JVM.
void	setReuseAddress(boolean reuseAddress)
void	setSelectorPriorityDelta(int selectorPriorityDelta) Deprecated. not implemented
void	setSoLingerTime(int lingerTime)
Future<Void>	shutdown()

Methods inherited from class org.eclipse.jetty.server.AbstractNetworkConnector

doStop, getHost, getPort, isAccepting, setHost, setPort, toString

Methods inherited from class org.eclipse.jetty.server.AbstractConnector

addConnectionFactory, addFirstConnectionFactory, addIfAbsentConnectionFactory, clearConnectionFactories, getAcceptorPriorityDelta, getAcceptors, getByteBufferPool, getConnectedEndPoints, getConnectionFactories, getConnectionFactory, getConnectionFactory, getDefaultConnectionFactory, getDefaultProtocol, getExecutor, getIdleTimeout, getName, getProtocols, getScheduler, getServer, interruptAcceptors, join, join, onEndPointClosed, onEndPointOpened, removeConnectionFactory, setAcceptorPriorityDelta, setConnectionFactories, setDefaultProtocol, setIdleTimeout, setName

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.server.Connector

getByteBufferPool, getConnectedEndPoints, getConnectionFactories, getConnectionFactory, getConnectionFactory, getDefaultConnectionFactory, getExecutor, getIdleTimeout, getName, getProtocols, getScheduler, getServer

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dump

Constructor Detail

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server)

HTTP Server Connection.

Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.

Parameters:

server - The Server this connector will accept connection for.

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server,
                       @Name(value="acceptors")
                       int acceptors,
                       @Name(value="selectors")
                       int selectors)

HTTP Server Connection.

Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.

Parameters:

server - The Server this connector will accept connection for.

acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.

selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server,
                       @Name(value="acceptors")
                       int acceptors,
                       @Name(value="selectors")
                       int selectors,
                       @Name(value="factories")
                       ConnectionFactory... factories)

HTTP Server Connection.

Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.

Parameters:

server - The Server this connector will accept connection for.

acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.

selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

factories - Zero or more ConnectionFactory instances used to create and configure connections.

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server,
                       @Name(value="factories")
                       ConnectionFactory... factories)

Generic Server Connection with default configuration.

Construct a Server Connector with the passed Connection factories.

Parameters:

server - The Server this connector will accept connection for.

factories - Zero or more ConnectionFactory instances used to create and configure connections.

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server,
                       @Name(value="sslContextFactory")
                       SslContextFactory sslContextFactory)

HTTP Server Connection.

Construct a ServerConnector with a private instance of HttpConnectionFactory as the primary protocol

.

Parameters:

server - The Server this connector will accept connection for.

sslContextFactory - If non null, then a SslConnectionFactory is instantiated and prepended to the list of HTTP Connection Factory.

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server,
                       @Name(value="acceptors")
                       int acceptors,
                       @Name(value="selectors")
                       int selectors,
                       @Name(value="sslContextFactory")
                       SslContextFactory sslContextFactory)

HTTP Server Connection.

Construct a ServerConnector with a private instance of HttpConnectionFactory as the primary protocol

.

Parameters:

server - The Server this connector will accept connection for.

sslContextFactory - If non null, then a SslConnectionFactory is instantiated and prepended to the list of HTTP Connection Factory.

acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.

selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server,
                       @Name(value="sslContextFactory")
                       SslContextFactory sslContextFactory,
                       @Name(value="factories")
                       ConnectionFactory... factories)

Generic SSL Server Connection.

Parameters:

server - The Server this connector will accept connection for.

sslContextFactory - If non null, then a SslConnectionFactory is instantiated and prepended to the list of ConnectionFactories, with the first factory being the default protocol for the SslConnectionFactory.

factories - Zero or more ConnectionFactory instances used to create and configure connections.

ServerConnector

public ServerConnector(@Name(value="server")
                       Server server,
                       @Name(value="executor")
                       Executor executor,
                       @Name(value="scheduler")
                       Scheduler scheduler,
                       @Name(value="bufferPool")
                       ByteBufferPool bufferPool,
                       @Name(value="acceptors")
                       int acceptors,
                       @Name(value="selectors")
                       int selectors,
                       @Name(value="factories")
                       ConnectionFactory... factories)

Generic Server Connection.

Parameters:

server - The server this connector will be accept connection for.

executor - An executor used to run tasks for handling requests, acceptors and selectors. If null then use the servers executor

scheduler - A scheduler used to schedule timeouts. If null then use the servers scheduler

bufferPool - A ByteBuffer pool used to allocate buffers. If null then create a private pool with default configuration.

acceptors - the number of acceptor threads to use, or -1 for a default value. Acceptors accept new TCP/IP connections. If 0, then the selector threads are used to accept connections.

selectors - the number of selector threads, or <=0 for a default value. Selectors notice and schedule established connection that can make IO progress.

factories - Zero or more ConnectionFactory instances used to create and configure connections.

Method Detail

newSelectorManager

protected SelectorManager newSelectorManager(Executor executor,
                                             Scheduler scheduler,
                                             int selectors)

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class AbstractNetworkConnector

Throws:

Exception

isOpen

public boolean isOpen()

Description copied from interface: NetworkConnector

A Connector may be opened and not started (to reserve a port) or closed and running (to allow graceful shutdown of existing connections)

Returns:

True if the connector is Open.

getSelectorPriorityDelta

@Deprecated
public int getSelectorPriorityDelta()

Deprecated. not implemented

Returns:

the selector priority delta

setSelectorPriorityDelta

@Deprecated
public void setSelectorPriorityDelta(int selectorPriorityDelta)

Deprecated. not implemented

Parameters:

selectorPriorityDelta - the selector priority delta

isInheritChannel

public boolean isInheritChannel()

Returns:

whether this connector uses a channel inherited from the JVM.

See Also:

System.inheritedChannel()

setInheritChannel

public void setInheritChannel(boolean inheritChannel)

Sets whether this connector uses a channel inherited from the JVM.

If true, the connector first tries to inherit from a channel provided by the system. If there is no inherited channel available, or if the inherited channel is not usable, then it will fall back using ServerSocketChannel.

Use it with xinetd/inetd, to launch an instance of Jetty on demand. The port used to access pages on the Jetty instance is the same as the port used to launch Jetty.

Parameters:

inheritChannel - whether this connector uses a channel inherited from the JVM.

open

public void open()
          throws IOException

Description copied from interface: NetworkConnector

Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).

Specified by:

open in interface NetworkConnector

Overrides:

open in class AbstractNetworkConnector

Throws:

IOException - if this connector cannot be opened

See Also:

NetworkConnector.close()

shutdown

public Future<Void> shutdown()

Specified by:

shutdown in interface Graceful

Overrides:

shutdown in class AbstractNetworkConnector

close

public void close()

Description copied from interface: NetworkConnector

Performs the activities needed to close the network communication (for example, to stop accepting network connections).

Once a connector has been closed, it cannot be opened again without first calling LifeCycle.stop() and it will not be active again until a subsequent call to LifeCycle.start()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NetworkConnector

Overrides:

close in class AbstractNetworkConnector

accept

public void accept(int acceptorID)
            throws IOException

Specified by:

accept in class AbstractConnector

Throws:

IOException

configure

protected void configure(Socket socket)

getSelectorManager

public SelectorManager getSelectorManager()

getTransport

public Object getTransport()

Returns:

the underlying socket, channel, buffer etc. for the connector.

getLocalPort

@ManagedAttribute(value="local port")
public int getLocalPort()

Specified by:

getLocalPort in interface NetworkConnector

Overrides:

getLocalPort in class AbstractNetworkConnector

Returns:

The actual port the connector is listening on, or -1 if it has not been opened, or -2 if it has been closed.

newEndPoint

protected SelectChannelEndPoint newEndPoint(SocketChannel channel,
                                            ManagedSelector selectSet,
                                            SelectionKey key)
                                     throws IOException

Throws:

IOException

getSoLingerTime

@ManagedAttribute(value="TCP/IP solinger time or -1 to disable")
public int getSoLingerTime()

Returns:

the linger time

See Also:

Socket.getSoLinger()

setSoLingerTime

public void setSoLingerTime(int lingerTime)

Parameters:

lingerTime - the linger time. Use -1 to disable.

See Also:

Socket.setSoLinger(boolean, int)

getAcceptQueueSize

@ManagedAttribute(value="Accept Queue size")
public int getAcceptQueueSize()

Returns:

the accept queue size

setAcceptQueueSize

public void setAcceptQueueSize(int acceptQueueSize)

Parameters:

acceptQueueSize - the accept queue size (also known as accept backlog)

getReuseAddress

public boolean getReuseAddress()

Returns:

whether the server socket reuses addresses

See Also:

ServerSocket.getReuseAddress()

setReuseAddress

public void setReuseAddress(boolean reuseAddress)

Parameters:

reuseAddress - whether the server socket reuses addresses

See Also:

ServerSocket.setReuseAddress(boolean)