|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ericdaugherty.mail.server.configuration.ConfigurationManager
public class ConfigurationManager
Provides a centralized repository for all configuration information.
All configuration information should be retrieved here for every use. The ConfigurationManager will reload configuration changes dynamically.
Classes may cache the reference to the ConfigurationManager instance, as only one will ever be created.
Nested Class Summary | |
---|---|
class |
ConfigurationManager.DomainWithPassword
|
static class |
ConfigurationManager.RetrievalMode
|
static class |
ConfigurationManager.TransferMode
|
Field Summary | |
---|---|
ConfigurationManager.RetrievalMode |
retrievalMode
|
ConfigurationManager.TransferMode |
transferMode
|
static java.lang.String |
USER_PROPERTIES_HEADER
|
Method Summary | |
---|---|
int |
allowClearTextPOP3()
Check whether or not clear text passwords are allowed in POP3 sessions. |
int |
allowClearTextSMTP()
Check whether or not clear text passwords are allowed in SMTP sessions. |
int |
getAddPctRCPT()
|
int |
getAmavisFilteredSMTPPort()
|
java.net.InetAddress |
getAmavisListenAddress()
|
java.lang.String |
getAmavisSMTPDirectory()
|
int |
getAmavisSMTPPort()
|
long |
getAuthenticationTimeoutMilliseconds()
The timeout length for authenticated ip addresses |
java.lang.String |
getBackupDirectory()
The directory used to store backup files. |
java.lang.String |
getClientAuth()
Check whether the standard SMTP/POP3 modules are to use TLS/SSL security. |
java.net.InetAddress |
getConfigurationAddress()
|
int |
getConfigurationPort()
|
EmailAddress |
getDefaultMailbox(java.lang.String domain)
|
DefaultSMTPServer[] |
getDefaultSmtpServers()
The servers to send all outoing mail through |
int |
getDeliveryAttemptThreshold()
Get the max number of delivvery attempts before message is considered 'undeliverable' and moved to 'failed' folder |
long |
getDeliveryIntervalSeconds()
The number of seconds to wait between delivery attempts |
long |
getDeliveryIntervealMilliseconds()
The number of milliseconds to wait between delivery attempts |
java.lang.String |
getDigestMD5Ciphers()
|
int |
getExecuteThreadCount()
The number of threads to use for each listener. |
java.lang.String |
getFailedDirectory()
The directory used to store failed e-mails. |
java.lang.String |
getGSSPrincipal()
|
static ConfigurationManager |
getInstance()
Provides access to the singleton instance. |
java.lang.String |
getKeystoreLocation()
The location of the keystore containg the server's certificates and private key. |
java.lang.String |
getKeystoreProvider()
The provider of the keystore containg the server's certificates and private key. |
java.lang.String |
getKeystoreType()
The type of the keystore containg the server's certificates and private key. |
java.net.InetAddress |
getListenAddress()
The local IP address to lisen on. |
java.util.Set<java.lang.String> |
getLocalDomains()
Array of domains that the SMTP server should accept mail for local delivery |
java.util.Map |
getMappedPorts()
|
int |
getMaxErrorCount()
The maximum number of errors during a POP3 or SMTP server session. |
int |
getMaximumMessageSize()
The maximum size (in megabytes) allowed for email attachments. |
int |
getMaxPassAttempts()
|
int |
getMaxValidRCPT()
|
int |
getMinPctFailRCPT()
|
int |
getMinTotFailRCPT()
|
int |
getPOP3Port()
The port the POP3 server listens on. |
Realm |
getRealm(java.lang.String realmName)
Returns the specified realm, or null if the realm does not exist. |
ConfigurationManager.DomainWithPassword |
getRealmPassword(java.lang.String realmName,
java.lang.String username)
|
java.util.Map |
getRealms()
|
java.lang.String[] |
getRelayApprovedEmailAddresses()
Email Addresses that are allowed to relay mail. |
java.lang.String[] |
getRelayApprovedIPAddresses()
IP Addresses that are allowed to relay mail. |
ConfigurationManager.RetrievalMode |
getRetrievalMode()
|
java.lang.String[] |
getReverseDNSservers()
Array of domains that the SMTP server should alter the initial greeting reported domain |
java.lang.String |
getRootDirectory()
The root directory used to store the incoming and outgoing messages. |
java.lang.String |
getSaslQOP()
|
int |
getSecureExecuteThreadCount()
The number of threads to use for each secure listener. |
int |
getSecurePOP3Port()
The port the secure POP3 server listens on. |
int |
getSecureSMTPPort()
The port the secure SMTP server listens on. |
java.lang.String |
getSecurityDirectory()
The root directory used to store the server certificate and private key. |
java.lang.String |
getSMTPDirectory()
The directory used to store incoming e-mails. |
int |
getSMTPPort()
The port the SMTP server listens on. |
javax.net.ssl.SSLContext |
getSSLContext()
|
javax.net.ssl.SSLSocketFactory |
getSSLSocketFactory()
|
java.lang.String |
getTestingDirectory()
|
ConfigurationManager.TransferMode |
getTransferMode()
|
java.lang.String |
getTruststoreLocation()
The location of the truststore containg the server's certificates and private key. |
java.lang.String |
getTruststoreProvider()
The provider of the truststore containg the server's certificates and private key. |
java.lang.String |
getTruststoreType()
The type of the truststore containg the server's certificates and private key. |
User |
getUser(EmailAddress address)
Returns the specified user, or null if the user does not exist. |
java.lang.String |
getUsersDirectory()
The directory used to store the user accounts. |
static ConfigurationManager |
initialize(java.lang.String rootDirectory)
Initializes the ConfigurationManager to use the specified directory. |
boolean |
is8bitMIME()
A flag to indicate if 8BITMIME is to be used |
boolean |
isAmavisSupportActive()
|
boolean |
isDebugSSL()
|
boolean |
isDefaultSmtpServerEnabled()
True if all outgoing mail should go though the default server |
boolean |
isDigestMD5Enabled()
|
boolean |
isEnablePOPBeforeSMTP()
True if POP Before SMTP is a valid relay option |
boolean |
isGSSEnabled()
|
boolean |
isHELOEnabled()
|
boolean |
isLocalDomain(java.lang.String domain)
Checks the local domains to see if the specified parameter matches. |
boolean |
isLocalTestingMode()
|
boolean |
isNonExistentLocalRejected()
|
boolean |
isOutgoingSecure()
Check whether to use TLS/SSL for an outbound SMTP message |
boolean |
isSecureActive()
Check whether the secure POP3 modules are active/to be activated. |
static boolean |
isSecurityManagerEnabled()
|
boolean |
isStandardPOP3Secure()
Check whether the standard POP3 modules are to use TLS/SSL security. |
boolean |
isStandardSMTPSecure()
Check whether the standard SMTP modules are to use TLS/SSL security. |
boolean |
isVerifyIP()
|
void |
persistUpdates()
|
void |
requestDirCreation(java.lang.String directory)
|
static void |
shutdown()
|
static java.lang.String[] |
tokenize(java.lang.String value,
boolean clearWhiteSpace)
Loads the values of the specified key from the configuration file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public ConfigurationManager.TransferMode transferMode
public ConfigurationManager.RetrievalMode retrievalMode
public static final java.lang.String USER_PROPERTIES_HEADER
Method Detail |
---|
public static ConfigurationManager initialize(java.lang.String rootDirectory) throws java.lang.RuntimeException
rootDirectory
- the directory JES was installed into.
java.lang.RuntimeException
- thrown if called more than once, the file does not exist,
or there is an error loading the file.public static ConfigurationManager getInstance()
public static void shutdown()
public boolean isDebugSSL()
public ConfigurationManager.TransferMode getTransferMode()
public ConfigurationManager.RetrievalMode getRetrievalMode()
public java.lang.String getRootDirectory()
public java.lang.String getBackupDirectory()
public java.lang.String getSMTPDirectory()
public java.lang.String getUsersDirectory()
public java.lang.String getSecurityDirectory()
public java.lang.String getFailedDirectory()
public void requestDirCreation(java.lang.String directory)
public java.net.InetAddress getConfigurationAddress()
public int getConfigurationPort()
public java.net.InetAddress getListenAddress()
public int getSMTPPort()
public int getPOP3Port()
public int getExecuteThreadCount()
public int getMaximumMessageSize()
public long getDeliveryIntervalSeconds()
public long getDeliveryIntervealMilliseconds()
public int getDeliveryAttemptThreshold()
public java.util.Set<java.lang.String> getLocalDomains()
public boolean isLocalDomain(java.lang.String domain)
domain
- a domain to check.
public EmailAddress getDefaultMailbox(java.lang.String domain)
public boolean isDefaultSmtpServerEnabled()
public DefaultSMTPServer[] getDefaultSmtpServers()
public boolean isEnablePOPBeforeSMTP()
public long getAuthenticationTimeoutMilliseconds()
public java.lang.String[] getRelayApprovedIPAddresses()
public java.lang.String[] getRelayApprovedEmailAddresses()
public boolean is8bitMIME()
public boolean isSecureActive()
public int getSecureSMTPPort()
public int getSecurePOP3Port()
public int getSecureExecuteThreadCount()
public java.lang.String getKeystoreLocation()
public java.lang.String getKeystoreProvider()
public java.lang.String getKeystoreType()
public java.lang.String getTruststoreLocation()
public java.lang.String getTruststoreProvider()
public java.lang.String getTruststoreType()
public javax.net.ssl.SSLSocketFactory getSSLSocketFactory()
public static boolean isSecurityManagerEnabled()
public boolean isHELOEnabled()
public java.lang.String getClientAuth()
public boolean isOutgoingSecure()
public boolean isStandardSMTPSecure()
public boolean isStandardPOP3Secure()
public int allowClearTextSMTP()
public int allowClearTextPOP3()
public boolean isNonExistentLocalRejected()
public int getMaxErrorCount()
public int getMaxPassAttempts()
public int getMaxValidRCPT()
public int getAddPctRCPT()
public int getMinTotFailRCPT()
public int getMinPctFailRCPT()
public boolean isVerifyIP()
public java.lang.String getSaslQOP()
public java.lang.String getDigestMD5Ciphers()
public boolean isDigestMD5Enabled()
public boolean isGSSEnabled()
public java.lang.String getGSSPrincipal()
public boolean isAmavisSupportActive()
public java.lang.String getAmavisSMTPDirectory()
public java.net.InetAddress getAmavisListenAddress()
public int getAmavisSMTPPort()
public int getAmavisFilteredSMTPPort()
public boolean isLocalTestingMode()
public java.lang.String getTestingDirectory()
public java.lang.String[] getReverseDNSservers()
public User getUser(EmailAddress address)
address
- the user's full email address.
public java.util.Map getRealms()
public Realm getRealm(java.lang.String realmName)
realmName
- the realm's full name.
public ConfigurationManager.DomainWithPassword getRealmPassword(java.lang.String realmName, java.lang.String username)
public javax.net.ssl.SSLContext getSSLContext()
public final java.util.Map getMappedPorts()
public void persistUpdates()
public static java.lang.String[] tokenize(java.lang.String value, boolean clearWhiteSpace)
value
- the string to tokenize into an array.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |