Package org.frankframework.senders

Class SendGridSender

java.lang.Object

org.frankframework.senders.SenderBase

org.frankframework.senders.SenderWithParametersBase

org.frankframework.senders.MailSenderBase

org.frankframework.senders.SendGridSender

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, HasKeystore, HasTruststore, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class SendGridSender
extends MailSenderBase
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 org.frankframework.senders.MailSenderBase

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

Field Summary

Fields inherited from class org.frankframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor	Description
SendGridSender()

Method Summary

Modifier and Type	Method	Description
void	close()	Stop/close the sender and deallocate resources.
void	configure()	configure() is called once at startup of the framework in the configure method of the owner of this sender.
protected SendGridSender.GridMailSession	createMailSession()
String	getKeyManagerAlgorithm()
String	getKeystore()
String	getKeystoreAlias()
String	getKeystoreAliasAuthAlias()
String	getKeystoreAliasPassword()
String	getKeystoreAuthAlias()
String	getKeystorePassword()
KeystoreType	getKeystoreType()
String	getTrustManagerAlgorithm()
String	getTruststore()
String	getTruststoreAuthAlias()
String	getTruststorePassword()
KeystoreType	getTruststoreType()
boolean	isAllowSelfSignedCertificates()
boolean	isIgnoreCertificateExpiredException()
boolean	isVerifyHostname()
void	open()	This method will be called to start the sender.
String	sendEmail(MailSenderBase.MailSessionBase mailSession)
void	setAllowSelfSignedCertificates(boolean testModeNoCertificatorCheck)	If true, self signed certificates are accepted
void	setFollowRedirects(boolean b)
void	setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException)	If true, CertificateExpiredExceptions are ignored
void	setKeyManagerAlgorithm(String keyManagerAlgorithm)	Key manager algorithm.
void	setKeystore(String keystore)	Resource url to keystore or certificate.
void	setKeystoreAlias(String keystoreAlias)	Alias to obtain specific certificate or key in keystore
void	setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias)	Authentication alias to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAliasPassword(String keystoreAliasPassword)	Default password to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAuthAlias(String keystoreAuthAlias)	Authentication alias used to obtain keystore password
void	setKeystorePassword(String keystorePassword)	Default password to access keystore
void	setKeystoreType(KeystoreType keystoreType)	Type of keystore
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	setTrustManagerAlgorithm(String trustManagerAlgorithm)	Trust manager algorithm.
void	setTruststore(String truststore)	Resource url to truststore.
void	setTruststoreAuthAlias(String truststoreAuthAlias)	Authentication alias used to obtain truststore password
void	setTruststorePassword(String truststorePassword)	Default password to access truststore
void	setTruststoreType(KeystoreType truststoreType)	Type of truststore
void	setVerifyHostname(boolean verifyHostname)	If true, the hostname in the certificate will be checked against the actual hostname of the peer

Methods inherited from class org.frankframework.senders.MailSenderBase

extract, getAuthAlias, getBounceAddress, getCredentialFactory, getDefaultAttachmentName, getDefaultFrom, getDefaultMessageType, getDefaultSubject, getDomainWhitelist, getPassword, getTimeout, getUserId, isDefaultMessageBase64, isSynchronous, sendMessage, setAuthAlias, setBounceAddress, setDefaultAttachmentName, setDefaultFrom, setDefaultMessageBase64, setDefaultMessageType, setDefaultSubject, setDomainWhitelist, setPassword, setUserId

Methods inherited from class org.frankframework.senders.SenderWithParametersBase

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

Methods inherited from class org.frankframework.senders.SenderBase

createBean, getApplicationContext, getConfigurationClassLoader, getLogPrefix, getName, setApplicationContext, setName

Methods inherited from class java.lang.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 org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.ISender

sendMessageOrThrow

Constructor Details

SendGridSender

public SendGridSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

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

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class MailSenderBase

Throws:

ConfigurationException

open

public void open()
          throws SenderException

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:

open in interface ISender

Overrides:

open in class SenderBase

Throws:

SenderException

close

public void close()
           throws SenderException

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class SenderBase

Throws:

SenderException

sendEmail

public String sendEmail(MailSenderBase.MailSessionBase mailSession)
                 throws SenderException

Specified by:

sendEmail in class MailSenderBase

Throws:

SenderException

createMailSession

protected SendGridSender.GridMailSession createMailSession()
                                                    throws SenderException

Specified by:

createMailSession in class MailSenderBase

Throws:

SenderException

setTimeout

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

Description copied from class: MailSenderBase

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

Overrides:

setTimeout in class MailSenderBase

setMaxConnections

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

setMaxExecuteRetries

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

setProxyHost

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

setProxyPort

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

setProxyAuthAlias

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

setProxyUsername

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

setProxyPassword

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

setProxyRealm

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

setKeystore

@ReferTo(HttpSessionBase.class)
public void setKeystore(String keystore)

Description copied from interface: HasKeystore

Resource url to keystore or certificate. If none specified, the JVMs default keystore will be used.

Specified by:

setKeystore in interface HasKeystore

getKeystore

public String getKeystore()

Specified by:

getKeystore in interface HasKeystore

setKeystoreType

@ReferTo(HttpSessionBase.class)
public void setKeystoreType(KeystoreType keystoreType)

Description copied from interface: HasKeystore

Type of keystore

Specified by:

setKeystoreType in interface HasKeystore

getKeystoreType

public KeystoreType getKeystoreType()

Specified by:

getKeystoreType in interface HasKeystore

setKeystoreAuthAlias

@ReferTo(HttpSessionBase.class)
public void setKeystoreAuthAlias(String keystoreAuthAlias)

Description copied from interface: HasKeystore

