Package org.eclipse.jetty.server

Class ConnectionLimit

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.server.ConnectionLimit

All Implemented Interfaces:

EventListener, Connection.Listener, SelectorManager.AcceptListener, SelectorManager.SelectorManagerListener, LifeCycle

@ManagedObject
public class ConnectionLimit
extends AbstractLifeCycle
implements Connection.Listener, SelectorManager.AcceptListener

A Listener that limits the number of Connections.

This listener applies a limit to the number of connections, which when exceeded results in a call to AbstractConnector.setAccepting(boolean) to prevent further connections being received. This listener can be applied to an entire Server or to a specific Connector by adding it via Container.addBean(Object).

When the number of connections is exceeded, the idle timeout of existing connections is changed with the value configured in this listener (typically a shorter value).

Usage:

   Server server = new Server();
   server.addBean(new ConnectionLimit(5000,server));
   ...
   server.start();
 

See Also:

• LowResourceMonitor
• Connection.Listener
• SelectorManager.AcceptListener

Nested Class Summary

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

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

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

LifeCycle.Listener

Field Summary

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
ConnectionLimit(int maxConnections, Connector... connectors)
ConnectionLimit(int maxConnections, Server server)

Method Summary

Modifier and Type	Method	Description
protected void	doStart()	Method to override to start the lifecycle
protected void	doStop()	Method to override to stop the lifecycle
int	getConnections()
long	getIdleTimeout()
int	getMaxConnections()
int	getPendingConnections()
protected void	limit()
void	onAccepted(SelectableChannel channel)	Called after the accepted channel has been allocated an EndPoint and associated Connection, and after the onOpen notifications have been called on both endPoint and connection.
void	onAcceptFailed(SelectableChannel channel, Throwable cause)	Called if the processing of the accepted channel fails prior to calling SelectorManager.AcceptListener.onAccepted(SelectableChannel).
void	onAccepting(SelectableChannel channel)	Called immediately after a new SelectableChannel is accepted, but before it has been submitted to the SelectorManager.
void	onClosed(Connection connection)
void	onOpened(Connection connection)
void	setIdleTimeout(long idleTimeout)	Sets the endpoint idle timeout in ms to apply when the connection limit is reached.
void	setMaxConnections(int max)
protected void	unlimit()

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

addEventListener, getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, setEventListeners, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectionLimit

public ConnectionLimit(@Name("maxConnections")
 int maxConnections,
 @Name("server")
 Server server)

ConnectionLimit

public ConnectionLimit(@Name("maxConnections")
 int maxConnections,
 @Name("connectors")
 Connector... connectors)

Method Details

getIdleTimeout

@ManagedAttribute("The endpoint idle timeout in ms to apply when the connection limit is reached")
public long getIdleTimeout()

Returns:

the endpoint idle timeout in ms to apply when the connection limit is reached

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Sets the endpoint idle timeout in ms to apply when the connection limit is reached.

A value less than or equal to zero will not change the existing idle timeout.

Parameters:

idleTimeout - the endpoint idle timeout in ms to apply when the connection limit is reached

getMaxConnections

@ManagedAttribute("The maximum number of connections allowed")
public int getMaxConnections()

setMaxConnections

public void setMaxConnections(int max)

getConnections

@ManagedAttribute(value="The current number of connections",
                  readonly=true)
public int getConnections()

getPendingConnections

@ManagedAttribute(value="The current number of pending connections",
                  readonly=true)
public int getPendingConnections()

doStart

protected void doStart()
                throws Exception

Description copied from class: AbstractLifeCycle

Method to override to start the lifecycle

Overrides:

doStart in class AbstractLifeCycle

Throws:

AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.

Exception - If there was a problem starting. Will cause a transition to FAILED state

doStop

protected void doStop()
               throws Exception

Description copied from class: AbstractLifeCycle

Method to override to stop the lifecycle

Overrides:

doStop in class AbstractLifeCycle

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

limit

protected void limit()

unlimit

protected void unlimit()

onAccepting

public void onAccepting(SelectableChannel channel)

Description copied from interface: SelectorManager.AcceptListener

Called immediately after a new SelectableChannel is accepted, but before it has been submitted to the SelectorManager.

Specified by:

onAccepting in interface SelectorManager.AcceptListener

Parameters:

channel - the accepted channel

onAcceptFailed

public void onAcceptFailed(SelectableChannel channel,
 Throwable cause)

Description copied from interface: SelectorManager.AcceptListener

Called if the processing of the accepted channel fails prior to calling SelectorManager.AcceptListener.onAccepted(SelectableChannel).

Specified by:

onAcceptFailed in interface SelectorManager.AcceptListener

Parameters:

channel - the accepted channel

cause - the cause of the failure

onAccepted

public void onAccepted(SelectableChannel channel)

Description copied from interface: SelectorManager.AcceptListener

Called after the accepted channel has been allocated an EndPoint and associated Connection, and after the onOpen notifications have been called on both endPoint and connection.

Specified by:

onAccepted in interface SelectorManager.AcceptListener

Parameters:

channel - the accepted channel

onOpened

public void onOpened(Connection connection)

Specified by:

onOpened in interface Connection.Listener

onClosed

public void onClosed(Connection connection)

Specified by:

onClosed in interface Connection.Listener