org.apache.tomcat.util.net

Class NioServerSocketChannelFactory

java.lang.Object

org.apache.tomcat.util.net.NioServerSocketChannelFactory

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DefaultNioServerSocketChannelFactory

public abstract class NioServerSocketChannelFactory
extends Object
implements Cloneable

NioServerSocketChannelFactory Created on Jan 3, 2012 at 12:08:30 PM

Author:

Nabil Benothman

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable<String,Object>	attributes
protected AsynchronousChannelGroup	threadGroup

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NioServerSocketChannelFactory() Create a new instance of NioServerSocketChannelFactory
protected	NioServerSocketChannelFactory(AsynchronousChannelGroup threadGroup) Create a new instance of NioServerSocketChannelFactory

Method Summary

Modifier and Type	Method and Description
abstract NioChannel	acceptChannel(AsynchronousServerSocketChannel listener) Wrapper function for accept().
static NioServerSocketChannelFactory	createSecureFactory(AsynchronousChannelGroup threadGroup) Create and configure a new secure NioServerSocketChannelFactory instance
AsynchronousServerSocketChannel	createServerChannel(int port) Returns a server socket channel which uses all network interfaces on the host, and is bound to a the specified port.
AsynchronousServerSocketChannel	createServerChannel(int port, int backlog) Returns a server socket which uses all network interfaces on the host, is bound to a the specified port, and uses the specified connection backlog.
abstract AsynchronousServerSocketChannel	createServerChannel(int port, int backlog, InetAddress ifAddress, boolean reuseAddress) Returns a server socket channel which uses only the specified network interface on the local host, is bound to a the specified port, and uses the specified connection backlog.
static NioServerSocketChannelFactory	createServerSocketChannelFactory(AsynchronousChannelGroup threadGroup, boolean secure) Create a new NioServerSocketChannelFactory instance
abstract void	destroy() Destroy the factory
static NioServerSocketChannelFactory	getDefault() Returns a copy of the environment's default socket factory.
static NioServerSocketChannelFactory	getDefault(AsynchronousChannelGroup threadGroup) Returns a copy of the environment's default socket factory.
abstract void	handshake(NioChannel channel) Extra function to initiate the handshake.
abstract void	init() Initialize the factory
abstract void	initChannel(NioChannel channel) Initialize the specified NioChannel
protected AsynchronousServerSocketChannel	open() Open an AsynchronousServerSocketChannel
void	setAttribute(String name, Object value) General mechanism to pass attributes from the ServerConnector to the socket factory.

Methods inherited from class java.lang.Object

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

Field Detail

attributes

protected Hashtable<String,Object> attributes

threadGroup

protected AsynchronousChannelGroup threadGroup

Constructor Detail

NioServerSocketChannelFactory

protected NioServerSocketChannelFactory()

Create a new instance of NioServerSocketChannelFactory

NioServerSocketChannelFactory

protected NioServerSocketChannelFactory(AsynchronousChannelGroup threadGroup)

Create a new instance of NioServerSocketChannelFactory

Parameters:

threadGroup -

Method Detail

init

public abstract void init()
                   throws IOException

Initialize the factory

Throws:

IOException

destroy

public abstract void destroy()
                      throws IOException

Destroy the factory

Throws:

IOException

setAttribute

public void setAttribute(String name,
                         Object value)

General mechanism to pass attributes from the ServerConnector to the socket factory. Note that the "preferred" mechanism is to use bean setters and explicit methods, but this allows easy configuration via server.xml or simple Properties

Parameters:

name -

value -

getDefault

public static NioServerSocketChannelFactory getDefault()

Returns a copy of the environment's default socket factory.

Returns:

the default factory

getDefault

public static NioServerSocketChannelFactory getDefault(AsynchronousChannelGroup threadGroup)

Returns a copy of the environment's default socket factory.

Parameters:

threadGroup -

Returns:

the default factory

createSecureFactory

public static NioServerSocketChannelFactory createSecureFactory(AsynchronousChannelGroup threadGroup)

Create and configure a new secure NioServerSocketChannelFactory instance

Parameters:

threadGroup - the thread group that will be used with the server sockets

Returns:

a new secure NioServerSocketChannelFactory instance

createServerSocketChannelFactory

public static NioServerSocketChannelFactory createServerSocketChannelFactory(AsynchronousChannelGroup threadGroup,
                                                                             boolean secure)

Create a new NioServerSocketChannelFactory instance

Parameters:

threadGroup - the thread group that will be used with the server sockets

secure -

Returns:

a new secure NioServerSocketChannelFactory instance

createServerChannel

public AsynchronousServerSocketChannel createServerChannel(int port)
                                                    throws IOException

Returns a server socket channel which uses all network interfaces on the host, and is bound to a the specified port. The socket is configured with the socket options (such as accept timeout) given to this factory.

Parameters:

port - the port to listen to

Returns:

an instance of AsynchronousServerSocketChannel

Throws:

IOException - for networking errors

createServerChannel

public AsynchronousServerSocketChannel createServerChannel(int port,
                                                           int backlog)
                                                    throws IOException

Returns a server socket which uses all network interfaces on the host, is bound to a the specified port, and uses the specified connection backlog. The socket is configured with the socket options (such as accept timeout) given to this factory.

Parameters:

port - the port to listen to

backlog - how many connections are queued

Returns:

an instance of AsynchronousServerSocketChannel

Throws:

IOException - for networking errors

createServerChannel

public abstract AsynchronousServerSocketChannel createServerChannel(int port,
                                                                    int backlog,
                                                                    InetAddress ifAddress,
                                                                    boolean reuseAddress)
                                                             throws IOException

Returns a server socket channel which uses only the specified network interface on the local host, is bound to a the specified port, and uses the specified connection backlog. The socket is configured with the socket options (such as accept timeout) given to this factory.

Parameters:

port - the port to listen to

backlog - how many connections are queued

ifAddress - the network interface address to use

reuseAddress -

Returns:

an instance of AsynchronousServerSocketChannel

Throws:

IOException - for networking errors

initChannel

public abstract void initChannel(NioChannel channel)
                          throws Exception

Initialize the specified NioChannel

Parameters:

channel - The channel to be initialized

Throws:

Exception

acceptChannel

public abstract NioChannel acceptChannel(AsynchronousServerSocketChannel listener)
                                  throws IOException

Wrapper function for accept(). This allows us to trap and translate exceptions if necessary

Parameters:

listener - The Asynchronous Server Socket channel that will accept a new connection

Returns:

an instance of NioChannel representing the new connection

Throws:

IOException

handshake

public abstract void handshake(NioChannel channel)
                        throws IOException

Extra function to initiate the handshake. Sometimes necessary for SSL

Parameters:

channel -

Throws:

IOException

open

protected AsynchronousServerSocketChannel open()
                                        throws IOException

Open an AsynchronousServerSocketChannel

Returns:

an instance of AsynchronousServerSocketChannel

Throws:

IOException