Authentication alias used to obtain keystore password

Specified by:

setKeystoreAuthAlias in interface HasKeystore

getKeystoreAuthAlias

public String getKeystoreAuthAlias()

Specified by:

getKeystoreAuthAlias in interface HasKeystore

setKeystorePassword

@ReferTo(HttpSessionBase.class)
public void setKeystorePassword(String keystorePassword)

Description copied from interface: HasKeystore

Default password to access keystore

Specified by:

setKeystorePassword in interface HasKeystore

getKeystorePassword

public String getKeystorePassword()

Specified by:

getKeystorePassword in interface HasKeystore

setKeystoreAlias

@ReferTo(HttpSessionBase.class)
public void setKeystoreAlias(String keystoreAlias)

Description copied from interface: HasKeystore

Alias to obtain specific certificate or key in keystore

Specified by:

setKeystoreAlias in interface HasKeystore

getKeystoreAlias

public String getKeystoreAlias()

Specified by:

getKeystoreAlias in interface HasKeystore

setKeystoreAliasAuthAlias

@ReferTo(HttpSessionBase.class)
public void setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias)

Description copied from interface: HasKeystore

Authentication alias to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasAuthAlias in interface HasKeystore

getKeystoreAliasAuthAlias

public String getKeystoreAliasAuthAlias()

Specified by:

getKeystoreAliasAuthAlias in interface HasKeystore

setKeystoreAliasPassword

@ReferTo(HttpSessionBase.class)
public void setKeystoreAliasPassword(String keystoreAliasPassword)

Description copied from interface: HasKeystore

Default password to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasPassword in interface HasKeystore

getKeystoreAliasPassword

public String getKeystoreAliasPassword()

Specified by:

getKeystoreAliasPassword in interface HasKeystore

setKeyManagerAlgorithm

@ReferTo(HttpSessionBase.class)
public void setKeyManagerAlgorithm(String keyManagerAlgorithm)

Description copied from interface: HasKeystore

Key manager algorithm. Can be left empty to use the servers default algorithm

Specified by:

setKeyManagerAlgorithm in interface HasKeystore

getKeyManagerAlgorithm

public String getKeyManagerAlgorithm()

Specified by:

getKeyManagerAlgorithm in interface HasKeystore

setTruststore

@ReferTo(HttpSessionBase.class)
public void setTruststore(String truststore)

Description copied from interface: HasTruststore

Resource url to truststore. If none specified, the JVMs default truststore will be used.

Specified by:

setTruststore in interface HasTruststore

getTruststore

public String getTruststore()

Specified by:

getTruststore in interface HasTruststore

setTruststoreType

@ReferTo(HttpSessionBase.class)
public void setTruststoreType(KeystoreType truststoreType)

Description copied from interface: HasTruststore

Type of truststore

Specified by:

setTruststoreType in interface HasTruststore

getTruststoreType

public KeystoreType getTruststoreType()

Specified by:

getTruststoreType in interface HasTruststore

setTruststoreAuthAlias

@ReferTo(HttpSessionBase.class)
public void setTruststoreAuthAlias(String truststoreAuthAlias)

Description copied from interface: HasTruststore

Authentication alias used to obtain truststore password

Specified by:

setTruststoreAuthAlias in interface HasTruststore

getTruststoreAuthAlias

public String getTruststoreAuthAlias()

Specified by:

getTruststoreAuthAlias in interface HasTruststore

setTruststorePassword

@ReferTo(HttpSessionBase.class)
public void setTruststorePassword(String truststorePassword)

Description copied from interface: HasTruststore

Default password to access truststore

Specified by:

setTruststorePassword in interface HasTruststore

getTruststorePassword

public String getTruststorePassword()

Specified by:

getTruststorePassword in interface HasTruststore

setTrustManagerAlgorithm

@ReferTo(HttpSessionBase.class)
public void setTrustManagerAlgorithm(String trustManagerAlgorithm)

Description copied from interface: HasTruststore

Trust manager algorithm. Can be left empty to use the servers default algorithm

Specified by:

setTrustManagerAlgorithm in interface HasTruststore

getTrustManagerAlgorithm

public String getTrustManagerAlgorithm()

Specified by:

getTrustManagerAlgorithm in interface HasTruststore

setVerifyHostname

@ReferTo(HttpSessionBase.class)
public void setVerifyHostname(boolean verifyHostname)

Description copied from interface: HasTruststore

If true, the hostname in the certificate will be checked against the actual hostname of the peer

Specified by:

setVerifyHostname in interface HasTruststore

isVerifyHostname

public boolean isVerifyHostname()

Specified by:

isVerifyHostname in interface HasTruststore

setAllowSelfSignedCertificates

@ReferTo(HttpSessionBase.class)
public void setAllowSelfSignedCertificates(boolean testModeNoCertificatorCheck)

Description copied from interface: HasTruststore

If true, self signed certificates are accepted

Specified by:

setAllowSelfSignedCertificates in interface HasTruststore

isAllowSelfSignedCertificates

public boolean isAllowSelfSignedCertificates()

Specified by:

isAllowSelfSignedCertificates in interface HasTruststore

setIgnoreCertificateExpiredException

@ReferTo(HttpSessionBase.class)
public void setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException)

Description copied from interface: HasTruststore

If true, CertificateExpiredExceptions are ignored

Specified by:

setIgnoreCertificateExpiredException in interface HasTruststore

isIgnoreCertificateExpiredException

public boolean isIgnoreCertificateExpiredException()

Specified by:

isIgnoreCertificateExpiredException in interface HasTruststore

setFollowRedirects

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

setStaleChecking

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

setStaleTimeout

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

setProtocol

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