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 "simplejavamail.properties" 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.bounceto.name
• simplejavamail.defaults.bounceto.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.defaults.sessiontimeoutmillis
• simplejavamail.transport.mode.logging.only
• simplejavamail.opportunistic.tls

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigLoader.Property List of all the properties recognized by Simple Java Mail.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIG_FILENAME By default this optional file will be loaded from classpath to load initial defaults.

Method Summary

Modifier and Type	Method and Description
static Integer	getIntegerProperty(ConfigLoader.Property property)
static <T> T	getProperty(ConfigLoader.Property property)
static String	getStringProperty(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 Boolean	valueOrPropertyAsBoolean(Boolean value, ConfigLoader.Property property, Boolean defaultValue) See valueOrProperty(Object, Property, Object).
static Integer	valueOrPropertyAsInteger(Integer value, ConfigLoader.Property property, Integer defaultValue) See valueOrProperty(Object, Property, Object).
static String	valueOrPropertyAsString(String value, ConfigLoader.Property property, String defaultValue) See valueOrProperty(Object, Property, Object).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_FILENAME

public static final String DEFAULT_CONFIG_FILENAME

By default this optional file will be loaded from classpath to load initial defaults.

See Also:

Constant Field Values

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.

valueOrPropertyAsString

@Nullable
public static String valueOrPropertyAsString(@Nullable
                                                        String value,
                                                        @Nonnull
                                                        ConfigLoader.Property property,
                                                        @Nullable
                                                        String defaultValue)

See valueOrProperty(Object, Property, Object).

valueOrPropertyAsBoolean

@Nullable
public static Boolean valueOrPropertyAsBoolean(@Nullable
                                                          Boolean value,
                                                          @Nonnull
                                                          ConfigLoader.Property property,
                                                          @Nullable
                                                          Boolean defaultValue)

See valueOrProperty(Object, Property, Object).

valueOrPropertyAsInteger

@Nullable
public static Integer valueOrPropertyAsInteger(@Nullable
                                                          Integer value,
                                                          @Nonnull
                                                          ConfigLoader.Property property,
                                                          @Nullable
                                                          Integer defaultValue)

See valueOrProperty(Object, Property, Object).

hasProperty

public static boolean hasProperty(ConfigLoader.Property property)

getProperty

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

getStringProperty

public static String getStringProperty(ConfigLoader.Property property)

getIntegerProperty

public static Integer getIntegerProperty(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.