Top Description Methods
org.eclipse.jetty.server

public Interface Connector

extends LifeCycle, Container, Graceful
Known Direct Subinterfaces
org.eclipse.jetty.server.NetworkConnector
Known Direct Implementers
org.eclipse.jetty.server.AbstractConnector
Annotations
@ManagedObject:Connector Interface
Imports
java.util.Collection, .List, java.util.concurrent.Executor, org.eclipse.jetty.io.ByteBufferPool, .EndPoint, org.eclipse.jetty.server.handler.ContextHandler, org.eclipse.jetty.util.annotation.ManagedAttribute, .ManagedObject, org.eclipse.jetty.util.component.Container, .Graceful, .LifeCycle, org.eclipse.jetty.util.thread.Scheduler

A Connector accept connections and data from remote peers, and allows applications to send data to remote peers, by setting up the machinery needed to handle such tasks.

Method Summary

Modifier and TypeMethod and Description
public ByteBufferPool

Returns:

the ByteBufferPool to acquire buffers from and release buffers to
getByteBufferPool()

Get the ByteBufferPool to acquire buffers from and release buffers to.

public Collection<EndPoint>

Returns:

immutable collection of connected endpoints
getConnectedEndPoints()

public Collection<ConnectionFactory>
getConnectionFactories()

public ConnectionFactory

Returns:

the ConnectionFactory associated with the protocol name
getConnectionFactory(String
the next protocol
nextProtocol)

public <T> T
getConnectionFactory(Class<T> factoryType)

public ConnectionFactory

Returns:

the default ConnectionFactory associated with the default protocol name
getDefaultConnectionFactory()

Get the default ConnectionFactory associated with the default protocol name.

public Executor

Returns:

the Executor used to submit tasks
getExecutor()

Get the Executor used to submit tasks.

public long

Returns:

the max idle timeout for connections in milliseconds
getIdleTimeout()

public String

Returns:

The connector name or null.
getName()

Get the connector name if set.

public List<String>
getProtocols()

public Scheduler

Returns:

the Scheduler used to schedule tasks
getScheduler()

Get the Scheduler used to schedule tasks.

public Server

Returns:

the Server instance associated with this Connector
getServer()

Get the Server instance associated with this Connector.

public Object

Returns:

the underlying socket, channel, buffer etc. for the connector.
getTransport()

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

Inherited from org.eclipse.jetty.util.component.Container:
addBeanaddBeanaddBeanaddBeanaddEventListenergetBeangetBeansgetBeansgetCachedBeansgetContainedBeansgetEventListenersisManagedmanageremoveBeanremoveBeanremoveEventListenerunmanageunmanage
Inherited from org.eclipse.jetty.util.component.Graceful:
isShutdownshutdownshutdownshutdown
Inherited from org.eclipse.jetty.util.component.LifeCycle:
addEventListenerisFailedisRunningisStartedisStartingisStoppedisStoppingremoveEventListenerstartstartstopstop

Method Detail

getByteBufferPoolback to summary
public ByteBufferPool getByteBufferPool()

Get the ByteBufferPool to acquire buffers from and release buffers to.

Returns:ByteBufferPool

the ByteBufferPool to acquire buffers from and release buffers to

getConnectedEndPointsback to summary
public Collection<EndPoint> getConnectedEndPoints()
Returns:Collection<EndPoint>

immutable collection of connected endpoints

getConnectionFactoriesback to summary
public Collection<ConnectionFactory> getConnectionFactories()
getConnectionFactoryback to summary
public ConnectionFactory getConnectionFactory(String nextProtocol)
Parameters
nextProtocol:String

the next protocol

Returns:ConnectionFactory

the ConnectionFactory associated with the protocol name

getConnectionFactoryback to summary
public <T> T getConnectionFactory(Class<T> factoryType)
getDefaultConnectionFactoryback to summary
public ConnectionFactory getDefaultConnectionFactory()

Get the default ConnectionFactory associated with the default protocol name.

Returns:ConnectionFactory

the default ConnectionFactory associated with the default protocol name

getExecutorback to summary
public Executor getExecutor()

Get the Executor used to submit tasks.

Returns:Executor

the Executor used to submit tasks

getIdleTimeoutback to summary
public long getIdleTimeout()
Returns:long

the max idle timeout for connections in milliseconds

Annotations
@ManagedAttribute:maximum time a connection can be idle before being closed (in ms)
getNameback to summary
public String getName()

Get the connector name if set.

A ContextHandler may be configured with virtual hosts in the form "@connectorName" and will only serve requests from the named connector.

Returns:String

The connector name or null.

getProtocolsback to summary
public List<String> getProtocols()
getSchedulerback to summary
public Scheduler getScheduler()

Get the Scheduler used to schedule tasks.

Returns:Scheduler

the Scheduler used to schedule tasks

getServerback to summary
public Server getServer()

Get the Server instance associated with this Connector.

Returns:Server

the Server instance associated with this Connector

getTransportback to summary
public Object getTransport()

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

Returns:Object

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