Package org.craftercms.commons.notification.impl

Class WebhookSender

java.lang.Object

org.craftercms.commons.notification.NotificationSender<NotificationSender<?>.NotificationMessage>

org.craftercms.commons.notification.impl.WebhookSender

All Implemented Interfaces:

AutoCloseable

public class WebhookSender
extends NotificationSender<NotificationSender<?>.NotificationMessage>

NotificationSender implementation that sends a webhook notification. The payload is available to the template as an object with the key "payload", and serialized as JSON with the key "payloadJson". A WebhookSender instance can be configured with the following Configuration properties:

• url: The URL to send the webhook notification to.
• method: The HTTP method to use. Default is post.
• contentType: The content type of the request body. Default is application/json

See also NotificationSender for the common properties available to all notification senders.

Nested Class Summary

Nested classes/interfaces inherited from class org.craftercms.commons.notification.NotificationSender

NotificationSender.NotificationMessage

Field Summary

Fields inherited from class org.craftercms.commons.notification.NotificationSender

DATETIME_FORMATTER_MODEL_KEY, DATETIME_PATTERN_CONFIG_KEY, dateTimeFormatter, DURATION_FORMATTER_MODEL_KEY, DURATION_PATTERN_CONFIG_KEY, durationFormatter, freeMarkerConfig, objectMapper, PAYLOAD_MODEL_KEY, templateEncoding, templatePrefix, templateSuffix

Constructor Summary

Constructors

Constructor	Description
WebhookSender(freemarker.template.Configuration freeMarkerConfig, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String dateTimePattern, String durationPattern)

Method Summary

Modifier and Type	Method	Description
void	close()
protected NotificationSender<NotificationSender<?>.NotificationMessage>.NotificationMessage	doCreateMessage(String templateName, Object payload)	Creates the notification message to send.
protected void	doNotify(NotificationSender<?>.NotificationMessage message)	Sends the notification message.
void	init(org.apache.commons.configuration2.Configuration config)
void	setContentType(String contentType)
void	setMethod(String method)
void	setTimeout(int timeout)
void	setUrl(String url)
protected void	validateMethod()
protected void	validateUrl()

Methods inherited from class org.craftercms.commons.notification.NotificationSender

createMessage, initProperties, processTemplate, sendMessage, setTemplateEncoding, setTemplatePrefix, setTemplateSuffix

Methods inherited from class java.lang.Object

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

Constructor Details

WebhookSender

@ConstructorProperties({"freeMarkerConfig","objectMapper","dateTimePattern","durationPattern"})
public WebhookSender(freemarker.template.Configuration freeMarkerConfig,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 String dateTimePattern,
 String durationPattern)

Method Details

init

public void init(org.apache.commons.configuration2.Configuration config)
          throws ConfigurationException

Overrides:

init in class NotificationSender<NotificationSender<?>.NotificationMessage>

Throws:

ConfigurationException

validateUrl

protected void validateUrl()
                    throws ConfigurationException

Throws:

ConfigurationException

validateMethod

protected void validateMethod()
                       throws ConfigurationException

Throws:

ConfigurationException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Overrides:

close in class NotificationSender<NotificationSender<?>.NotificationMessage>

Throws:

IOException

doCreateMessage

protected NotificationSender<NotificationSender<?>.NotificationMessage>.NotificationMessage doCreateMessage(String templateName,
 Object payload)

Description copied from class: NotificationSender

Creates the notification message to send.

Specified by:

doCreateMessage in class NotificationSender<NotificationSender<?>.NotificationMessage>

Parameters:

templateName - the name of the template to use for the notification

payload - the payload to include in the notification

Returns:

the notification message

doNotify

protected void doNotify(NotificationSender<?>.NotificationMessage message)
                 throws NotificationException

Description copied from class: NotificationSender

Sends the notification message.

Specified by:

doNotify in class NotificationSender<NotificationSender<?>.NotificationMessage>

Parameters:

message - the notification message

Throws:

NotificationException - if an error occurs while sending the notification

setContentType

public void setContentType(String contentType)

setMethod

public void setMethod(String method)
               throws ConfigurationException

Throws:

ConfigurationException

setUrl

public void setUrl(String url)
            throws ConfigurationException

Throws:

ConfigurationException

setTimeout

public void setTimeout(int timeout)