org.apache.james.protocols.lib.netty

Class AbstractConfigurableAsyncServer

java.lang.Object

org.apache.james.protocols.netty.AbstractAsyncServer

org.apache.james.protocols.lib.netty.AbstractConfigurableAsyncServer

All Implemented Interfaces:

Configurable, LogEnabled, org.apache.james.protocols.api.ProtocolServer, ServerMBean

Direct Known Subclasses:

AbstractProtocolAsyncServer, IMAPServer

public abstract class AbstractConfigurableAsyncServer
extends org.apache.james.protocols.netty.AbstractAsyncServer
implements LogEnabled, Configurable, ServerMBean

Abstract base class for Servers for all James Servers

Field Summary

Fields

Modifier and Type	Field and Description
protected int	connectionLimit
protected int	connPerIP
static int	DEFAULT_BACKLOG The default value for the connection backlog.
static int	DEFAULT_MAX_EXECUTOR_COUNT
static int	DEFAULT_TIMEOUT The default value for the connection timeout.
static String	HELLO_NAME The name of the parameter defining the service hello name.
protected String	jmxName

Fields inherited from class org.apache.james.protocols.netty.AbstractAsyncServer

DEFAULT_IO_WORKER_COUNT

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurableAsyncServer()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.commons.configuration.HierarchicalConfiguration config) Configure the object.
protected void	configureBootstrap(org.jboss.netty.bootstrap.ServerBootstrap bootstrap)
protected void	configureHelloName(org.apache.commons.configuration.Configuration handlerConfiguration) Configure the helloName for the given Configuration
protected Executor	createBossExecutor()
protected abstract org.jboss.netty.channel.ChannelUpstreamHandler	createCoreHandler()
protected org.jboss.netty.handler.execution.ExecutionHandler	createExecutionHander() Create a new ExecutionHandler which is used to execute IO-Bound handlers
protected org.jboss.netty.channel.ChannelPipelineFactory	createPipelineFactory(org.jboss.netty.channel.group.ChannelGroup group)
protected Executor	createWorkerExecutor()
void	destroy()
protected void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
String[]	getBoundAddresses()
protected ConnectionCountHandler	getConnectionCountHandler()
int	getCurrentConnections() Return the current connection count
protected abstract String	getDefaultJMXName() Return the default name of the the server in JMX if none is configured via "jmxname" in the configuration
protected abstract int	getDefaultPort() Return the default port which will get used for this server if non is specify in the configuration
protected String[]	getEnabledCipherSuites()
protected org.apache.james.protocols.api.Encryption	getEncryption()
protected org.jboss.netty.handler.execution.ExecutionHandler	getExecutionHandler() Return the ExecutionHandler or null if non should be used.
protected FileSystem	getFileSystem() Return the FileSystem
long	getHandledConnections() Return the count of handled connections till startup
String	getHelloName() Return helloName for this server
protected org.slf4j.Logger	getLogger() Return the logger
int	getMaximumConcurrentConnections() Return the maximum allowed concurrent connections for the server
String	getSocketType() Return the socket type.
boolean	getStartTLSSupported() Return true if startTLS is supported by the server
protected String	getThreadPoolJMXPath()
void	init()
boolean	isEnabled() Return if the server is enabled by the configuration
boolean	isStarted() Return true if the server is started, which basicly means it is bound to a address and accept connections
protected void	postDestroy()
protected void	preInit() This method is called on init of the Server.
protected void	registerMBean()
void	setFileSystem(FileSystem filesystem)
void	setLog(org.slf4j.Logger logger) Sets the service log.
boolean	start() Start the server
boolean	stop() Stop the server
protected void	unregisterMBean()

Methods inherited from class org.apache.james.protocols.netty.AbstractAsyncServer

bind, createSocketChannelFactory, getBacklog, getIoWorkerCount, getListenAddresses, getTimeout, isBound, setBacklog, setIoWorkerCount, setListenAddresses, setTimeout, unbind

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.james.protocols.lib.jmx.ServerMBean

getServiceType, getTimeout

Field Detail

DEFAULT_BACKLOG

public static final int DEFAULT_BACKLOG

The default value for the connection backlog.

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

The default value for the connection timeout.

See Also:

Constant Field Values

HELLO_NAME

public static final String HELLO_NAME

The name of the parameter defining the service hello name.

See Also:

Constant Field Values

DEFAULT_MAX_EXECUTOR_COUNT

public static final int DEFAULT_MAX_EXECUTOR_COUNT

See Also:

Constant Field Values

connPerIP

protected int connPerIP

connectionLimit

protected int connectionLimit

jmxName

protected String jmxName

Constructor Detail

AbstractConfigurableAsyncServer

public AbstractConfigurableAsyncServer()

Method Detail

setFileSystem

public final void setFileSystem(FileSystem filesystem)

setLog

public final void setLog(org.slf4j.Logger logger)

Description copied from interface: LogEnabled

Sets the service log.

Specified by:

setLog in interface LogEnabled

Parameters:

logger - not null

See Also:

LogEnabled.setLog(org.slf4j.Logger)

registerMBean

protected void registerMBean()

unregisterMBean

protected void unregisterMBean()

configure

public final void configure(org.apache.commons.configuration.HierarchicalConfiguration config)
                     throws org.apache.commons.configuration.ConfigurationException

Description copied from interface: Configurable

