org.nhindirect.gateway.smtp

Class DefaultSmtpAgent

java.lang.Object

org.nhindirect.gateway.smtp.DefaultSmtpAgent

All Implemented Interfaces:

SmtpAgent

public class DefaultSmtpAgent
extends Object
implements SmtpAgent

Default implementation of the SmtpAgent interface.

Constructor Summary

Constructors

Constructor and Description
DefaultSmtpAgent(SmtpAgentSettings settings, org.nhindirect.stagent.NHINDAgent agent) Constructs an Smtp agent with settings and an instance of the security and trust agent.
DefaultSmtpAgent(SmtpAgentSettings settings, org.nhindirect.stagent.NHINDAgent agent, org.nhindirect.common.audit.Auditor auditor) Constructs an Smtp agent with settings, an instance of the security and trust agent, and an event auditor.

Method Summary

Modifier and Type	Method and Description
org.nhindirect.stagent.NHINDAgent	getAgent() Gets a references to the security and trust agent used by the SmtpAgent.
org.nhindirect.common.audit.Auditor	getAuditor() Gets the auditor used to log auditable events.
SmtpAgentSettings	getSmtpAgentSettings() Gets the configuration settings of the SmtpAgent.
boolean	isOutgoing(org.nhindirect.stagent.MessageEnvelope envelope)
MessageProcessResult	processMessage(javax.mail.internet.MimeMessage message, org.nhindirect.stagent.NHINDAddressCollection recipients, org.nhindirect.stagent.NHINDAddress sender) Processes an message from an SMTP stack.
void	setAgent(org.nhindirect.stagent.NHINDAgent agent) Sets the security and trust agent used by the SmtpAgent
void	setAuditor(org.nhindirect.common.audit.Auditor auditor) Sets the auditor used to log auditable events.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSmtpAgent

public DefaultSmtpAgent(SmtpAgentSettings settings,
                        org.nhindirect.stagent.NHINDAgent agent)

Constructs an Smtp agent with settings and an instance of the security and trust agent.

Parameters:

settings - The SMTP agent configuration settings.

agent - An instance of the security and trust agent.

DefaultSmtpAgent

public DefaultSmtpAgent(SmtpAgentSettings settings,
                        org.nhindirect.stagent.NHINDAgent agent,
                        org.nhindirect.common.audit.Auditor auditor)

Constructs an Smtp agent with settings, an instance of the security and trust agent, and an event auditor.

Parameters:

settings - The SMTP agent configuration settings.

agent - An instance of the security and trust agent.

auditor - The auditor used to log auditable events.

Method Detail

getAgent

public org.nhindirect.stagent.NHINDAgent getAgent()

Gets a references to the security and trust agent used by the SmtpAgent.

Specified by:

getAgent in interface SmtpAgent

Returns:

A references to the security and trust agent used by the SmtpAgent

setAgent

public void setAgent(org.nhindirect.stagent.NHINDAgent agent)

Sets the security and trust agent used by the SmtpAgent

Parameters:

agent - The security and trust agent used by the SmtpAgent

getSmtpAgentSettings

public SmtpAgentSettings getSmtpAgentSettings()

Gets the configuration settings of the SmtpAgent.

Specified by:

getSmtpAgentSettings in interface SmtpAgent

Returns:

The configuration settings of the SmtpAgent.

setAuditor

public void setAuditor(org.nhindirect.common.audit.Auditor auditor)

Sets the auditor used to log auditable events.

Parameters:

auditor - The auditor used to log auditable events.

getAuditor

public org.nhindirect.common.audit.Auditor getAuditor()

Gets the auditor used to log auditable events.

Parameters:

auditor - The auditor used to log auditable events.

processMessage

public MessageProcessResult processMessage(javax.mail.internet.MimeMessage message,
                                           org.nhindirect.stagent.NHINDAddressCollection recipients,
                                           org.nhindirect.stagent.NHINDAddress sender)

Processes an message from an SMTP stack. The bridge component between the SMTP stack and the SMTP agent is responsible for extracting the message, the recipient list, and the sender. In some cases, the routing headers may have different information than what is populated in the SMTP MAIL FROM and RCTP TO headers. In these cases, the SMTP headers should be favored over the routing headers in the message and passed as the recipient collection and sender to this method.

Specified by:

processMessage in interface SmtpAgent

Parameters:

message - The message in the SMTP envelope.

recipients - The recipients of the message. The RCTP TO headers should be used over the message routing headers.

sender - The send of the message. The MAIL FROM header should be used over the From: routing header in the message.

isOutgoing

public boolean isOutgoing(org.nhindirect.stagent.MessageEnvelope envelope)