com.blazebit.notify.email.model

Class AbstractEmailNotification<ID>

java.lang.Object

com.blazebit.job.jpa.model.BaseEntity<ID>

com.blazebit.job.jpa.model.AbstractJobInstance<ID>

com.blazebit.notify.jpa.model.base.AbstractNotification<ID>

com.blazebit.notify.email.model.AbstractEmailNotification<ID>

Type Parameters:

ID - The id type of the notification

All Implemented Interfaces:

com.blazebit.job.JobConfiguration, com.blazebit.job.JobInstance<ID>, com.blazebit.job.jpa.model.JpaJobInstance<ID>, com.blazebit.notify.ConfigurationSourceProvider, com.blazebit.notify.Notification<ID>, Serializable

Direct Known Subclasses:

EmailNotification

@MappedSuperclass
public abstract class AbstractEmailNotification<ID>
extends AbstractNotification<ID>
implements com.blazebit.notify.ConfigurationSourceProvider

An abstract mapped superclass implementing the Notification interface for E-Mail notifications.

Since:

1.0.0

Author:

Christian Beikov

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTACHMENTS_PARAMETER_NAME The parameter name for the attachments represented by a TemplateProcessor producing a collection of Attachment.
static String	BODY_HTML_PARAMETER_NAME The parameter name for the html body which can be a plain String or a TemplateProcessor.
static String	BODY_TEXT_PARAMETER_NAME The parameter name for the text body which can be a plain String or a TemplateProcessor.
static String	SUBJECT_PARAMETER_NAME The parameter name for the subject which can be a plain String or a TemplateProcessor.
static String	TEMPLATE_PROCESSOR_TYPE_PARAMETER_NAME The parameter name for the template processor type TemplateProcessorKey.getTemplateProcessorResultType().

Constructor Summary

Constructors

Constructor and Description
AbstractEmailNotification() Creates an empty notification.
AbstractEmailNotification(ID id) Creates a notification with the given id.

Method Summary

Modifier and Type	Method and Description
com.blazebit.notify.template.api.TemplateProcessor<Collection<Attachment>>	getAttachmentProcessor() Returns the attachment template processor.
String	getBodyHtml() Returns the html body string.
com.blazebit.notify.template.api.TemplateProcessor<String>	getBodyHtmlTemplateProcessor() Returns the html body template processor.
String	getBodyText() Returns the text body string.
com.blazebit.notify.template.api.TemplateProcessor<String>	getBodyTextTemplateProcessor() Returns the text body template processor.
com.blazebit.job.ConfigurationSource	getConfigurationSource(com.blazebit.notify.NotificationJobContext context)
Instant	getDeliveredTime() Returns the instant at which the E-Mail was delivered.
String	getDeliveryNotification() Returns the delivery notification.
EmailNotificationDeliveryState	getDeliveryState() Returns the delivery state.
FromEmail	getFrom() Returns the FromEmail.
Long	getFromId() Returns the FromEmail id.
String	getMessageId() Returns the message id.
com.blazebit.notify.NotificationRecipient	getRecipient()
EmailNotificationReviewState	getReviewState() Returns the review state.
String	getSubject() Returns the subject string.
com.blazebit.notify.template.api.TemplateProcessor<String>	getSubjectTemplateProcessor() Returns the subject template processor.
String	getTemplateProcessorType() Returns the template processor type to use for subject, text body and html body.
String	getTo() Returns the to E-Mail address.
void	markDone(Object result)
void	setAttachmentsTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<Collection<Attachment>> attachmentsTemplateProcessor) Sets the given attachment template processor.
void	setBodyHtml(String bodyHtml) Sets the given html body.
void	setBodyHtmlTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<String> bodyHtmlTemplateProcessor) Sets the given html body template processor.
void	setBodyText(String bodyText) Sets the given text body.
void	setBodyTextTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<String> bodyTextTemplateProcessor) Sets the given text body template processor.
void	setDeliveredTime(Instant deliveredTime) Sets the instant when the E-Mail was delivered.
void	setDeliveryNotification(String deliveryNotification) Sets the delivery notification.
void	setDeliveryState(EmailNotificationDeliveryState deliveryState) Sets the delivery state.
void	setFrom(FromEmail from) Sets the FromEmail.
void	setFromId(Long fromId) Sets the FromEmail id.
void	setMessageId(String messageId) Sets the message id.
void	setReviewState(EmailNotificationReviewState reviewState) Sets the review state.
void	setSubject(String subject) Sets the given subject.
void	setSubjectTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<String> subjectTemplateProcessor) Sets the given subject template processor.
void	setTemplateProcessorType(String templateProcessorType) Sets that subject, text body and html body should be processed by a template processor with the given type.
void	setTo(String to) Sets the to E-Mail address.

