Class SendGridSender

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.senders.AbstractMailSender

org.frankframework.senders.SendGridSender

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, HasKeystore, HasTruststore, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class SendGridSender
extends AbstractMailSender
implements HasKeystore, HasTruststore

Sender that sends a mail via SendGrid v3 (cloud-based SMTP provider). Sample XML file can be found in the path: iaf-core/src/test/resources/emailSamplesXML/emailSample.xml

Author:

alisihab

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SendGridSender.GridMailSession

Nested classes/interfaces inherited from class AbstractMailSender

AbstractMailSender.EMail, AbstractMailSender.MailAttachmentBase<T>, AbstractMailSender.MailAttachmentStream, AbstractMailSender.MailSessionBase

Field Summary

Fields inherited from class AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
SendGridSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
protected SendGridSender.GridMailSession	createMailSession()
KeystoreConfiguration	getKeystoreConfiguration()	Override getter to delegate to httpSession
TruststoreConfiguration	getTruststoreConfiguration()	Override getter to delegate to httpSession
void	sendEmail(AbstractMailSender.MailSessionBase mailSession)
void	setFollowRedirects(boolean b)
void	setKeystoreConfiguration(KeystoreConfiguration keystoreConfiguration)	Set the KeystoreConfiguration object
void	setMaxConnections(int i)
void	setMaxExecuteRetries(int i)
void	setProtocol(String protocol)
void	setProxyAuthAlias(String string)
void	setProxyHost(String string)
void	setProxyPassword(String string)
void	setProxyPort(int i)
void	setProxyRealm(String string)
void	setProxyUsername(String string)
void	setStaleChecking(boolean b)
void	setStaleTimeout(int timeout)
void	setTimeout(int i)	Timeout in milliseconds for socket connection timeout and socket i/o timeouts
void	setTruststoreConfiguration(TruststoreConfiguration truststoreConfiguration)
void	start()	This method will be called to start the sender.
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class AbstractMailSender

extract, isSynchronous, sendMessage, setAuthAlias, setBounceAddress, setDefaultAttachmentName, setDefaultFrom, setDefaultMessageBase64, setDefaultMessageType, setDefaultSubject, setDomainWhitelist, setPassword, setUserId

Methods inherited from class AbstractSenderWithParameters

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class AbstractSender

createBean, getLogPrefix, getName, isRunning, setApplicationContext, setName

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasKeystore

createKeystoreConfiguration, getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType

Methods inherited from interface HasName

getName

Methods inherited from interface HasTruststore

createTruststoreConfiguration, getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname, setAllowSelfSignedCertificates, setIgnoreCertificateExpiredException, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setVerifyHostname

Methods inherited from interface ISender

sendMessageOrThrow

Methods inherited from interface NameAware

setName

Constructor Details

SendGridSender

public SendGridSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractMailSender

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

start in interface ISender

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractSender

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop in interface ISender

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractSender

sendEmail

public void sendEmail(AbstractMailSender.MailSessionBase mailSession)
               throws SenderException

Specified by:

sendEmail in class AbstractMailSender

Throws:

SenderException

createMailSession

protected SendGridSender.GridMailSession createMailSession()
                                                    throws SenderException

Specified by:

createMailSession in class AbstractMailSender

Throws:

SenderException

setTimeout

@ReferTo(AbstractHttpSession.class)
public void setTimeout(int i)

Description copied from class: AbstractMailSender

Timeout in milliseconds for socket connection timeout and socket i/o timeouts

Overrides:

setTimeout in class AbstractMailSender

setMaxConnections

@ReferTo(AbstractHttpSession.class)
public void setMaxConnections(int i)

setMaxExecuteRetries

@ReferTo(AbstractHttpSession.class)
public void setMaxExecuteRetries(int i)

setProxyHost

@ReferTo(AbstractHttpSession.class)
public void setProxyHost(String string)

setProxyPort

@ReferTo(AbstractHttpSession.class)
public void setProxyPort(int i)

setProxyAuthAlias

@ReferTo(AbstractHttpSession.class)
public void setProxyAuthAlias(String string)

setProxyUsername

@ReferTo(AbstractHttpSession.class)
public void setProxyUsername(String string)

setProxyPassword

@ReferTo(AbstractHttpSession.class)
public void setProxyPassword(String string)

setProxyRealm

@ReferTo(AbstractHttpSession.class)
public void setProxyRealm(String string)

setKeystoreConfiguration

public void setKeystoreConfiguration(KeystoreConfiguration keystoreConfiguration)

Description copied from interface: HasKeystore

Set the KeystoreConfiguration object

Specified by:

setKeystoreConfiguration in interface HasKeystore

getKeystoreConfiguration

public KeystoreConfiguration getKeystoreConfiguration()

Override getter to delegate to httpSession

Specified by:

getKeystoreConfiguration in interface HasKeystore

setTruststoreConfiguration

public void setTruststoreConfiguration(TruststoreConfiguration truststoreConfiguration)

Specified by:

setTruststoreConfiguration in interface HasTruststore

getTruststoreConfiguration

public TruststoreConfiguration getTruststoreConfiguration()

Override getter to delegate to httpSession

Specified by:

getTruststoreConfiguration in interface HasTruststore

setFollowRedirects

@ReferTo(AbstractHttpSession.class)
public void setFollowRedirects(boolean b)

setStaleChecking

@ReferTo(AbstractHttpSession.class)
public void setStaleChecking(boolean b)

setStaleTimeout

@ReferTo(AbstractHttpSession.class)
public void setStaleTimeout(int timeout)

setProtocol

@ReferTo(AbstractHttpSession.class)
public void setProtocol(String protocol)