org.simplejavamail.util

Class ConfigLoader

java.lang.Object

org.simplejavamail.util.ConfigLoader

public final class ConfigLoader
extends Object

Contains list of possible properties names and can produce a map of property values, if provided as file "" on the classpath or as environment property.

The following properties are allowed:

    
simplejavamail.javaxmail.debug
    
simplejavamail.transportstrategy
    
simplejavamail.smtp.host
    
simplejavamail.smtp.port
    
simplejavamail.smtp.username
    
simplejavamail.smtp.password
    
simplejavamail.proxy.host
    
simplejavamail.proxy.port
    
simplejavamail.proxy.username
    
simplejavamail.proxy.password
    
simplejavamail.proxy.socks5bridge.port
    
simplejavamail.defaults.subject
    
simplejavamail.defaults.from.name
    
simplejavamail.defaults.from.address
    
simplejavamail.defaults.replyto.name
    
simplejavamail.defaults.replyto.address
    
simplejavamail.defaults.to.name
    
simplejavamail.defaults.to.address
    
simplejavamail.defaults.cc.name
    
simplejavamail.defaults.cc.address
    
simplejavamail.defaults.bcc.name
    
simplejavamail.defaults.bcc.address
    
simplejavamail.defaults.poolsize
    
simplejavamail.transport.mode.logging.only
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigLoader.Property

Constructor Summary

Constructors

Constructor and Description
ConfigLoader()

Method Summary

Modifier and Type	Method and Description
static <T> T	getProperty(ConfigLoader.Property property)
static boolean	hasProperty(ConfigLoader.Property property)
static Map<ConfigLoader.Property,Object>	loadProperties(File filename, boolean addProperties) Loads properties from property File, if provided.
static Map<ConfigLoader.Property,Object>	loadProperties(InputStream inputStream, boolean addProperties) Loads properties from InputStream.
static Map<ConfigLoader.Property,Object>	loadProperties(Properties properties, boolean addProperties) Loads properties from another properties source, in case you want to provide your own list.
static Map<ConfigLoader.Property,Object>	loadProperties(String filename, boolean addProperties) Loads properties from property file on the classpath, if provided.
static <T> T	valueOrProperty(T value, ConfigLoader.Property property)
static <T> T	valueOrProperty(T value, ConfigLoader.Property property, T defaultValue) Returns the given value if not null and not empty, otherwise tries to resolve the given property and if still not found resot to the default value if provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigLoader

public ConfigLoader()

Method Detail

valueOrProperty

public static <T> T valueOrProperty(T value,
                                    ConfigLoader.Property property)

Returns:

The value if not null or else the value from config file if provided or else null.

valueOrProperty

public static <T> T valueOrProperty(T value,
                                    ConfigLoader.Property property,
                                    T defaultValue)

Returns the given value if not null and not empty, otherwise tries to resolve the given property and if still not found resot to the default value if provided.

Null or blank values are never allowed, so they are always ignored.

Returns:

The value if not null or else the value from config file if provided or else defaultValue.

hasProperty

public static boolean hasProperty(ConfigLoader.Property property)

getProperty

public static <T> T getProperty(ConfigLoader.Property property)

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(String filename,
                                                               boolean addProperties)

Loads properties from property file on the classpath, if provided. Calling this method only has effect on new Email and Mailer instances after this.

Parameters:

filename - Any file that is on the classpath that holds a list of key=value pairs.

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(Properties properties,
                                                               boolean addProperties)

Loads properties from another properties source, in case you want to provide your own list.

Parameters:

properties - Your own list of properties

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(File filename,
                                                               boolean addProperties)

Loads properties from property File, if provided. Calling this method only has effect on new Email and Mailer instances after this.

Parameters:

filename - Any file reference that holds a properties list.

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(InputStream inputStream,
                                                               boolean addProperties)

Loads properties from InputStream. Calling this method only has effect on new Email and Mailer instances after this.

Parameters:

inputStream - Source of property key=value pairs separated by newline \n characters.

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.