Methods inherited from class com.blazebit.notify.jpa.model.base.AbstractNotification

getChannelType, getDeadline, getExecutionTimeFrames, getJobConfiguration, getMaximumDeferCount, getParameters, getParameterSerializable, isDropable, onChunkSuccess, setChannelType, setDeadline, setDropable, setExecutionTimeFrames, setMaximumDeferCount, setParameters, setParameterSerializable

Methods inherited from class com.blazebit.job.jpa.model.AbstractJobInstance

getCreationTime, getDeferCount, getLastExecutionTime, getScheduleTime, getState, incrementDeferCount, markDeadlineReached, markDropped, markFailed, onPersist, setCreationTime, setDeferCount, setLastExecutionTime, setScheduleTime, setState

Methods inherited from class com.blazebit.job.jpa.model.BaseEntity

equals, getEntityClass, getId, getNoProxyClass, hashCode, id, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.blazebit.job.JobInstance

getCreationTime, getDeferCount, getId, getLastExecutionTime, getLastProcessed, getPartitionKey, getScheduleTime, getState, incrementDeferCount, markDeadlineReached, markDeferred, markDropped, markFailed, nextSchedule, setLastExecutionTime, setScheduleTime

Field Detail

TEMPLATE_PROCESSOR_TYPE_PARAMETER_NAME

public static final String TEMPLATE_PROCESSOR_TYPE_PARAMETER_NAME

The parameter name for the template processor type TemplateProcessorKey.getTemplateProcessorResultType().

See Also:

Constant Field Values

SUBJECT_PARAMETER_NAME

public static final String SUBJECT_PARAMETER_NAME

The parameter name for the subject which can be a plain String or a TemplateProcessor.

See Also:

Constant Field Values

BODY_TEXT_PARAMETER_NAME

public static final String BODY_TEXT_PARAMETER_NAME

The parameter name for the text body which can be a plain String or a TemplateProcessor.

See Also:

Constant Field Values

BODY_HTML_PARAMETER_NAME

public static final String BODY_HTML_PARAMETER_NAME

The parameter name for the html body which can be a plain String or a TemplateProcessor.

See Also:

Constant Field Values

ATTACHMENTS_PARAMETER_NAME

public static final String ATTACHMENTS_PARAMETER_NAME

The parameter name for the attachments represented by a TemplateProcessor producing a collection of Attachment.

See Also:

Constant Field Values

Constructor Detail

AbstractEmailNotification

public AbstractEmailNotification()

Creates an empty notification.

AbstractEmailNotification

public AbstractEmailNotification(ID id)

Creates a notification with the given id.

Parameters:

id - The notification id

Method Detail

markDone

public void markDone(Object result)

Specified by:

markDone in interface com.blazebit.job.JobInstance<ID>

Overrides:

markDone in class com.blazebit.job.jpa.model.AbstractJobInstance<ID>

getRecipient

public com.blazebit.notify.NotificationRecipient getRecipient()

Specified by:

getRecipient in interface com.blazebit.notify.Notification<ID>

getConfigurationSource

public com.blazebit.job.ConfigurationSource getConfigurationSource(com.blazebit.notify.NotificationJobContext context)

Specified by:

getConfigurationSource in interface com.blazebit.notify.ConfigurationSourceProvider

getTemplateProcessorType

public String getTemplateProcessorType()

Returns the template processor type to use for subject, text body and html body.

Returns:

the template processor type

setTemplateProcessorType

public void setTemplateProcessorType(String templateProcessorType)

Sets that subject, text body and html body should be processed by a template processor with the given type.

Parameters:

templateProcessorType - The template processor type

getSubjectTemplateProcessor

public com.blazebit.notify.template.api.TemplateProcessor<String> getSubjectTemplateProcessor()

