org.nhindirect.gateway

Class GatewayConfiguration

java.lang.Object

org.nhindirect.gateway.GatewayConfiguration

public class GatewayConfiguration
extends Object

Utility class for retrieving parameterized configuration options. Options for the can be configured in one of two ways: either by setting appropriate option as an XML element in a mailet's XML configuration (optional and typically found in the config.xml file for Apache James deployments), or by setting the option using the org.nhindirect.stagent.options.OptionsManager pattern.

The precedence of the parameters using the following algorithm.
1. Use the mailet XML configuration
2. Use the OptionsManager configuration
3. Use default settings in the mailet.

Since:

2.0

Author:

Greg Meyer

Constructor Summary

Constructors

Constructor and Description
GatewayConfiguration()

Method Summary

Modifier and Type	Method and Description
static String	getConfigurationParam(String param, Mailet mailet, org.springframework.context.ApplicationContext ctx, String defaultValue) Gets the configuration parameter requested.
static boolean	getConfigurationParamAsBoolean(String param, Mailet mailet, org.springframework.context.ApplicationContext ctx, boolean defaultValue) Gets the configuration parameter requested as a boolean value.

Methods inherited from class java.lang.Object

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

Constructor Detail

GatewayConfiguration

public GatewayConfiguration()

Method Detail

getConfigurationParam

public static final String getConfigurationParam(String param,
                                                 Mailet mailet,
                                                 org.springframework.context.ApplicationContext ctx,
                                                 String defaultValue)

Gets the configuration parameter requested. The mailet init parameters are checked first, then the OptionsManager.

Parameters:

param - The parameter to get the value of.

mailet - The mailet to search. May be null

Returns:

If found, returns, the value of the configured value. Otherwise, the default value is returned

getConfigurationParamAsBoolean

public static final boolean getConfigurationParamAsBoolean(String param,
                                                           Mailet mailet,
                                                           org.springframework.context.ApplicationContext ctx,
                                                           boolean defaultValue)

Gets the configuration parameter requested as a boolean value. The same search rules are followed as in #getConfigurationParam(String, Mailet, String).

Parameters:

param - The parameter to get the value of.

mailet - The mailet to search. May be null

Returns:

If found, returns, the value of the configured value. Otherwise, the default value is returned.