Configure the object. Be aware that no services are injected when this is called. If you need to access injected stuff do it in a method annotated with @PostConstruct

Specified by:

configure in interface Configurable

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

#configure(org.apache.commons.configuration.HierarchicalConfiguration)

init

@PostConstruct
public final void init()
                throws Exception

Throws:

Exception

destroy

@PreDestroy
public final void destroy()

postDestroy

protected void postDestroy()

preInit

protected void preInit()
                throws Exception

This method is called on init of the Server. Subclasses should override this method to init stuff

Throws:

Exception

doConfigure

protected void doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
                    throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

getFileSystem

protected FileSystem getFileSystem()

Return the FileSystem

Returns:

fileSystem

configureHelloName

protected void configureHelloName(org.apache.commons.configuration.Configuration handlerConfiguration)
                           throws org.apache.commons.configuration.ConfigurationException

Configure the helloName for the given Configuration

Parameters:

handlerConfiguration -

Throws:

org.apache.commons.configuration.ConfigurationException

getLogger

protected org.slf4j.Logger getLogger()

Return the logger

Returns:

logger

isEnabled

public boolean isEnabled()

Return if the server is enabled by the configuration

Specified by:

isEnabled in interface ServerMBean

Returns:

enabled

getHelloName

public String getHelloName()

Return helloName for this server

Returns:

helloName

getEncryption

protected org.apache.james.protocols.api.Encryption getEncryption()

getDefaultPort

protected abstract int getDefaultPort()

Return the default port which will get used for this server if non is specify in the configuration

Returns:

port

getSocketType

public String getSocketType()

Return the socket type. The Socket type can be secure or plain

Specified by:

getSocketType in interface ServerMBean

Returns:

the socket type ('plain' or 'secure')

getStartTLSSupported

public boolean getStartTLSSupported()

Description copied from interface: ServerMBean

Return true if startTLS is supported by the server

Specified by:

getStartTLSSupported in interface ServerMBean

Returns:

startTLS

See Also:

ServerMBean.getStartTLSSupported()

getMaximumConcurrentConnections

public int getMaximumConcurrentConnections()

Description copied from interface: ServerMBean

Return the maximum allowed concurrent connections for the server

Specified by:

getMaximumConcurrentConnections in interface ServerMBean

Returns:

maxConcurrentConnections

See Also:

ServerMBean.getMaximumConcurrentConnections()

getThreadPoolJMXPath

protected String getThreadPoolJMXPath()

createBossExecutor

protected Executor createBossExecutor()

Overrides:

createBossExecutor in class org.apache.james.protocols.netty.AbstractAsyncServer

createWorkerExecutor

protected Executor createWorkerExecutor()

Overrides:

createWorkerExecutor in class org.apache.james.protocols.netty.AbstractAsyncServer

getDefaultJMXName

protected abstract String getDefaultJMXName()

Return the default name of the the server in JMX if none is configured via "jmxname" in the configuration

Returns:

defaultJmxName

getEnabledCipherSuites

protected String[] getEnabledCipherSuites()

isStarted

public boolean isStarted()

Description copied from interface: ServerMBean

Return true if the server is started, which basicly means it is bound to a address and accept connections

Specified by:

isStarted in interface ServerMBean

Returns:

started

See Also:

ServerMBean.isStarted()

start

public boolean start()

Description copied from interface: ServerMBean

Start the server

Specified by:

start in interface ServerMBean

Returns:

start

See Also:

ServerMBean.start()

stop

public boolean stop()

Description copied from interface: ServerMBean

Stop the server

Specified by:

stop in interface ServerMBean

Returns:

stop

See Also:

ServerMBean.stop()

getHandledConnections

public long getHandledConnections()

Description copied from interface: ServerMBean

Return the count of handled connections till startup

Specified by:

getHandledConnections in interface ServerMBean

Returns:

handledConnections

See Also:

ServerMBean.getHandledConnections()

getCurrentConnections

public int getCurrentConnections()

Description copied from interface: ServerMBean

Return the current connection count

Specified by:

getCurrentConnections in interface ServerMBean

Returns:

currentConnection

See Also:

ServerMBean.getCurrentConnections()

getConnectionCountHandler

protected ConnectionCountHandler getConnectionCountHandler()

getBoundAddresses

public String[] getBoundAddresses()

Specified by:

getBoundAddresses in interface ServerMBean

See Also:

ServerMBean.getBoundAddresses()

configureBootstrap

protected void configureBootstrap(org.jboss.netty.bootstrap.ServerBootstrap bootstrap)

Overrides:

configureBootstrap in class org.apache.james.protocols.netty.AbstractAsyncServer

createExecutionHander

protected org.jboss.netty.handler.execution.ExecutionHandler createExecutionHander()

Create a new ExecutionHandler which is used to execute IO-Bound handlers

Returns:

ehandler

getExecutionHandler

protected org.jboss.netty.handler.execution.ExecutionHandler getExecutionHandler()

Return the ExecutionHandler or null if non should be used. Be sure you call createExecutionHander() before

Returns:

ehandler

createCoreHandler

protected abstract org.jboss.netty.channel.ChannelUpstreamHandler createCoreHandler()

createPipelineFactory

protected org.jboss.netty.channel.ChannelPipelineFactory createPipelineFactory(org.jboss.netty.channel.group.ChannelGroup group)

Specified by:

createPipelineFactory in class org.apache.james.protocols.netty.AbstractAsyncServer