Returns the subject template processor.

Returns:

the subject template processor

setSubjectTemplateProcessor

public void setSubjectTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<String> subjectTemplateProcessor)

Sets the given subject template processor.

Parameters:

subjectTemplateProcessor - The template processor

getBodyTextTemplateProcessor

public com.blazebit.notify.template.api.TemplateProcessor<String> getBodyTextTemplateProcessor()

Returns the text body template processor.

Returns:

the text body template processor

setBodyTextTemplateProcessor

public void setBodyTextTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<String> bodyTextTemplateProcessor)

Sets the given text body template processor.

Parameters:

bodyTextTemplateProcessor - The template processor

getBodyHtmlTemplateProcessor

public com.blazebit.notify.template.api.TemplateProcessor<String> getBodyHtmlTemplateProcessor()

Returns the html body template processor.

Returns:

the html body template processor

setBodyHtmlTemplateProcessor

public void setBodyHtmlTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<String> bodyHtmlTemplateProcessor)

Sets the given html body template processor.

Parameters:

bodyHtmlTemplateProcessor - The template processor

getAttachmentProcessor

public com.blazebit.notify.template.api.TemplateProcessor<Collection<Attachment>> getAttachmentProcessor()

Returns the attachment template processor.

Returns:

the attachment template processor

setAttachmentsTemplateProcessor

public void setAttachmentsTemplateProcessor(com.blazebit.notify.template.api.TemplateProcessor<Collection<Attachment>> attachmentsTemplateProcessor)

Sets the given attachment template processor.

Parameters:

attachmentsTemplateProcessor - The template processor

getSubject

public String getSubject()

Returns the subject string.

Returns:

the subject string

setSubject

public void setSubject(String subject)

Sets the given subject.

Parameters:

subject - The subject

getBodyText

public String getBodyText()

Returns the text body string.

Returns:

the text body string

setBodyText

public void setBodyText(String bodyText)

Sets the given text body.

Parameters:

bodyText - The text body

getBodyHtml

public String getBodyHtml()

Returns the html body string.

Returns:

the html body string

setBodyHtml

public void setBodyHtml(String bodyHtml)

Sets the given html body.

Parameters:

bodyHtml - The html body

getFrom

@NotNull
public FromEmail getFrom()

Returns the FromEmail.

Returns:

the FromEmail

setFrom

public void setFrom(FromEmail from)

Sets the FromEmail.

Parameters:

from - The FromEmail

getFromId

public Long getFromId()

Returns the FromEmail id.

Returns:

the FromEmail id

setFromId

public void setFromId(Long fromId)

Sets the FromEmail id.

Parameters:

fromId - The FromEmail id

getTo

@NotNull
public String getTo()

Returns the to E-Mail address.

Returns:

the to E-Mail address

setTo

public void setTo(String to)

Sets the to E-Mail address.

Parameters:

to - The to E-Mail address

getMessageId

public String getMessageId()

Returns the message id.

Returns:

the message id

setMessageId

public void setMessageId(String messageId)

Sets the message id.

Parameters:

messageId - The message id

getDeliveredTime

public Instant getDeliveredTime()

Returns the instant at which the E-Mail was delivered.

Returns:

the instant

setDeliveredTime

public void setDeliveredTime(Instant deliveredTime)

Sets the instant when the E-Mail was delivered.

Parameters:

deliveredTime - The instant

getDeliveryNotification

public String getDeliveryNotification()

Returns the delivery notification.

Returns:

the delivery notification

setDeliveryNotification

public void setDeliveryNotification(String deliveryNotification)

Sets the delivery notification.

Parameters:

deliveryNotification - The delivery notification

getDeliveryState

public EmailNotificationDeliveryState getDeliveryState()

Returns the delivery state.

Returns:

the delivery state

setDeliveryState

public void setDeliveryState(EmailNotificationDeliveryState deliveryState)

Sets the delivery state.

Parameters:

deliveryState - The delivery state

getReviewState

@NotNull
public EmailNotificationReviewState getReviewState()

Returns the review state.

Returns:

the review state

setReviewState

public void setReviewState(EmailNotificationReviewState reviewState)

Sets the review state.

Parameters:

reviewState - The review state