org.jivesoftware.openfire.spi

Class ConnectionAcceptor

java.lang.Object

org.jivesoftware.openfire.spi.ConnectionAcceptor

Direct Known Subclasses:

LegacyConnectionAcceptor

public abstract class ConnectionAcceptor
extends Object

ConnectionAcceptors are responsible for accepting new (typically socket) connections from peers. The configuration (but not the state) of an instance is intended to be immutable. When configuration changes are needed, an instance needs to be replaced by a new instance.

Author:

Guus der Kinderen, guus.der.kinderen@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionConfiguration	configuration

Constructor Summary

Constructors

Constructor and Description
ConnectionAcceptor(ConnectionConfiguration configuration) Constructs a new instance which will accept new connections based on the provided configuration.

Method Summary

Modifier and Type	Method and Description
abstract boolean	isIdle() Determines if this instance is currently in a state where it is actively serving connections.
abstract void	reconfigure(ConnectionConfiguration configuration) Reloads the acceptor configuration, without causing a disconnect of already established connections.
abstract void	start() Makes the instance start accepting connections.
abstract void	stop() Halts connection acceptation and gracefully releases resources.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected ConnectionConfiguration configuration

Constructor Detail

ConnectionAcceptor

public ConnectionAcceptor(ConnectionConfiguration configuration)

Constructs a new instance which will accept new connections based on the provided configuration. The provided configuration is expected to be immutable. ConnectionAcceptor instances are not expected to handle changes in configuration. When such changes are to be applied, an instance is expected to be replaced. Newly instantiated ConnectionAcceptors will not accept any connections before start() is invoked.

Parameters:

configuration - The configuration for connections to be accepted (cannot be null).

Method Detail

start

public abstract void start()

Makes the instance start accepting connections. An invocation of this method on an instance that is already started should have no effect (to the extend that the instance should continue to accept connections without interruption or configuration changes).

stop

public abstract void stop()

Halts connection acceptation and gracefully releases resources. An invocation of this method on an instance that was not accepting connections should have no effect. Instances of this class do not support configuration changes (see class documentation). As a result, there is no requirement that an instance that is stopped after it was running can successfully be restarted.

isIdle

public abstract boolean isIdle()

Determines if this instance is currently in a state where it is actively serving connections.

Returns:

false when this instance is started and is currently being used to serve connections (otherwise true)

reconfigure

public abstract void reconfigure(ConnectionConfiguration configuration)

Reloads the acceptor configuration, without causing a disconnect of already established connections. A best-effort reload will be attempted. Configuration changes that require a restart of connections, such as the bind-address and port, will not be applied. The configuration that's provided will replace the existing configuration. A restart of the connection acceptor after this method was invoked will apply all configuration changes.

Parameters:

configuration - The configuration for connections to be accepted (cannot be null).