Package edu.uiuc.ncsa.security.util.mail

Class MailUtilProvider

java.lang.Object

edu.uiuc.ncsa.security.core.configuration.provider.HierarchicalConfigProvider<MailUtil>

edu.uiuc.ncsa.security.util.mail.MailUtilProvider

All Implemented Interfaces:

ConfigurationTags, CfgEventListener, MailConfigurationTags, EventListener, javax.inject.Provider<MailUtil>

Direct Known Subclasses:

ServletMailUtilProvider

public class MailUtilProvider
extends HierarchicalConfigProvider<MailUtil>
implements MailConfigurationTags

Provider for the MailUtil from an XML configuration file.

Created by Jeff Gaynor
on 1/19/12 at 4:56 PM

Field Summary

Fields inherited from interface edu.uiuc.ncsa.security.core.configuration.ConfigurationTags

DEBUG

Fields inherited from interface edu.uiuc.ncsa.security.util.mail.MailConfigurationTags

MAIL, MAIL_COMPONENT, MAIL_CONFIG_ADMIN, MAIL_CONFIG_ALERTS, MAIL_CONFIG_DEFAULT_NAME, MAIL_CONFIG_HELP, MAIL_CONFIG_ROOT, MAIL_ENABLED, MAIL_FAIL_ON_MISSING_CONFIG, MAIL_MESSAGE_TEMPLATE, MAIL_NAME, MAIL_PARENT, MAIL_PASSWORD, MAIL_PORT, MAIL_RECIPIENTS, MAIL_SERVER, MAIL_START_TLS, MAIL_SUBJECT_TEMPLATE, MAIL_USE_SSL, MAIL_USERNAME

Constructor Summary

Constructors

Constructor	Description
MailUtilProvider()
MailUtilProvider(org.apache.commons.configuration.tree.ConfigurationNode config)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkEvent(CfgEvent cfgEvent)	Checks that the event applies to this component.
Object	componentFound(CfgEvent configurationEvent)
MailUtil	get()
protected String	getAttribute(org.apache.commons.configuration.tree.ConfigurationNode node, String name)
protected MailEnvironment	getME()
protected Map<String,Object>	getRawConfig(org.apache.commons.configuration.tree.ConfigurationNode node)
protected boolean	hasAttribute(org.apache.commons.configuration.tree.ConfigurationNode node, String name)
protected MailEnvironment	oldME()
protected Map<String,Map>	parseIt()
protected Map	resolveParents(Map<String,Map> allMaps, String name)

Methods inherited from class edu.uiuc.ncsa.security.core.configuration.provider.HierarchicalConfigProvider

addListener, fireComponentFound, getAttribute, getAttribute, getBooleanAttribute, getConfig, getConfigurationAt, getIntAttribute, getIntAttribute, getListeners, hasA, isA, removeListener, setConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

MailUtilProvider

public MailUtilProvider()

MailUtilProvider

public MailUtilProvider(org.apache.commons.configuration.tree.ConfigurationNode config)

Method Detail

checkEvent

protected boolean checkEvent(CfgEvent cfgEvent)

Description copied from class: HierarchicalConfigProvider

Checks that the event applies to this component. The type is the component and the target is Normally you set the component key as a static field in the class (e.g. "mysql") and pass it along in the the CfgEventListener.componentFound(CfgEvent) method. If checkEvent fails, do no more processing with the event.

Specified by:

checkEvent in class HierarchicalConfigProvider<MailUtil>

Returns:

componentFound

public Object componentFound(CfgEvent configurationEvent)

Specified by:

componentFound in interface CfgEventListener

getME

protected MailEnvironment getME()

oldME

protected MailEnvironment oldME()

hasAttribute

protected boolean hasAttribute(org.apache.commons.configuration.tree.ConfigurationNode node,
                               String name)

getAttribute

protected String getAttribute(org.apache.commons.configuration.tree.ConfigurationNode node,
                              String name)

getRawConfig

protected Map<String,Object> getRawConfig(org.apache.commons.configuration.tree.ConfigurationNode node)

parseIt

protected Map<String,Map> parseIt()

resolveParents

protected Map resolveParents(Map<String,Map> allMaps,
                             String name)

get

public MailUtil get()

Specified by:

get in interface javax.inject.Provider<MailUtil>