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 default number of selectors is equal to half of 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/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

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

Graceful.Shutdown

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Constructor and Description
ServerConnector(Server server) Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.
ServerConnector(Server server, ConnectionFactory... factories) Construct a Server Connector with the passed Connection factories.
ServerConnector(Server server, Executor executor, Scheduler scheduler, ByteBufferPool bufferPool, int acceptors, int selectors, ConnectionFactory... factories)
ServerConnector(Server server, int acceptors, int selectors) Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.
ServerConnector(Server server, int acceptors, int selectors, ConnectionFactory... factories) Construct a ServerConnector with a private instance of HttpConnectionFactory as the only factory.
ServerConnector(Server server, int acceptors, int selectors, SslContextFactory sslContextFactory) Construct a ServerConnector with a private instance of HttpConnectionFactory as the primary protocol
ServerConnector(Server server, SslContextFactory sslContextFactory) Construct a ServerConnector with a private instance of HttpConnectionFactory as the primary protocol
ServerConnector(Server server, SslContextFactory sslContextFactory, ConnectionFactory... factories)

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).
int	getAcceptQueueSize()
int	getLocalPort()
boolean	getReuseAddress()
SelectorManager	getSelectorManager()
int	getSoLingerTime() Deprecated. don't use as socket close linger time has undefined behavior for non-blocking sockets
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)
void	open() Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).
void	open(ServerSocketChannel acceptChannel) Open the connector using the passed ServerSocketChannel.
void	setAccepting(boolean accepting)
void	setAcceptQueueSize(int acceptQueueSize)
void	setInheritChannel(boolean inheritChannel) Sets whether this connector uses a channel inherited from the JVM.
void	setReuseAddress(boolean reuseAddress)
void	setSoLingerTime(int lingerTime) Deprecated. don't use as socket close linger time has undefined behavior for non-blocking sockets

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

getHost, getPort, setHost, setPort, shutdown, toString

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

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

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

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, 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

equals, 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, start, stop, stop

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

addBean, addBean, addEventListener, getBean, getBeans, getBeans, getContainedBeans, isManaged, manage, removeBean, removeEventListener, unmanage

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

isShutdown

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

dump, dump, dump, dumpContainer, dumpIterable, dumpMapEntries, dumpObject, dumpObjects, dumpSelf, named

Constructor Detail

ServerConnector

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

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)

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)

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)

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)

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)

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)

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)

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

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.

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.

See Also:

openAcceptChannel()

open

public void open(ServerSocketChannel acceptChannel)
          throws IOException

Open the connector using the passed ServerSocketChannel. This open method can be called before starting the connector to pass it a ServerSocketChannel that will be used instead of one returned from openAcceptChannel()

Parameters:

acceptChannel - the channel to use

Throws:

IOException - if the server channel is not bound

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()

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

Throws:

IOException

getSelectorManager

@ManagedAttribute(value="The Selector Manager")
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.

getSoLingerTime

@ManagedAttribute(value="Socket close linger time. Deprecated, always returns -1",
                  readonly=true)
 @Deprecated
public int getSoLingerTime()

Deprecated. don't use as socket close linger time has undefined behavior for non-blocking sockets

Returns the socket close linger time.

Returns:

-1 as the socket close linger time is always disabled.

See Also:

StandardSocketOptions.SO_LINGER

setSoLingerTime

@Deprecated
public void setSoLingerTime(int lingerTime)

Deprecated. don't use as socket close linger time has undefined behavior for non-blocking sockets

Parameters:

lingerTime - the socket close linger time; use -1 to disable.

See Also:

StandardSocketOptions.SO_LINGER

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)

setAccepting

public void setAccepting(boolean accepting)

Overrides:

setAccepting in class AbstractConnector