Package org.eclipse.jetty.server

Class AbstractNetworkConnector

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

All Implemented Interfaces:

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

Direct Known Subclasses:

QuicServerConnector, ServerConnector

@ManagedObject("AbstractNetworkConnector")
public abstract class AbstractNetworkConnector
extends AbstractConnector
implements NetworkConnector

An abstract Network Connector.

Extends the AbstractConnector support for the NetworkConnector interface.

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.Container

Container.InheritedListener, Container.Listener

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

Dumpable.DumpableContainer

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

Graceful.Shutdown, Graceful.ThrowingRunnable

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

LifeCycle.Listener

Field Summary

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

LOG

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Constructor	Description
AbstractNetworkConnector(Server server, Executor executor, Scheduler scheduler, ByteBufferPool pool, int acceptors, ConnectionFactory... factories)

Method Summary

Modifier and Type	Method	Description
void	close()	Performs the activities needed to close the network communication (for example, to stop accepting network connections).
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
String	getHost()
int	getLocalPort()
int	getPort()
protected boolean	handleAcceptFailure(Throwable ex)
void	open()	Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).
void	setHost(String host)
void	setPort(int port)
CompletableFuture<Void>	shutdown()	Shutdown the component.
String	toString()

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

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

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

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

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

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, 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, getTransport

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

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

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

dump, dump, dumpSelf

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

isDumpable

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

isShutdown

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

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

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

isOpen

Constructor Details

AbstractNetworkConnector

public AbstractNetworkConnector(Server server,
 Executor executor,
 Scheduler scheduler,
 ByteBufferPool pool,
 int acceptors,
 ConnectionFactory... factories)

Method Details

setHost

public void setHost(String host)

getHost

@ManagedAttribute("The network interface this connector binds to as an IP address or a hostname.  If null or 0.0.0.0, then bind to all interfaces.")
public String getHost()

Specified by:

getHost in interface NetworkConnector

Returns:

The hostname representing the interface to which this connector will bind, or null for all interfaces.

setPort

public void setPort(int port)

getPort

@ManagedAttribute("Port this connector listens on. If set the 0 a random port is assigned which may be obtained with getLocalPort()")
public int getPort()

Specified by:

getPort in interface NetworkConnector

Returns:

The configured port for the connector or 0 if any available port may be used.

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface NetworkConnector

Returns:

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

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class AbstractConnector

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: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class AbstractConnector

Throws:

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

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

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 AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface NetworkConnector

shutdown

public CompletableFuture<Void> shutdown()

Description copied from interface: Graceful

Shutdown the component. When this method returns, the component should not accept any new load.

Specified by:

shutdown in interface Graceful

Overrides:

shutdown in class AbstractConnector

Returns:

A future that is completed once all load on the component is completed

handleAcceptFailure

protected boolean handleAcceptFailure(Throwable ex)

Overrides:

handleAcceptFailure in class AbstractConnector

toString

public String toString()

Overrides:

toString in class AbstractConnector