SK.gnome.dwarf.mail.pop
Class POPParameters

java.lang.Object
  SK.gnome.dwarf.GenericService
      SK.gnome.dwarf.ParametersService
          SK.gnome.dwarf.mail.pop.POPParameters

All Implemented Interfaces:

SK.gnome.dwarf.Parameters, SK.gnome.dwarf.Reportable, SK.gnome.dwarf.Service

public final class POPParameters

extends SK.gnome.dwarf.ParametersService

Provides the POP3-related parameters.

An instance of this class may be added to the POPServer to provide a set of POP3-related runtime parameters. The parameters are by default available to the server and all its nested services.

Each parameter is represented by a protected field with its setter and getter methods, which can be used to access the parameter from the outside world.

Note that some of the parameters are read-only while others may be modified in runtime either via the server console, or programatically.

Field Summary

protected java.lang.String[]	authMethods The actually available authentication methods.
protected int	clientTimeout Client inactivity timeout.
protected boolean	enableBrokenAUTH Whether to support broken implementations of AUTH command.
protected java.lang.String[]	extensions The actually available POP3 extensions.
protected boolean	checkACL Whether to check the Access Control List.
protected boolean	insecureLoginDisabled Whether to allow the transfer of cleartext passwords via insecure connections.
protected int	loginDelay Default login delay.
protected boolean	sendServerInfo Enables or disables exposing of the server name and version to the client.
protected boolean	updateACL Whether to automatically update the Access Control List.

Fields inherited from class SK.gnome.dwarf.GenericService

initParameters, parent

Fields inherited from interface SK.gnome.dwarf.Service

INITIALIZED, LOG_DEBUG, LOG_ERROR, LOG_FATAL, LOG_INFO, LOG_TRACE, LOG_WARN, LOG_XFER, SHUTDOWN, STARTED, STOPPED

Constructor Summary

POPParameters(java.lang.String name)
Creates a new POPParameters.

Method Summary

boolean	containsAuthMethod(java.lang.String method)
boolean	containsExtension(java.lang.String extension)
java.lang.String[]	getAllAuthMethods()
java.lang.String[]	getAllExtensions()
java.lang.String[]	getAuthMethods()
int	getClientTimeout()
boolean	getEnableBrokenAUTH()
java.lang.String[]	getExtensions()
boolean	getCheckACL()
boolean	getInsecureLoginDisabled()
int	getLoginDelay()
boolean	getSendServerInfo()
boolean	getUpdateACL()
void	setAuthMethods(java.lang.String[] methods)
void	setClientTimeout(int timeout)
void	setEnableBrokenAUTH(boolean enable)
void	setExtensions(java.lang.String[] extensions)
void	setCheckACL(boolean enable)
void	setInsecureLoginDisabled(boolean enable)
void	setLoginDelay(int delay)
void	setSendServerInfo(boolean enable)
void	setUpdateACL(boolean enable)

Methods inherited from class SK.gnome.dwarf.ParametersService

readOnly, report

Methods inherited from class SK.gnome.dwarf.GenericService

getAuthenticator, getAuthFacility, getFullName, getInitParameter, getInitParameterNames, getLogFacility, getLogger, getName, getParameters, getPrincipal, getShutdownTimeout, getState, init, log, log, login, logout, setAuthFacility, setInitParameters, setLogFacility, shutdown, start, stop, toString

Methods inherited from class java.lang.Object

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

Field Detail

clientTimeout

protected int clientTimeout

Client inactivity timeout.

Specifies the client inactivity timeout in seconds. After this time the server will automatically close the idle connection.

Default value: 600

sendServerInfo

protected boolean sendServerInfo

Enables or disables exposing of the server name and version to the client.

Default value: false

loginDelay

protected int loginDelay

Default login delay.

Specifies pause in seconds before automatic logout can happen after a failed authentication.

Value: 5

extensions

protected java.lang.String[] extensions

The actually available POP3 extensions.

This parameter is read-only.

Default value: SASL, STLS, TOP, UIDL, USER

authMethods

protected java.lang.String[] authMethods

The actually available authentication methods.

This parameter is read-only.

Default value: LOGIN, PLAIN

insecureLoginDisabled

protected boolean insecureLoginDisabled

Whether to allow the transfer of cleartext passwords via insecure connections.

If enabled the server will not allow to authenticate via a method which uses cleartext passwords unless the session is secured by an encryption mechanism. The USER command and the AUTH command with LOGIN or PLAIN method are examples of such prohibited means.

Default value: false

enableBrokenAUTH

protected boolean enableBrokenAUTH

Whether to support broken implementations of AUTH command.

If enabled the server will support some broken client implementations of the AUTH command. This is enabled by default to make the server more interoperable.

Default value: true

checkACL

protected boolean checkACL

Whether to check the Access Control List.

If enabled the server will use the available ACLStore to check the user's permissions when performing a mail operation.

This parameter is read-only.

Default value: false

updateACL

protected boolean updateACL

Whether to automatically update the Access Control List.

If enabled the server will automatically update the ACL of the given user when the INBOX folder is created. The read and delete permissions are granted to the owner. This feature works only if checkACL is enabled, too.

This parameter is read-only.

Default value: false

Constructor Detail

POPParameters

public POPParameters(java.lang.String name)

Creates a new POPParameters.

Method Detail

getAllExtensions

public java.lang.String[] getAllExtensions()

getAllAuthMethods

public java.lang.String[] getAllAuthMethods()

setSendServerInfo

public void setSendServerInfo(boolean enable)

getSendServerInfo

public boolean getSendServerInfo()

setClientTimeout

public void setClientTimeout(int timeout)

getClientTimeout

public int getClientTimeout()

setLoginDelay

public void setLoginDelay(int delay)

getLoginDelay

public int getLoginDelay()

setExtensions

public void setExtensions(java.lang.String[] extensions)

getExtensions

public java.lang.String[] getExtensions()

containsExtension

public boolean containsExtension(java.lang.String extension)

setAuthMethods

public void setAuthMethods(java.lang.String[] methods)

getAuthMethods

public java.lang.String[] getAuthMethods()

containsAuthMethod

public boolean containsAuthMethod(java.lang.String method)

setInsecureLoginDisabled

public void setInsecureLoginDisabled(boolean enable)

getInsecureLoginDisabled

public boolean getInsecureLoginDisabled()

getCheckACL

public boolean getCheckACL()

setCheckACL

public void setCheckACL(boolean enable)

getEnableBrokenAUTH

public boolean getEnableBrokenAUTH()

setEnableBrokenAUTH

public void setEnableBrokenAUTH(boolean enable)

getUpdateACL

public boolean getUpdateACL()

setUpdateACL

public void setUpdateACL(boolean enable)